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

Merge branch 'master' of github.com:EDSM-NET/EDDN

Browse Source
This commit is contained in:
Athanasius 2022-01-11 13:42:48 +00:00
commit 01ce718ab8
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
schemas/README-EDDN-schemas.md
View File

@ -294,6 +294,8 @@ make a valid request" responses you might experience the following:
its request and the reverse proxy rejected it as a result. its request and the reverse proxy rejected it as a result.
2. `503` - `Service Unavailable` - the EDDN Gateway process is either not 2. `503` - `Service Unavailable` - the EDDN Gateway process is either not
running, or not responding. running, or not responding.
3. `400` - `Bad Request` - if you attempt to use plain HTTP, rather than
HTTPS.
#### bottle responses #### bottle responses
1. `413` - `Payload Too Large` - `bottle` enforces a maximum request size 1. `413` - `Payload Too Large` - `bottle` enforces a maximum request size
@ -306,7 +308,7 @@ make a valid request" responses you might experience the following:
``` ```
in in
[src/eddn/Gateway.py](https://github.com/EDCD/EDDN/blob/master/src/eddn/Gateway.py), [src/eddn/Gateway.py](https://github.com/EDCD/EDDN/blob/live/src/eddn/Gateway.py),
as added in as added in
[commit 0e80c76cb564771465f61825e694227dcc3be312](https://github.com/EDCD/EDDN/commit/0e80c76cb564771465f61825e694227dcc3be312). [commit 0e80c76cb564771465f61825e694227dcc3be312](https://github.com/EDCD/EDDN/commit/0e80c76cb564771465f61825e694227dcc3be312).
@ -345,12 +347,17 @@ For all failures the response body will contain text that begins `FAIL: `. Curr
the schema the response will look like: the schema the response will look like:
``` ```
FAIL: Schema Validation: "[<ValidationError: "{'type': ['array', 'boolean', 'integer', 'number', 'null', 'object', 'string']} is not allowed for 'BadKey'">]" FAIL: Schema Validation: "[<ValidationError: "{'type': ['array', 'boolean', 'integer', 'number', 'null', 'object', 'string']} is not allowed for 'BadVALUE'">]"
``` ```
This is due to the use of a JSON schema stanza that says "don't allow This is due to the use of a JSON schema stanza that says "don't allow
any valid type for the value of this key" to trigger the error for such any valid type for the value of this key" to trigger the error for such
disallowed keys. disallowed keys.
Note how the **value** for the disallowed key is cited, not the key *name*
itself. This is a limitation of how the `jsonschema` python module
reports errors, and we are
[hoping to improve this](https://github.com/EDCD/EDDN/issues/163).
2. `426` - `Upgrade Required` - This indicates that the cited schema, or 2. `426` - `Upgrade Required` - This indicates that the cited schema, or
version thereof, is outdated. The body of the response will be: version thereof, is outdated. The body of the response will be:
@ -378,6 +385,16 @@ The URL for the live Relay is:
tcp://eddn.edcd.io:9500 tcp://eddn.edcd.io:9500
Depending on the programming language and library used, you might need
to explicitly subscribe to an empty topic, `''`, in order to receive
anything.
Unfortunately at this time we're using an old version of
ZeroMQ which does not support server-side subscription filtering. So by
all means specify a more specific topic filter if it suits your needs,
but realise that the dropping of not-matching messages will happen at
your end, not the server.
Once you've connected to that you will receive messages. To access the Once you've connected to that you will receive messages. To access the
data you will first need to zlib-decompress each message. Then you will data you will first need to zlib-decompress each message. Then you will
have a textual JSON object as per the schemas. have a textual JSON object as per the schemas.