Athanasius
64dd5832d4
schemas: Journal event template: Couple StarPos instructions
2022-01-29 16:56:08 +00:00
Athanasius
5f5d0afb29
schemas/templates: Minor formatting/grammer cleanups
2022-01-29 16:53:42 +00:00
Athanasius
fa869c6478
schemas: Update horizons/odyssey descriptins in schema template
2022-01-29 16:47:58 +00:00
Athanasius
5fe2642d03
schemas: First cut of newjournalevent-README.md template
2022-01-29 16:45:11 +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
eac3e1af4b
schemas: Add a 'new journal event schema' template
...
Hopefully the "not actually valid in JSON" comments make it obvious both what needs
to be edited, and that they all need removing.
2022-01-29 15:47:17 +00:00
Athanasius
989b997d15
schemas: Skeleton journal event template
2022-01-28 18:34:00 +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
de33e4460c
Schemas/FSSAllBodiesFound: Make 'event' required
2022-01-28 17:29:11 +00:00
robbyxp1
b6d25ccebc
Added back in the event key
2022-01-28 17:28:13 +00:00
robbyxp1
b323460bf8
Add FSSAllBodiesFound
2022-01-28 17:28:13 +00:00
Athanasius
578d185072
Merge pull request #175 from EDCD/ApproachSettlement
...
Add Approachsettlement
2022-01-28 17:23:54 +00:00
robbyxp1
3690aab87e
Fix another typo in ApproachSettlement event tag
2022-01-28 15:10:36 +00:00
robbyxp1
5ff342cc8b
Add event to required list
2022-01-28 13:52:20 +00:00
robbyxp1
87a81aaa37
Fix comma typo in ApproachSettlement JSON and fix readme
2022-01-28 13:47:01 +00:00
robbyxp1
e85e3d4b85
Fix tab issue, add description
2022-01-27 13:09:50 +00:00
Athanasius
5c5ce32d09
schemas/README: Preserve Journal event key:value, even if redundant
2022-01-27 12:31:48 +00:00
robbyxp1
42742ae9e6
Add back in event after discussion
2022-01-27 11:30:57 +00:00
robbyxp1
4f3225c3af
Add Approachsettlement
2022-01-27 11:10:59 +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
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
