summaryrefslogtreecommitdiff
path: root/core/api-common.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2020-02-05 20:12:19 +0100
committerChristian Grothoff <christian@grothoff.org>2020-02-05 20:12:19 +0100
commit288826460848964629a21f2089f7cbeb2e2328f6 (patch)
treefd86ffad866ce4e94cdbf8c0fe9cd39c98e9927b /core/api-common.rst
parent0ec883104a3908049763c25c8b3873d137f65a43 (diff)
downloaddocs-288826460848964629a21f2089f7cbeb2e2328f6.tar.gz
docs-288826460848964629a21f2089f7cbeb2e2328f6.tar.bz2
docs-288826460848964629a21f2089f7cbeb2e2328f6.zip
propose new exchange API
Diffstat (limited to 'core/api-common.rst')
-rw-r--r--core/api-common.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/core/api-common.rst b/core/api-common.rst
index 689e806..5ee4404 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -43,7 +43,17 @@ handle the error as if an internal error (500) had been returned.
**Response:**
:resheader Content-Type: application/json
- :status 200: The request was successful.
+ :status 200:
+ The request was successful.
+ :status 301 Moved Permanently:
+ The server responsible for the reserve
+ changed, the client MUST follow the link to the new location. If possible,
+ the client SHOULD remember the new URL for the reserve for future
+ requests.
+ :status 302 Found:
+ The server responsible for the reserve changed, the
+ client MUST follow the link to the new location, but MUST NOT retain the
+ new URL for future requests.
:status 500 Internal server error:
This always indicates some serious internal operational error of the exchange,
such as a program bug, database problems, etc., and must not be used for
@@ -57,7 +67,8 @@ handle the error as if an internal error (500) had been returned.
should naturally be able to address them in a timely fashion, especially
within 24h. When generating an internal server error, the exchange responds with
a JSON object containing the following fields:
- :status 400 Bad Request: One of the arguments to the request is missing or malformed.
+ :status 400 Bad Request:
+ One of the arguments to the request is missing or malformed.
Unless specified otherwise, all error status codes (4xx and 5xx) have a message
body with an `ErrorDetail` JSON object.