womax/nova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve formats of the Compute API guide

Browse Source 
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.

Improve some format in the guide.
e.g. Fix unnecessary bold characters.

Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
This commit is contained in:
Takashi NATSUME
2018-11-06 17:57:31 +09:00
parent c295e395dc
commit ddf7c6e370
9 changed files with 151 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-guide/source/versions.rst
+6 -6
View File
@@ -4,8 +4,8 @@ Versions
The OpenStack Compute API uses both a URI and a MIME type versioning
scheme. In the URI scheme, the first element of the path contains the
target version identifier (e.g. https://servers.api.openstack.org/
v2.1/...). The MIME type versioning scheme uses HTTP content negotiation
target version identifier (e.g. `https://servers.api.openstack.org/
v2.1/`...). The MIME type versioning scheme uses HTTP content negotiation
where the ``Accept`` or ``Content-Type`` headers contains a MIME type
that identifies the version (application/vnd.openstack.compute.v2.1+json).
A version MIME type is always linked to a base MIME type, such as
@@ -37,7 +37,7 @@ Permanent Links
The MIME type versioning approach allows for creating of permanent
links, because the version scheme is not specified in the URI path:
https://api.servers.openstack.org/224532/servers/123.
`https://api.servers.openstack.org/224532/servers/123`.
If a request is made without a version specified in the URI or via HTTP
headers, then a multiple-choices response (300) follows that provides
@@ -99,12 +99,12 @@ everything following that truncated) returned from the authentication system.
You can also obtain additional information about a specific version by
performing a **GET** on the base version URL (such as,
``https://servers.api.openstack.org/v2.1/``). Version request URLs must
always end with a trailing slash (``/``). If you omit the slash, the
`https://servers.api.openstack.org/v2.1/`). Version request URLs must
always end with a trailing slash (`/`). If you omit the slash, the
server might respond with a 302 redirection request.
For examples of the list versions and get version details requests and
responses, see `*API versions*
responses, see `API versions
<https://developer.openstack.org/api-ref/compute/#api-versions>`__.
The detailed version response contains pointers to both a human-readable