6 Commits

Author SHA1 Message Date
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
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
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