Athanasius
fecaf76e92
schemas/README: Point out the status of gameversion/build in main README
2022-11-23 17:50:15 +00: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
723e966b37
docs/README schemas: Be explicit about sub-second timestamp resolution
2022-06-24 14:48:11 +01:00
Athanasius
8de80a868a
docs: More DRY and getting things in the correct places
2022-01-30 15:29:41 +00:00
Athanasius
3b8845d31a
docs: Resolving where "general message contents" lives and its format
...
* Most of it is once more in schemas/README.
* But keeping the horizons/odyssey flags in docs/Developers.md, as that's
more about how you handle them in code.
2022-01-30 14:14:59 +00:00
Athanasius
c9d0e30e42
schemas/README: Flesh out this in its new 'stub' form
...
The remaining extant text has also now been moved into `docs/Developers.md`.
2022-01-30 12:55:33 +00:00
Athanasius
3e69b7b630
docs: Move most of schemas/README into docs/Developers.md
2022-01-30 12:46:20 +00:00
Athanasius
396a2f0b3a
docs/schemas: Improve "what must be present or removed"
2022-01-30 12:38:32 +00:00
Athanasius
7337f83061
schemas/README: Tweak order and text of 'minimum message'
2022-01-29 17:26:25 +00:00
Athanasius
da109f85e7
schemas/README: State that schema files trump their README
2022-01-29 17:24:21 +00:00
Athanasius
d802448e4c
README: Linkify 'a defined format' & simplify plaintext/compression header
2022-01-29 17:18:43 +00:00
Athanasius
099eb72e73
schemas/README: Update horizons/odyssey flag section
...
* Re-confirmed what is in the `LoadGame` event for all 3 possible circumstances.
* Emphasised that the `Fileheader`->`Odyssey` value is different in nature.
2022-01-29 16:29:17 +00:00
Athanasius
6eb81e4461
schemas/README: Make some lists actual numbered lists
...
This is to aid with e.g. "point 2 in "Contents of message" when referring to
this documentation.
2022-01-28 18:16:17 +00:00
Athanasius
8648718f38
schemas/Docs: Mostly capitalising 'Schema'
...
* Treat 'Schema', when referring to an EDDN schema, as a proper noun.
* Additional minor grammar improvements for clarity.
2022-01-28 18:00:49 +00:00
Athanasius
60ed98c19c
schemas/README: Fix 'ouy' typo
2022-01-28 17:55:35 +00:00
Athanasius
62969a2cbb
schemas/README: Journal-sourced messages MUST have event in new schemas
...
This would be a 100% MUST, but we have live schemas not mandating it.
2022-01-28 17:54:47 +00:00
Athanasius
42d21111c3
schemas/README: Linkify to endpoint listing on mention of beta/dev services
2022-01-28 17:52:42 +00:00
Athanasius
4aadbeb146
schemas/README: If using compression, set Content-Type correctly
2022-01-28 17:36:29 +00:00
Athanasius
5c5ce32d09
schemas/README: Preserve Journal event key:value, even if redundant
2022-01-27 12:31:48 +00:00
Athanasius
a8f657c2d6
schemas/README: bottle body size limit *is* affected by compression
...
I explicitly tested this with a 50KiB limit on beta EDDN service:
1. 49973 byte message does make it through, in plain text.
2. 51312 byte message, no compression, 413.
3. Same message, with gzip compression, 200
4. The 149242 byte file I based those extra ones on also makes it
through when compressed.
Indeed the Gateway logging cites the compressed-body size. `bottle`
isn't looking at the message and magically decompressing it in order to
check plain-text size.
2022-01-21 09:43:55 +00:00
Athanasius
853c309df0
schemas/README: Give examples of LoadGame for Horizons/Odyssey flags
2022-01-20 11:40:41 +00:00
Athanasius
7819eff826
schemas/README: Give some hints about odyssey/horizons flags
2022-01-20 11:32:08 +00:00
Athanasius
deb7383e32
docs/schemas: Additions and tweaks for uploaders
...
* Document the "you tried to use plain HTTP" response from Reverse
Proxy in the appropriate section.
* Switch URL for Gateway.py to `live` branch.
* 'disallowed' Schema Validation error cites **value**, not key *name*.
* Call out the possible need to explicitly subscribe to the empty topic
in order to receive messages... and that currently server-side topic
filtering isn't possible.
2022-01-11 12:48:40 +00:00
Athanasius
75c117fb12
docs/schemas: form-encoded messages are deprecated and not documented
...
At some point I might add logging to see if any sender even *is*
utilising this, and if not actually remove the possibility entirely.
2022-01-09 16:14:00 +00:00
Athanasius
11d3501c59
Gateway/errors: More documentation tweaking
2022-01-09 16:13:01 +00:00
Athanasius
4ad1519d1d
Gateway/errors: Improve general outline of documentation section
2022-01-09 16:10:01 +00:00
Athanasius
ccde820ba7
Gateway/errors: 'Schema Validation' properly tagged and documented
2022-01-09 16:02:28 +00:00
Athanasius
e111fb8415
Gateway/errors: Outdate Schema: Tweak message and document
2022-01-09 15:48:27 +00:00
Athanasius
b9b59329d5
Gateway/errors: Document 'Malformed Upload' error
2022-01-09 15:43:51 +00:00
Athanasius
4da60215f0
Gateway/errors: Tag FAIL if a zlib.error
2022-01-09 15:43:12 +00:00
Athanasius
8edae919e2
Gateway/errors: Call out if FAIL is specifically on JSON parsing
2022-01-09 15:38:29 +00:00
Athanasius
c6a63c5a93
docs/schemas: Journal timestamps *are* trustworthy as UTC
2022-01-09 15:25:55 +00:00
Athanasius
44b5a1d789
docs/schemas: slight wording tweak about live schemas
2022-01-09 14:57:05 +00:00
Athanasius
36de2145d7
docs: schemas: General improvement pass to aid new developers
...
* Make lots of 'obvious' things explicit, e.g. HTTP 1.1, not HTTP/2, and
HTTPS not plain HTTP.
* The live service should always be using the schemas as present in the
live branch, not master or another branch.
* A 'good' message will receive 'HTTP 200' status *and* a body of `OK`.
2022-01-09 14:52:41 +00:00
Athanasius
207068f156
docs: Cite issue on "some error bodies don't have FAIL: prefix"
2022-01-07 15:37:07 +00:00
Athanasius
d2c4c98c2b
docs: Possible server responses, and handling them
2022-01-07 15:20:05 +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
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
635d7c2693
schemas: README: Note about key names being originally CAPI based
2021-11-01 14:31:59 +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
