openstack/swift
Code Issues Proposed changes

api-ref: clean up account listing examples

Browse Source 
Move the account listing sample responses to follow the sample
requests, and to precede the request/response parameter definitions to
be consistent with other parts of the doc.

Related-Change: I315b4e550b7d10880fbc00fce9311127ba609c2d

Change-Id: Ia20acacd238db4a423b8cd89af1658222b4c5828
This commit is contained in:
Alistair Coles 2016-09-06 16:24:13 +01:00
parent 6fea41e0f6
commit 5ec9a62f4d
3 changed files with 17 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/samples/account-containers-list-http-request-json.txt
View File

@ -1 +1 @@
curl -i https://23.253.72.207/v1/$account?format=json -X GET -H "X-Auth-Token: $token"
curl -i $publicURL?format=json -X GET -H "X-Auth-Token: $token"

3
api-ref/source/samples/account-containers-list-http-request-xml.txt
View File

@ -1,2 +1 @@
curl -i https://23.253.72.207/v1/$account?format=xml \
-X GET -H "X-Auth-Token: $token"
curl -i $publicURL?format=xml -X GET -H "X-Auth-Token: $token"

51
api-ref/source/storage-account-services.inc
View File

@ -24,23 +24,6 @@ using the SQLite memcmp() function, regardless of text encoding.
See `Collating Sequences
<http://www.sqlite.org/datatype3.html#collation>`_.
Example requests and responses:
- Show account details and list containers and ask for a JSON
response:
::
curl -i $publicURL?format=json -X GET -H "X-Auth-Token: $token"
- List containers and ask for an XML response:
::
curl -i $publicURL?format=xml -X GET -H "X-Auth-Token: $token"
The response body returns a list of containers. The default
response (``text/plain``) returns one container per line.
@ -56,6 +39,21 @@ is text, JSON, or XML. For a text response, you get a 204 , because
there is no content. However, for a JSON or XML response, you get a
200 with content indicating an empty array.
Example requests and responses:
- Show account details and list containers and ask for a JSON
response:
.. literalinclude:: samples/account-containers-list-http-request-json.txt
.. literalinclude:: samples/account-containers-list-http-response-json.txt
.. literalinclude:: samples/account-containers-list-response.json
- Show account details and list containers and ask for an XML response:
.. literalinclude:: samples/account-containers-list-http-request-xml.txt
.. literalinclude:: samples/account-containers-list-http-response-xml.txt
.. literalinclude:: samples/account-containers-list-response.xml
If the request succeeds, the operation returns one of these status
codes:
@ -116,22 +114,6 @@ Response Parameters
- name: name
Response Example format=json
----------------------------
.. literalinclude:: samples/account-containers-list-http-response-json.txt
.. literalinclude:: samples/account-containers-list-response.json
Response Example format=xml
---------------------------
.. literalinclude:: samples/account-containers-list-http-response-xml.txt
.. literalinclude:: samples/account-containers-list-response.xml
Create, update, or delete account metadata
==========================================
@ -291,9 +273,6 @@ Response Parameters
- X-Trans-Id: X-Trans-Id
Show account metadata
=====================