third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-06-15 14:52:06 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

schemas/templates: Minor formatting/grammer cleanups

Browse Source
This commit is contained in:
Athanasius 2022-01-29 16:53:42 +00:00
parent fa869c6478
commit 5f5d0afb29
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
schemas/TEMPLATES/journalevent-README.md
View File

@ -42,12 +42,16 @@
mandatory that they are allowed (but are optional) in any Journal-based mandatory that they are allowed (but are optional) in any Journal-based
EDDN Schema. EDDN Schema.
7. If the source Journal event contains information that includes the System 7. If:
name (possibly as `StarSystem` or `SystemName`) then you MUST include the 1. either the source Journal event contains information that includes the
`StarPos` section in `Augmentations`. System name (possibly as `StarSystem` or `SystemName`), **OR** the source
data contains a `SystemAddress` value,
2. and a `StarPos` array is *not already present* in the source data.
then you MUST include the `StarPos` section in `Augmentations`.
Additionally, you must also include `StarPos` as required in the Schema If neither key is in the source data then remove the `StarPos` section from
if the source data contains `SystemAddress`. this document.
The line: The line:
@ -67,8 +71,8 @@ Please consult [EDDN Schemas README](./README-EDDN-schemas.md) for general
documentation for a schema such as this. documentation for a schema such as this.
If you find any discrepancies between what this document says and what is If you find any discrepancies between what this document says and what is
defined in the relevant Schema file you should, in the first instance, assume defined in the relevant Schema file, then you should, in the first instance,
that it is the Schema file that is correct. assume that it is the Schema file that is correct.
**PLEASE open **PLEASE open
[an issue on GitHub](https://github.com/EDCD/EDDN/issues/new/choose) [an issue on GitHub](https://github.com/EDCD/EDDN/issues/new/choose)
to report any such anomalies you find so that we can check and resolve the to report any such anomalies you find so that we can check and resolve the

2
schemas/TEMPLATES/journalevent-v1.0.json
View File

@ -84,7 +84,7 @@
"description" : "Boolean value copied from the Journal LoadGame event, when it is present there." "description" : "Boolean value copied from the Journal LoadGame event, when it is present there."
}, },
"odyssey": { "odyssey": {
"type" : "boolean", "type" : "boolean",
"description" : "Boolean value copied from the Journal LoadGame event, when it is present there." "description" : "Boolean value copied from the Journal LoadGame event, when it is present there."
}, },
"some_disallowed_key" { "$ref" : "#/definitions/disallowed" }, "some_disallowed_key" { "$ref" : "#/definitions/disallowed" },