Debian Codegraph @

releasenotes/notes/project-id-optional-in-urls-db97e2c447167853.yaml

raw
1 ---
2 features:
3 - |
4 Inclusion of a project_id in API URLs is now optional. The `Block Storage
5 API V3 <https://docs.openstack.org/api-ref/block-storage/v3>`_ reference
6 guide continues to show URLs with a project_id because the legacy behavior
7 continues to be supported.
8
9 A new API microversion V3.67 is introduced to inform clients when
10 inclusion of a project_id in API URLs is optional. The V3.67 microversion
11 is only used as an indicator that the API accepts a URL without a
12 project_id, and this applies to all requests regardless of the
13 microversion in the request. For example, an API node serving V3.67 or
14 greater will accept a URL without a project_id even if the request asks
15 for V3.0. Likewise, it will accept a URL containing a project_id even if
16 the request asks for V3.67.
17 upgrade:
18 - |
19 Upgrades are not affected by the new functionality whereby a project_id
20 is no longer required in API URLs. The legacy behavior in which a
21 project_id is included in the URL continues to be supported.
22
23 Detection of whether a URL includes a project_id is based on the value of
24 a new ``project_id_regex`` option. The default value matches UUIDs
25 created by keystone.