diff options
| author | Alistair Coles <alistair.coles@hpe.com> | 2016-09-06 16:24:13 +0100 |
|---|---|---|
| committer | Alistair Coles <alistair.coles@hpe.com> | 2016-09-19 09:46:06 +0100 |
| commit | 5ec9a62f4db57eb6ae86704bb987a83a8b0c6faa (patch) | |
| tree | fa59f1be389685a91e9137023179088296ef1e76 /api-ref | |
| parent | 6fea41e0f63739428559dd1e3396f2b04b369bac (diff) | |
| download | swift-5ec9a62f4db57eb6ae86704bb987a83a8b0c6faa.tar.gz | |
api-ref: clean up account listing examples
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
Diffstat (limited to 'api-ref')
3 files changed, 17 insertions, 39 deletions
diff --git a/api-ref/source/samples/account-containers-list-http-request-json.txt b/api-ref/source/samples/account-containers-list-http-request-json.txt index a4b315556..137ee93fb 100644 --- a/api-ref/source/samples/account-containers-list-http-request-json.txt +++ b/api-ref/source/samples/account-containers-list-http-request-json.txt @@ -1 +1 @@ -curl -i https://23.253.72.207/v1/$account?format=json -X GET -H "X-Auth-Token: $token"
\ No newline at end of file +curl -i $publicURL?format=json -X GET -H "X-Auth-Token: $token" diff --git a/api-ref/source/samples/account-containers-list-http-request-xml.txt b/api-ref/source/samples/account-containers-list-http-request-xml.txt index cf255617f..6f9293fdc 100644 --- a/api-ref/source/samples/account-containers-list-http-request-xml.txt +++ b/api-ref/source/samples/account-containers-list-http-request-xml.txt @@ -1,2 +1 @@ -curl -i https://23.253.72.207/v1/$account?format=xml \ - -X GET -H "X-Auth-Token: $token"
\ No newline at end of file +curl -i $publicURL?format=xml -X GET -H "X-Auth-Token: $token" diff --git a/api-ref/source/storage-account-services.inc b/api-ref/source/storage-account-services.inc index 4a543787c..605c31b41 100644 --- a/api-ref/source/storage-account-services.inc +++ b/api-ref/source/storage-account-services.inc @@ -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 ===================== |