openstack
/
cinder
Code Issues Proposed changes

api-ref: Fix indentation, case 

A bullet list shouldn't be indented in rST and doing so causes it to be
rendered inside a blockquote, which is not what we want.

In addition, indicating versions as vXXX is more prevalent than VXXX so
correct this.

Change-Id: I3ea8e0a8ae58d5b7da9aae85b41162b2458020d5
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2023-07-17 11:18:52 +01:00
parent 712032959c
commit b6c38c3001
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
api-ref/source/v3/index.rst
View File

@ -5,23 +5,24 @@ Block Storage API V3 (CURRENT)
==============================
.. note::
The URL for most API methods includes a {project_id} placeholder that
represents the caller's project ID. As of V3.67, the project_id is optional
The URL for most API methods includes a ``{project_id}`` placeholder that
represents the caller's project ID. As of v3.67, the project_id is optional
in the URL, and the following are equivalent:
* GET /v3/{project_id}/volumes
* GET /v3/volumes
* ``GET /v3/{project_id}/volumes``
* ``GET /v3/volumes``
In both instances, the actual project_id used by the API method is the one
in the caller's keystone context. For that reason, including a project_id
in the URL is redundant.
In both instances, the actual project ID used by the API method is the one
in the caller's keystone context. For that reason, including a project ID in
the URL is redundant.
The V3.67 microversion is only used as an indicator that the API accepts a
URL without a project_id, and this applies to all requests regardless of
the microversion in the request. For example, an API node serving V3.67 or
greater will accept a URL without a project_id even if the request asks for
V3.0. Likewise, it will accept a URL containing a project_id even if the
request asks for V3.67.
The v3.67 microversion is only used as an indicator that the API accepts a
URL without a ``{project_id}`` segment, and this applies to all requests
regardless of the microversion in the request. For example, an API node
serving v3.67 or greater will accept a URL without a ``{project_id}``
segment even if the request asks for v3.0. Likewise, it will accept a URL
containing a ``{project_id}`` segment even if the request asks for v3.67.
.. rest_expand_all::