995 Commits

Author SHA1 Message Date
jixxed
72ebafa5f5 Update readme ellisions for journal based commodity messages 2023-01-09 23:02:35 +01:00
Athanasius
2a461a9e46 eddn-report: Bump all version checks to latest & EDDI report exception
* Raised all softwareVersion checks to latest releases.
* EDDI has an approachsettlement/1 issue that's been reported.
2023-01-06 09:00:09 +00:00
Athanasius
d263b7f929
Merge pull request #204 from EDCD/fix/schemas/fcmaterials_json-items-array-contents
schemas/fcmaterials_json: Spec of in-array items needs to be correct
2022-12-10 11:09:03 +00:00
Athanasius
90bf38a451
schemas/fcmaterials_json: Spec of in-array items needs to be correct
python `jsonschema` raises no errors when you erroneously forget to wrap
the specification of each "array" member in `"items": { ... }`.

Closes #203
2022-12-10 11:03:16 +00:00
Athanasius
feed1c27ec
docs/Developers: Fix 'For emphasis' emphasis (markdown) 2022-12-01 13:15:16 +00:00
Athanasius
ecf54c62eb
docs/Developers: Don't split "gamebuild may be empty". 2022-12-01 13:14:03 +00:00
Athanasius
e39fd25e7b
docs/Developers: gamebuild should not be whitespace-trimmed. 2022-12-01 11:36:36 +00:00
Athanasius
cebf3e5ea6
docs/Developers: CAPI-sourced data must denote which galaxy it is for 2022-12-01 11:26:01 +00:00
Athanasius
b00b3737d2
docs/Developers: Don't make it look like advice is about gamebuild
* The ordered-list advice is for `gameversion`, not `gamebuild`.  So move
  the latter mention below that list.
* Also mention `fcmaterials_capi` comes from `market` endpoint.
2022-11-25 15:39:11 +00:00
Athanasius
fecaf76e92
schemas/README: Point out the status of gameversion/build in main README 2022-11-23 17:50:15 +00:00
Athanasius
f8245d8bc2
Merge pull request #184 from CommanderRoot/refactor/rm-deprecated-substr
refactor: replace deprecated String.prototype.substr()
2022-11-14 12:15:46 +00:00
Athanasius
c54f452bf7
docs/Developers: Compression needs Content-Encoding header
... not `Content-Type`.
2022-10-31 08:52:14 +00:00
Athanasius
c28609171d
Merge pull request #199 from EDCD/enhancement/197/header-gameversion
schemas: journal: Implement header->gameversion & -> gamebuild
2022-10-10 10:53:10 +01:00
Athanasius
04011f0533
eddn-report: Correct accidental removal of '# ' on actual comment 2022-10-05 10:57:59 +01:00
Athanasius
e445da49b7
eddn-report: Ignore EDD outfitting/2 paintjobs 2022-10-05 10:56:15 +01:00
Athanasius
3db0bbf430
eddn-report: Bump EDD and EDMC latest version strings 2022-10-05 09:13:02 +01:00
Athanasius
1999f52e97
schemas: Update for allowing "" gameversion/build
* Also has specific description text for the CAPI data source schemas.
2022-09-29 15:18:52 +01:00
Athanasius
1df1032886
docs/Developers: Allow for "" gameversion/build values.
The emphasis here is on strongly encouraging Senders to get the actual, full
and correct, values to Listeners.  But where they can't, be that due to
data source limitations (CAPI), or their code architecture (common EDDN
sending code that has no concept of the data source), they're allowed to
send a less than optimal value.

**BUT**, they still should start sending the fields as outlined.
2022-09-29 14:58:35 +01:00
Athanasius
6046c0a6d7
schemas: Refer to Developers.md about gameversion/build. 2022-09-27 16:20:59 +01:00
Athanasius
aa99d3e057
docs/Developers: Use CAPI-<endpoint> for gameversion/build
It's the true source of the data, and less fraught with corner cases than
trying to be sure that the Journal-derived values would be correct.
2022-09-27 16:05:49 +01:00
Athanasius
d57ab05ee3
docs/Developers: Define header component field:values
* Actually define what we expect from the existing fields.
* Document what should go in the new `gameversion` and `gamebuild` fields.
* Update the generic example to include all of these "what version of the game,
  or feature set, did this come from?" fields.
2022-09-27 15:50:17 +01:00
Athanasius
a723fbd83b
docs/Developers: Fix 'i3' vim-induced typo 2022-09-27 14:50:05 +01:00
Athanasius
e000bcc398
schemas/shipyard: gameversion & gamebuild in header 2022-09-27 14:48:51 +01:00
Athanasius
c8db0792d4
schemas/scanbarycentre: gameversion & gamebuild in header 2022-09-27 14:48:12 +01:00
Athanasius
33911c3209
schemas/outfitting: gameversion & gamebuild in header 2022-09-27 14:47:26 +01:00
Athanasius
e3a744a94b
schemas/navroute: gameversion & gamebuild in header 2022-09-27 14:46:31 +01:00
Athanasius
fdb59c2fa8
schemas/navbeaconscan: gameversion & gamebuild in header 2022-09-27 14:45:41 +01:00
Athanasius
fa9e171381
schemas/fsssignaldiscovered: gameversion & gamebuild in header 2022-09-27 14:44:44 +01:00
Athanasius
6c9986ec58
schemas/fssdiscoveryscan: gameversion & gamebuild in header 2022-09-27 14:44:00 +01:00
Athanasius
1461eaf720
schemas/fssbodysignals: gameversion & gamebuild in header 2022-09-27 14:43:20 +01:00
Athanasius
d5e3cdf8e9
schemas/fssallbodiesfound: gameversion & gamebuild in header 2022-09-27 14:42:24 +01:00
Athanasius
15012a2b6e
schemas/fcmaterials_journal: gameversion & gamebuild in header 2022-09-27 14:41:45 +01:00
Athanasius
0bc7c90dfb
schemas/commodity: gameversion & gamebuild in header 2022-09-27 14:39:52 +01:00
Athanasius
9a9e0f0991
schemas/codexentry: gameversion & gamebuild in header 2022-09-27 14:38:53 +01:00
Athanasius
17648a9abd
schemas/approachsettlement: Add gameversion/gamebuild 2022-09-27 14:37:16 +01:00
Athanasius
dfdec11828
schemas/journal: horizons/odyssey now mandatory 2022-09-27 14:23:50 +01:00
Athanasius
cbbddad13c
schemas/journal: Add gamebuild to header as well 2022-09-27 14:09:24 +01:00
Athanasius
78e92fb38d
schemas: journal: Implement header->gameversion 2022-09-27 14:02:56 +01:00
Athanasius
ba6762c5eb
Merge pull request #198 from EDCD/enhancement/docs/gameversion-odyssey-horizons-1450
docs/Developers: Update Fileheader/LoadGame for latest clients
2022-09-27 13:56:02 +01:00
Athanasius
69cc27fd63
docs/Developers: horizons/odyssey flags now compulsory
* Listeners really do need these, where defined in the schemas, so state
  that they're mandatory.
* REALLY emphasise that where an `Odyssey` flag isn't in `LoadGame` Senders
  MUST NOT send it with a `false` value.

  Although pending addition of header->gameversion will aid Listeners,
  currently this could give the misleading impression that a 3.8 Horizons
  client is a 4.0 Horizons client.
2022-09-27 12:42:14 +01:00
Athanasius
a04d0e8d96
docs/Developers: Update Fileheader/LoadGame for latest clients
This includes the new `4.0 Horizons` client, which changes the semantics
of what the `Odyssey` flag in the `Fileheader` means.  It now indicates if
the client is a 4.0+ one, not if the player is utilising Odyssey DLC.
2022-09-27 12:40:28 +01:00
Athanasius
e1de9b2aab
Merge pull request #195 from EDCD/enhancement/193/schema-fcmaterials
schemas: fcmaterials for both Journal and CAPI-sourced data
2022-09-07 13:34:00 +01:00
Athanasius
7f7b462790
Setttings: Update for fcmaterials_journal and fcmaterials_capi now 2022-09-02 16:30:18 +01:00
Athanasius
2a8d09e378
schemas: fcmaterials_capi: README: First cut 2022-09-02 16:27:48 +01:00
Athanasius
af2b29a4a4
schemas: fcmaterials_capi: Initial schema and README
* NB: The README is a straight copy of the _journal one right now.  Will fix
  later.
2022-09-02 15:41:07 +01:00
Athanasius
7111bdbbbb
scripts/test-schema: A *very* basic script to see if a schema works
* It's using `sys.argv`, not `argparse`.
* Thus there's no `--help`.
* Supply it with: 1) Filename of a schema definition, 2) filename of a full
  EDDN message text to test for compliance.
* No output if both schema and message load *and* the message passes the
  schema.  Else you'll get python exception output from `jsonschema.validate()`.
2022-09-02 15:39:20 +01:00
Athanasius
33d6e8fe2e
schemas: fcmaterials_journal: Fix $id from rename 2022-09-02 13:48:37 +01:00
Athanasius
b3876824f7
schemas/README: Document $id conventions
1. Get the designation of the version correct.
2. That empty `#` fragment is a SHOULD NOT, so just don't.
3. Append `_<source>` to the "filename" where necessary.
2022-09-02 13:46:18 +01:00
Athanasius
08127d261f
schemas/README: Per-schema README is now mandatory
I think I only made this 'SHOULD' before because at that stage I'd not yet
written the README files for the legacy schemas.
2022-09-02 13:38:53 +01:00
Athanasius
2eb213d766
schemas/TEMPLATES/journal: Remove the # 'fragment' from end of $id
As per <https://json-schema.org/draft/2020-12/json-schema-core.html#section-8.2.1>

> Therefore, "$id" MUST NOT contain a non-empty fragment, and SHOULD NOT contain an empty fragment.
2022-09-02 13:36:43 +01:00