cinder/api-ref/source
Alan Bishop 31b34e91e0 Remove the need for project_id from API endpoints
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
2022-02-08 08:32:23 -08:00
..
v2 Merge "Correct the rest api url of import_record of backup" 2021-08-28 15:56:40 +00:00
v3 Remove the need for project_id from API endpoints 2022-02-08 08:32:23 -08:00
api_microversion_history.rst Add microversion history to api-ref 2018-09-18 14:59:37 -05:00
conf.py Switch to newer openstackdocstheme and reno versions 2020-05-27 12:28:24 +00:00
index.rst Add microversion history to api-ref 2018-09-18 14:59:37 -05:00
status.yaml Use rest_status_code for api-ref response codes 2018-03-08 21:59:37 -06:00