mirror of
https://github.com/EDCD/EDDN.git
synced 2025-04-12 07:00:04 +03:00
schemas/blackmarket: Bring in line with newer documentation
This commit is contained in:
parent
500ce86d51
commit
43152bbce8
@ -20,17 +20,9 @@ documentation for a schema such as this.
|
||||
The primary data source for this schema is the ED Journal event `MarketSell`.
|
||||
|
||||
### Key Renames
|
||||
#### name
|
||||
Due to how the EDDN schema is defined the `Type` key/value should
|
||||
have the key renamed to `name`.
|
||||
|
||||
#### prohibited
|
||||
Due to how the EDDN schema is defined the `IllegalGoods` key/value should
|
||||
have the key renamed to `prohibited`.
|
||||
|
||||
#### marketID
|
||||
The Journal documentation says this is `MarketID`, but in the schema the
|
||||
`m` is lower case.
|
||||
Some key names in this Schema are different from how they appear in the source
|
||||
Journal data. Look for keys where the object contains a `renamed` key - the
|
||||
value is what the name would have been in the source Journal data.
|
||||
|
||||
### Elisions
|
||||
You MUST remove the following key/value pairs from the data:
|
||||
@ -41,15 +33,13 @@ You MUST remove the following key/value pairs from the data:
|
||||
- `BlackMarket` - Because we're using this schema, so this is un-necessary.
|
||||
|
||||
### Augmentations
|
||||
#### horizons flag
|
||||
You SHOULD add this key/value pair, using the value from the `LoadGame` event.
|
||||
|
||||
#### odyssey flag
|
||||
You SHOULD add this key/value pair, using the value from the `LoadGame` event.
|
||||
#### horizons and odyssey flags
|
||||
Please read [horizons and odyssey flags](../README-EDDN-schemas.md#horizons-and-odyssey-flags)
|
||||
over in the main Schema documentation.
|
||||
|
||||
#### systemName
|
||||
The star system name for where this market is. Use the `StarSystem` value
|
||||
from the prior `Docked` or `Location` event.
|
||||
|
||||
#### stationName
|
||||
From the `StationName` value on the prior `Docked` or `Location` event.
|
||||
From the `StationName` value on the prior `Docked` or `Location` event.
|
||||
|
@ -44,7 +44,8 @@
|
||||
"minLength" : 1
|
||||
},
|
||||
"marketId": {
|
||||
"type" : "integer"
|
||||
"type" : "integer",
|
||||
"renamed" : "MarketID"
|
||||
},
|
||||
"timestamp": {
|
||||
"type" : "string",
|
||||
@ -52,6 +53,7 @@
|
||||
},
|
||||
"name": {
|
||||
"type" : "string",
|
||||
"renamed" : "Type",
|
||||
"minLength" : 1,
|
||||
"description" : "Commodity name as returned by the MarketSell entry in the Journal"
|
||||
},
|
||||
@ -61,6 +63,7 @@
|
||||
},
|
||||
"prohibited": {
|
||||
"type" : "boolean",
|
||||
"renamed" : "IllegalGoods",
|
||||
"description" : "Whether the commodity is prohibited at this station"
|
||||
}
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user