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 API is currently undocumented, as I noticed while working on OSC
changes. There isn't anything too unusual going on here. The API was
first introduced in microversion 3.7 and was then extended with
replication-related information in 3.36. Both are accounted for here.
Change-Id: I86dc774c8d203839f4dadb13e93a416d112fc7b5
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Co-authored-by: Lucas de Oliveira <lucasmoliveira059@gmail.com>
Closes-Bug: 1885544
Inclusion of a project_id in API URLs is now optional, and no longer
required. Removing the project_id requirement facilitates supporting
Secure RBAC's notion of system scope, in which an API method is not
associated with a specific project.
The API v3 routing is enhanced to provide duplicate routes for API
methods that traditionally required a project_id in the URL:
- The existing route for which a project_id is in the URL
- A new route for when the URL does not include a project_id
To test both routes and ensure there are no regresssions, the "API
samples" functional tests include a project_id in the URLs, and the
rest of the functional tests do not include the project_id. This is
handled by changing the 'noauth' WSGI middleware to no longer add the
project_id, and adding a new 'noauth_include_project_id' middleware
filter that implements the legacy behavior.
A new microversion V3.67 is introduced, but it only serves to inform
clients whether the project_id is optional or required. When an API
node supports mv 3.67, the project_id is optional in all API requests,
even when the request specifies a earlier microversion. See the spec
Ia44f199243be8f862520d7923007e7182b32f67d for more details on this
behavior.
Note: Much of the groundwork for this is based on manila's patch
I5127e150e8a71e621890f30dba6720b3932cf583.
DocImpact
APIImpact
Implements: blueprint project-id-optional-in-urls
Change-Id: I3729cbe1902ab4dc335451d13ed921ec236fb8fd
This patch adds a feature by which we allow setting default volume types
for projects.
The following changes are made to achieve the feature:
1) Add 4 set of APIs, set, get, get_all, unset volume type
2) All policies (except get_all) default to system/domain/project admin
3) Preference order: project default, conf default
4) Logic to not allow deletion of default type
We validate set, get and unset APIs with keystone to verify a valid
project id is passed in the request and user has proper authorization
rights to show the project.
The policies are system/domain/project admin by default except get_all
policy which defaults to system admin.
Implements: Blueprint multiple-default-volume-types
Change-Id: Idcc949ed6adbaea0c2337fac83014998b81ff1f8
Adds the api-ref information for the the 3.55 version of the volume
transfer API.
Change-Id: Ib91c2f7018184821437da41bc0f7b0c0b2e69f0c
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
The CoprHD driver was marked unsupported
in Rocky and the vendor has indicated that
the driver is deprecated. Given the feedback
I am removing the driver.
Change-Id: I978315402edeb0c5dd6aee28315973fa502b0e20
This patch adds a reno for validate boolean parameters with spaces.
Also adds valid values in api-ref for boolean parameters that user
can pass in request body.
Implements: bp/json-schema-validation
Change-Id: Iff4b2906dba93a238d720a218fcf7a9f78b96a37
In the file api-ref/source/v3/index.rst, it missed include
volumes-v3-snapshots-actions.inc, This change is to add it
and fix doc format error.
Change-Id: Ib6dc549f8bc8da5dfd64d0e390cd70b27cd63177
Add APIs introduced for group replication.
Also corrected a few incorrectly referenced group ID
body parameters while I was at it.
Closes-bug: 1700882
Change-Id: I253099072dba9fb6b03f562466aad0ff36b4052f
Allow triggering cleanup from API was introduced in cinder[1], but it's
not documented in the API docs. This change is to add it in the API docs.
[1] https://review.openstack.org/#/c/363010/
Closes-bug: #1708809
Change-Id: Iadec39e8411a598372bc19bb566627a143faa0d8
This commit adds the api documentation for the
GET/PUT os-quota-class-set APIs (v2 and v3).
Change-Id: Idb51b7b90a081775d2d836bf6d9ec8b9c0399f1b
Closes-Bug: #1602400
The 'os-show_image_metadata' API is outdated.
Rewrite the document, also correct the response
codes for image metadata's create/delete APIs.
Change-Id: I50a5b3571973564b8b5010b412d94303866e8dcd
This patch did:
1. Add list manageable volumes API doc.
2. Add create and list manageable snapshots API doc.
Change-Id: Iccffb69b0ffb220f43258ee4c47d5d8964ae7836
Closes-bug: #1590977
This applies an order to the v3 API reference documents.
The idea being how does a new user come into and use the API
and what APIs should they see first when getting started.
Naturally they need to know about versions and microversions
that are avaible. Then they might need to know about volume
types before creating a volume. Once they create a volume
and know the basics of working with volumes, they can start
to take some actions on volumes. After that it's just kind
of a random free for all of APIs and the only order applied
to the rest is sorting alphabetically by title.
Change-Id: I8956de3e6907582f7115430eb959813a13e87a49
Add attachment API related Docs, please note we
use 'instance_uuid' in the request and 'instance' in
the response to represent the same thing 'server_id'.
DocImpact
Change-Id: I8bd5a9061af2b47fd227e8cf2f48f80f271bde14
The Cinder v3 API was marked CURRENT in Mitaka, but there no API ref
was ever created. This is problematic for end users and would hinder
the v3 API from being included in DefCore Interoperability Guidelines
somewhere down the line (since one of DefCore's Criteria[1] is that a
Capability be well documented). This patch creates an API ref for v3.
It also adds a header to the v2 index to show that it is SUPPORTED,
whereas v3 is CURRENT.
[1]
http://git.openstack.org/cgit/openstack/defcore/tree/doc/source/process/CoreCriteria.rst#n77
Change-Id: Ia3a8050cd04ad3a487a79d80acf9691feee6182e
Closes-Bug: #1616072
Stephen Finucane