openstack/nova
Code Issues Proposed changes

simplify the request / response format document

Browse Source 
This document previously existed to explain how to use either
application/json or application/xml with Nova. It's mostly confusing
in it's current state, and we're correctly defaulting to
application/json on request and response now.

Just remove most of what's confusing, users don't need to send
headers, we only do one thing now.

Change-Id: I597aeab73f1075f400f053016b4ea7bda01893a5
This commit is contained in:
Sean Dague 2015-12-14 12:35:14 -05:00
parent 415b221e33
commit 44a36ba7af
1 changed files with 4 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
api-guide/source/request_and_response_formats.rst
View File

@ -2,61 +2,20 @@
Request and response formats Request and response formats
============================ ============================
The OpenStack Compute API supports JSON request and response formats. The OpenStack Compute API only supports JSON request and response
formats, with a mime-type of ``application/json``. As there is only
Request format one supported content type, all content is assumed to be
~~~~~~~~~~~~~~ ``application/json`` in both request and response formats.
Use the ``Content-Type`` request header to specify the request format.
This header is required for operations that have a request body.
The syntax for the ``Content-Type`` header is:
.. code::
Content-Type: application/FORMAT
Where ``FORMAT`` is ``json``.
Response format
~~~~~~~~~~~~~~~
Use one of the following methods to specify the response format:
``Accept`` header
The syntax for the ``Accept`` header is:
.. code::
Accept: application/FORMAT
Where *``FORMAT``* is ``json`` and the default format is ``json``.
Query extension
Add a ``.json`` extension to the request URI. For example, the ``.json`` extension in the following list servers URI request specifies that the response body is to be returned in JSON format:
**GET** *``publicURL``*/servers.json
If you do not specify a response format, JSON is the default.
Request and response examples Request and response examples
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can serialize a response in a different format from the request
format.
The examples below show a request body in JSON format. The examples below show a request body in JSON format.
.. note:: Though you may find outdated documents with XML examples, XML support
in requests and responses has been deprecated for the Compute API v2
(stable) and v2.1 (experimental).
**Example: JSON request with headers** **Example: JSON request with headers**
| POST /v2/010101/servers HTTP/1.1 | POST /v2/010101/servers HTTP/1.1
| Host: servers.api.openstack.org | Host: servers.api.openstack.org
| Content-Type: application/json
| Accept: application/xml
| X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb | X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb
.. code:: .. code::
@ -83,4 +42,3 @@ The examples below show a request body in JSON format.
] ]
} }
} }