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

Gateway/errors: Improve general outline of documentation section

Browse Source
This commit is contained in:
Athanasius 2022-01-09 16:10:01 +00:00
parent ccde820ba7
commit 4ad1519d1d
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -310,8 +310,11 @@ make a valid request" responses you might experience the following:
[commit 0e80c76cb564771465f61825e694227dcc3be312](https://github.com/EDCD/EDDN/commit/0e80c76cb564771465f61825e694227dcc3be312). [commit 0e80c76cb564771465f61825e694227dcc3be312](https://github.com/EDCD/EDDN/commit/0e80c76cb564771465f61825e694227dcc3be312).
#### EDDN Gateway responses #### EDDN Gateway responses
1. `400` - `Bad Request` - this can be for a variety of reasons, and should For all failures the response body will contain text that begins `FAIL: `.
come with a response body with a `FAIL: ` prefix:
1. `400` - `Bad Request` - This indicates something wrong with the request
body. Possibly due to a format issue (compression, form encoding), or
the actual content of the EDDN message:
1. `FAIL: zlib.error: <detail>` - A failure to decompress a message that 1. `FAIL: zlib.error: <detail>` - A failure to decompress a message that
claimed to be compressed. claimed to be compressed.
@ -347,15 +350,16 @@ make a valid request" responses you might experience the following:
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.
3. `426` - `Upgrade Required` - You sent a message with an outdated 2. `426` - `Upgrade Required` - This indicates that the cited schema, or
`$schemaRef` value. This could be either an old, deprecated version of version thereof, is outdated. The body of the response will be:
a schema, or an entirely deprecated schema. e.g.
``` ```
FAIL: The schema you have used is no longer supported. Please check for an updated version of your application. FAIL: Oudated Schema: The schema you have used is no longer supported. Please check for an updated version of your application.
``` ```
4. `FAIL: Outdated Schema: <detail>` - message cites a schema (or The wording here is aimed at users of applications that send messages
version of) that is no longer supported. over EDDN. If you're the developer of such an application then
obviously you need to update your code to use a currently supported
schema and version thereof.
There shouldn't be any other variants of a 'FAIL' message. If you find There shouldn't be any other variants of a 'FAIL' message. If you find