148 Commits

Author SHA1 Message Date
Athanasius
fa118d0183
schemas/codexentry: Clarify that what unset status_body_name means 2021-12-21 09:37:08 +00:00
Athanasius
b78fcf349f
Merge branch 'develop' 2021-11-04 11:26:35 +00:00
Athanasius
d6a43c04d9
schemas: README: Add 'Receiving messages' section 2021-11-04 11:14:47 +00:00
Athanasius
1b11519ee7
schemas: READMEs: Centralise "detecting CAPI lag" advice 2021-11-04 11:03:51 +00:00
Athanasius
e0c1ac85fd
schemas: fssdiscoveryscan: README: Don't over-state elisions 2021-11-02 11:32:54 +00:00
Athanasius
6704e1a957
schemas: commodity: README: Allow LoadGame horizons flag for CAPI data 2021-11-02 11:30:25 +00:00
Athanasius
5b05e4879f
schemas: commodity: README: Call out statusFlags 2021-11-02 11:24:37 +00:00
Athanasius
6e81afc98c
schemas: blackmarket: README: Count doesn't need to be elided 2021-11-02 11:20:43 +00:00
Athanasius
53acd5ed1e
schemas: blackmarket: README: Correct referenced Journal event 2021-11-02 11:20:09 +00:00
Athanasius
aebf3ac479
schemas: README: Remove final things now mentioned in specific READMEs 2021-11-01 16:02:12 +00:00
Athanasius
57e8b9af4b
schemas: README: shipyard unavailable_list already noted in its README 2021-11-01 15:59:38 +00:00
Athanasius
a32f047b7f
schemas: README: outfitting-specific elisions in that file already 2021-11-01 15:58:35 +00:00
Athanasius
b9231cef12
schemas: READMEs: Move commodity-specific elisions into its file 2021-11-01 15:58:00 +00:00
Athanasius
339abce9e4
schemas: READMES: Consistent horizons/odyssey language 2021-11-01 15:52:56 +00:00
Athanasius
3d023bf280
schemas: shipyard: README: Initial version 2021-11-01 15:46:08 +00:00
Athanasius
e12ebee9f8
schemas: scanbarycentre: README: Initial version 2021-11-01 15:15:03 +00:00
Athanasius
a32d6e2ea3
schemas: outfitting: README: Initial version 2021-11-01 15:11:15 +00:00
Athanasius
6c1d8cff92
schemas: navroute: README: Initial version 2021-11-01 14:58:54 +00:00
Athanasius
67e77136ff
schemas: navbeaconscan: README: Initial version 2021-11-01 14:54:10 +00:00
Athanasius
fd567e69aa
schemas: journal: README: Now complete, in the generic sense
Ideally all the events covered here need splitting into their own
schemas, but for the time being this documentation should suffice.
2021-11-01 14:44:28 +00:00
Athanasius
635d7c2693
schemas: README: Note about key names being originally CAPI based 2021-11-01 14:31:59 +00:00
Athanasius
fc7443b282
schemas: fssdiscoveryscan: README: Initial version 2021-10-29 15:09:30 +01:00
Athanasius
d781160e6e
schemas: commodity: README: _Localised keys correction 2021-10-29 15:05:28 +01:00
Athanasius
8178e61b00
schemas: commodity: README: Correct top-level header 2021-10-29 15:01:02 +01:00
Athanasius
8e03a82536
schemas: commodity: README: Document use of CAPI data 2021-10-29 14:27:40 +01:00
Athanasius
68160fcb8d
schemas: commodity: Initial README 2021-10-29 14:10:49 +01:00
Athanasius
ed30aa4f01
schemas: blackmarket: No, that's no an additional timestamp 2021-10-29 13:54:39 +01:00
Athanasius
b35b934d8c
schemas: blackmarket: README
Note that it turns out this is deprecated in favour of the `prohibited`
array defined in the `commodity` schema, and has been that way since
September 2017.
2021-10-29 13:42:43 +01:00
Athanasius
652c50ab06 Merge branch 'develop' 2021-10-27 11:43:44 +00:00
Athanasius
916fe73f35 schemas: codexentry: NearestDestination *can* be an empty string.
We had one user with EDMC trying to send:

```python
OrderedDict([('$schemaRef',
'https://eddn.edcd.io/schemas/codexentry/1'), ('message',
OrderedDict([('timestamp', '2021-10-26T11:37:57Z'), ('event',
'CodexEntry'), ('EntryID', 2420702), ('Name',
'$Codex_Ent_Stratum_07_K_Name;'), ('SubCategory',
'$Codex_SubCategory_Organic_Structures;'), ('Category',
'$Codex_Category_Biology;'), ('Region', '$Codex_RegionName_18;'),
('System', 'Xi Ophiuchi'), ('SystemAddress', 2072061675891),
('NearestDestination', ''), ('Latitude', 79.352364), ('Longitude',
121.434044), ('horizons', True), ('odyssey', True), ('StarPos', [-3.875,
8.15625, 55.875]), ('BodyName', 'Xi Ophiuchi B 5'), ('BodyID', 14)]))])
```
as the message.  The EDDN Gateway then complains:

`FAIL: [<ValidationError: "'' is too short">]`
2021-10-27 11:08:16 +00:00
Athanasius
43e181a830 schemas: navroute: Add horizons and odyssey flags 2021-10-18 10:33:36 +00:00
Athanasius
87b33e4d1b Merge branch 'develop' 2021-10-18 10:27:26 +00:00
Athanasius
895dc0d452 schemas: navroute: Correct array key to 'Route'
Even though everything else is 'NavRoute', this isn't.
2021-10-14 14:09:53 +00:00
Athanasius
6e341f1d31 schemas: scanbarycentre: Remove extraneous 'BodyID' string 2021-10-14 14:00:52 +00:00
Athanasius
17e4fedeee schemas: codexentry: Remove another extraneous comma 2021-10-14 13:54:05 +00:00
Athanasius
bc1618063c schemas: codexentry: README: Also be specific for receivers
They should expect to have to cope with any of the three scenarios,
being free to just drop the data if they only get `BodyName`.
2021-10-13 14:21:03 +00:00
Athanasius
c59a9191b3 schemas: codexentry: README: Allow 'BodyName' without 'BodyID'
In the interests of offering listeners at least partial data about the
location of a codex entry we will allow `BodyName` to be set from
Status.json, but without `BodyID` from the Journal if it is not
available.
2021-10-13 14:15:32 +00:00
Athanasius
22897c8724 schemas: codexentry: Remove trailing comma 2021-10-12 15:06:07 +00:00
Athanasius
d39c1fdbd2 schemas: codexentry: README: Expand on how to get BodyName and ID
Currently if Status.json BodyName doesn't match that from the journal we
specify sending neither it nor the BodyID.  We could still send the
BodyName **from Status.json** as that's better than no data about the
location.
2021-10-12 14:51:50 +00:00
Athanasius
ae3758a631 schemas: codexentry: README BodyID/Name
* Untested as yet.  I'm working on implementing, and testing, this in
  an EDMC branch to verify it.
2021-10-10 15:40:37 +00:00
Athanasius
bfa5362def schemas: README: More general refinement. 2021-10-10 13:14:04 +00:00
Athanasius
dc4ae569ed schemas: Continue expanding on general README
This is pulling in a lot of what's currently in the wiki page, but
re-arranging and re-wording it.
2021-10-04 16:25:18 +00:00
Athanasius
afa22f4784 schemas: Start expanding on general and per-schema documentation
* Add README-EDDN-schemas.md to hold general documentation for reference
  by other files such as...
* Update codexentry-README.md to reference the general documentation.
2021-10-04 14:37:26 +00:00
Athanasius
46a71994a6 schemas/codexentry: Add BodyID/Name, and -README file
* Add BodyID and BodyName as optional keys.
* Add `description` at top-level pointing to README documentation.
* Add schema-specific README to document what should be (in|ex)cluded
  from data, and how to obtain such from Journals etc.
2021-10-02 11:49:47 +00:00
Athanasius
d8d16afbc4 schemas: Fix event name in navroute schema to be 'NavRoute'
This was/is documented as 'Route', but it has always actually been
'NavRoute' in the produced log files, separate filename, and contents of
that separate file.
2021-09-26 15:29:02 +00:00
Athanasius
9703b1e475 schemas: Correct 'id' in navbeaconscan-v1.0.json
It still had 'fssdiscoveryscan' in there, presumably from a copying.
2021-09-26 13:58:49 +00:00
Athanasius
29e5bba91b schemas: scanbarycentre: Remove extraneouis ': "BodyID"' 2021-09-23 19:45:50 +00:00
Athanasius
7a50cbc45f schemas: codexentry: Remove extraneous comma 2021-09-23 19:45:29 +00:00
Athanasius
f35b832cb3
Merge pull request #140 from spansh/fss-discovery-scan
FSS discovery scan schema
2021-09-23 19:30:04 +01:00
Athanasius
99ba54a315
Merge pull request #141 from spansh/nav-beacon-scan
added nav beacon scan
2021-09-23 19:29:53 +01:00