216 Commits

Author SHA1 Message Date
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
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
339abce9e4
schemas: READMES: Consistent horizons/odyssey language 2021-11-01 15:52:56 +00:00
Athanasius
3d023bf280
schemas: shipyard: README: Initial version 2021-11-01 15:46:08 +00:00
Athanasius
e12ebee9f8
schemas: scanbarycentre: README: Initial version 2021-11-01 15:15:03 +00:00
Athanasius
a32d6e2ea3
schemas: outfitting: README: Initial version 2021-11-01 15:11:15 +00:00
Athanasius
6c1d8cff92
schemas: navroute: README: Initial version 2021-11-01 14:58:54 +00:00
Athanasius
67e77136ff
schemas: navbeaconscan: README: Initial version 2021-11-01 14:54:10 +00:00
Athanasius
fd567e69aa
schemas: journal: README: Now complete, in the generic sense
Ideally all the events covered here need splitting into their own
schemas, but for the time being this documentation should suffice.
2021-11-01 14:44:28 +00:00
Athanasius
635d7c2693
schemas: README: Note about key names being originally CAPI based 2021-11-01 14:31:59 +00:00
Athanasius
fc7443b282
schemas: fssdiscoveryscan: README: Initial version 2021-10-29 15:09:30 +01:00
Athanasius
d781160e6e
schemas: commodity: README: _Localised keys correction 2021-10-29 15:05:28 +01:00
Athanasius
8178e61b00
schemas: commodity: README: Correct top-level header 2021-10-29 15:01:02 +01:00
Athanasius
8e03a82536
schemas: commodity: README: Document use of CAPI data 2021-10-29 14:27:40 +01:00
Athanasius
68160fcb8d
schemas: commodity: Initial README 2021-10-29 14:10:49 +01:00
Athanasius
ed30aa4f01
schemas: blackmarket: No, that's no an additional timestamp 2021-10-29 13:54:39 +01:00
Athanasius
b35b934d8c
schemas: blackmarket: README
Note that it turns out this is deprecated in favour of the `prohibited`
array defined in the `commodity` schema, and has been that way since
September 2017.
2021-10-29 13:42:43 +01:00
Athanasius
652c50ab06 Merge branch 'develop' 2021-10-27 11:43:44 +00:00
Athanasius
916fe73f35 schemas: codexentry: NearestDestination *can* be an empty string.
We had one user with EDMC trying to send:

```python
OrderedDict([('$schemaRef',
'https://eddn.edcd.io/schemas/codexentry/1'), ('message',
OrderedDict([('timestamp', '2021-10-26T11:37:57Z'), ('event',
'CodexEntry'), ('EntryID', 2420702), ('Name',
'$Codex_Ent_Stratum_07_K_Name;'), ('SubCategory',
'$Codex_SubCategory_Organic_Structures;'), ('Category',
'$Codex_Category_Biology;'), ('Region', '$Codex_RegionName_18;'),
('System', 'Xi Ophiuchi'), ('SystemAddress', 2072061675891),
('NearestDestination', ''), ('Latitude', 79.352364), ('Longitude',
121.434044), ('horizons', True), ('odyssey', True), ('StarPos', [-3.875,
8.15625, 55.875]), ('BodyName', 'Xi Ophiuchi B 5'), ('BodyID', 14)]))])
```
as the message.  The EDDN Gateway then complains:

`FAIL: [<ValidationError: "'' is too short">]`
2021-10-27 11:08:16 +00:00
Athanasius
43e181a830 schemas: navroute: Add horizons and odyssey flags 2021-10-18 10:33:36 +00:00
Athanasius
87b33e4d1b Merge branch 'develop' 2021-10-18 10:27:26 +00:00