openstack/swift
Code Issues Proposed changes

api-ref: Clean up container and object response code formatting

Browse Source 
Change-Id: I994ea0c9700678ab7e1364badc2ff88ebef5ec5e
Closes-Bug: #1806596
This commit is contained in:
Tim Burke 2018-12-04 13:35:15 -08:00
parent 333ae3086f
commit 33792353fc
2 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
api-ref/source/storage-container-services.inc
View File

@ -37,8 +37,9 @@ Example requests and responses:
If the container does not exist, the call returns the ``Not Found If the container does not exist, the call returns the ``Not Found
(404)`` response code. (404)`` response code.
Normal response codes: 200 Normal response codes: 200, 204
Error response codes:416,404,204,
Error response codes: 404
Request Request
@ -327,7 +328,9 @@ If the request succeeds, the operation returns the ``No Content
To confirm your changes, issue a show container metadata request. To confirm your changes, issue a show container metadata request.
Error response codes:204, Normal response codes: 204
Error response codes: 404
Request Request
@ -411,7 +414,7 @@ Show container metadata request:
If the request succeeds, the operation returns the ``No Content If the request succeeds, the operation returns the ``No Content
(204)`` response code. (204)`` response code.
Error response codes:204, Normal response codes: 204
Request Request
@ -519,7 +522,9 @@ If the container exists but is not empty, the response is:
</p> </p>
</html> </html>
Error response codes:404,204,409, Normal response codes: 204
Error response codes: 404, 409
Request Request

17
api-ref/source/storage-object-services.inc
View File

@ -93,7 +93,8 @@ code for any ranged GET requests that specify more than:
Normal response codes: 200 Normal response codes: 200
Error response codes:416,404,
Error response codes: 416, 404
Request Request
@ -224,6 +225,9 @@ Example requests and responses:
The ``Created (201)`` response code indicates a successful write. The ``Created (201)`` response code indicates a successful write.
If the container for the object does not already exist, the operation
returns the ``404 Not Found`` response code.
If the request times out, the operation returns the ``Request If the request times out, the operation returns the ``Request
Timeout (408)`` response code. Timeout (408)`` response code.
@ -234,7 +238,9 @@ If the MD5 checksum of the data that is written to the object store
does not match the optional ``ETag`` value, the operation returns does not match the optional ``ETag`` value, the operation returns
the ``Unprocessable Entity (422)`` response code. the ``Unprocessable Entity (422)`` response code.
Error response codes:201,422,411,408, Normal response codes: 201
Error response codes: 404, 408, 411, 422
Request Request
@ -394,7 +400,7 @@ When several replicas exist, the system copies from the most recent
replica. That is, the COPY operation behaves as though the replica. That is, the COPY operation behaves as though the
``X-Newest`` header is in the request. ``X-Newest`` header is in the request.
Error response codes:201, Normal response codes: 201
Request Request
@ -488,7 +494,7 @@ However, with the ``multipart-manifest=delete`` query parameter,
the response body contains a list of manifest and segment objects the response body contains a list of manifest and segment objects
and the status of their DELETE operations. and the status of their DELETE operations.
Error response codes:204, Normal response codes: 204
Request Request
@ -567,7 +573,6 @@ code.
Normal response codes: 200 Normal response codes: 200
Error response codes:204,
Request Request
@ -741,7 +746,7 @@ Example requests and responses:
</p> </p>
</html> </html>
Error response codes:202, Normal response codes: 202
Request Request