From a875828acb66b96fdaa80f24a88ccc69abb29654 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sat, 31 Oct 2020 16:27:43 +0100 Subject: clean up use of HTTP status codes --- core/api-sync.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'core/api-sync.rst') diff --git a/core/api-sync.rst b/core/api-sync.rst index 650cd8a7..1e673ed6 100644 --- a/core/api-sync.rst +++ b/core/api-sync.rst @@ -156,28 +156,28 @@ Receiving Terms of Service **Response** - :status 200 OK: + :http:statuscode:`200 OK`: The body contains the current version of the backup as known to the server. - :status 204 No content: + :http:statuscode:`204 No content`: This is a fresh account, no previous backup data exists at the server. - :status 304 Not modified: + :http:statuscode:`304 Not modified`: The version available at the server is identical to that specified in the "If-None-Match" header. - :status 404 Not found: + :http:statuscode:`404 Not found`: The backup service is unaware of a matching account. - :status 410 Gone: + :http:statuscode:`410 Gone`: The backup service has closed operations. The body will contain the latest version still available at the server. The body may be empty if no version is available. The user should be urged to find another provider. - :status 429 Too many requests: + :http:statuscode:`429 Too many requests`: This account has exceeded thresholds for the number of requests. The client should try again later, and may want to decrease its synchronization frequency. @@ -249,52 +249,52 @@ Receiving Terms of Service **Response** - :status 204 No content: + :http:statuscode:`204 No content`: The transfer was successful, and the server has registered the new version. - :status 304 Not modified: + :http:statuscode:`304 Not modified`: The server is already aware of this version of the client. Returned before 100 continue to avoid upload. - :status 400 Bad request: + :http:statuscode:`400 Bad request`: Most likely, the uploaded body is too short (less than 32 bytes). - :status 402 Payment required: + :http:statuscode:`402 Payment required`: The synchronization service requires payment before the account can continue to be used. The fulfillment URL should be the /$ACCOUNT-KEY URL, but can be safely ignored by the client. The contract should be shown to the user in the canonical dialog, possibly in a fresh tab. - :status 403 Forbidden: + :http:statuscode:`403 Forbidden`: The signature is invalid or missing (or body does not match). - :status 409 Conflict: + :http:statuscode:`409 Conflict`: The server has a more recent version than what is given in "If-Match". The more recent version is returned. The client should merge the two versions and retry using the given response's "E-Tag" in the next attempt in "If-Match". - :status 410 Gone: + :http:statuscode:`410 Gone`: The backup service has closed operations. The body will contain the latest version still available at the server. The body may be empty if no version is available. The user should be urged to find another provider. - :status 411 Length required: + :http:statuscode:`411 Length required`: The client must specify the "Content-length" header before attempting upload. While technically optional by the HTTP specification, the synchronization service may require the client to provide the length upfront. - :status 413 Request Entity Too Large: + :http:statuscode:`413 Request entity too large`: The requested upload exceeds the quota for the type of account. The client should suggest to the user to migrate to another backup and synchronization service (like with "410 Gone"). - :status 429 Too many requests: + :http:statuscode:`429 Too many requests`: This account has exceeded daily thresholds for the number of requests. The client should try again later, and may want to decrease its synchronization frequency. -- cgit v1.2.3