openstack/nova
Code Issues Proposed changes

api: Deprecate v2 API

Browse Source 
Change-Id: Ie236cc001ddc6362b92119710ec1672ae733318e
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane
2025-07-04 11:24:23 +01:00
parent d238306aa6
commit df630cd1b2
9 changed files with 32 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api-guide/source/microversions.rst
View File

@@ -65,10 +65,10 @@ as follows::
"rel": "self" "rel": "self"
} }
], ],
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z" "updated": "2025-07-04T12:00:00Z"
}, },
{ {
"id": "v2.1", "id": "v2.1",

2
api-guide/source/versions.rst
View File

@@ -64,7 +64,7 @@ links and MIME types to available versions.
"type": "application/vnd.openstack.compute+json;version=2" "type": "application/vnd.openstack.compute+json;version=2"
} }
], ],
"status": "SUPPORTED" "status": "DEPRECATED"
}, },
{ {
"id": "v2.1", "id": "v2.1",

4
doc/api_samples/versions/v2-version-get-resp.json
View File

@@ -18,9 +18,9 @@
"type": "application/vnd.openstack.compute+json;version=2" "type": "application/vnd.openstack.compute+json;version=2"
} }
], ],
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z" "updated": "2025-07-04T12:00:00Z"
} }
} }

6
doc/api_samples/versions/versions-get-resp.json
View File

@@ -8,10 +8,10 @@
"rel": "self" "rel": "self"
} }
], ],
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z" "updated": "2025-07-04T12:00:00Z"
}, },
{ {
"id": "v2.1", "id": "v2.1",
@@ -27,4 +27,4 @@
"updated": "2013-07-23T11:33:21Z" "updated": "2013-07-23T11:33:21Z"
} }
] ]
} }

4
nova/api/openstack/compute/versions.py
View File

@@ -33,10 +33,10 @@ LINKS = {
VERSIONS = { VERSIONS = {
"v2.0": { "v2.0": {
"id": "v2.0", "id": "v2.0",
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z", "updated": "2025-07-04T12:00:00Z",
"links": [ "links": [
{ {
"rel": "describedby", "rel": "describedby",

6
nova/tests/functional/api_sample_tests/api_samples/versions/v2-version-get-resp.json.tpl
View File

@@ -19,8 +19,8 @@
} }
], ],
"min_version": "", "min_version": "",
"status": "SUPPORTED", "status": "DEPRECATED",
"updated": "2011-01-21T11:33:21Z", "updated": "2025-07-04T12:00:00Z",
"version": "" "version": ""
} }
} }

4
nova/tests/functional/api_sample_tests/api_samples/versions/versions-get-resp.json.tpl
View File

@@ -8,10 +8,10 @@
"rel": "self" "rel": "self"
} }
], ],
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z" "updated": "2025-07-04T12:00:00Z"
}, },
{ {
"id": "v2.1", "id": "v2.1",

16
nova/tests/unit/api/openstack/compute/test_versions.py
View File

@@ -46,10 +46,10 @@ EXP_LINKS = {
EXP_VERSIONS = { EXP_VERSIONS = {
"v2.0": { "v2.0": {
"id": "v2.0", "id": "v2.0",
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z", "updated": "2025-07-04T12:00:00Z",
"links": [ "links": [
{ {
"rel": "describedby", "rel": "describedby",
@@ -116,10 +116,10 @@ class VersionsTestV21WithV2CompatibleWrapper(test.NoDBTestCase):
expected = [ expected = [
{ {
"id": "v2.0", "id": "v2.0",
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z", "updated": "2025-07-04T12:00:00Z",
"links": [ "links": [
{ {
"rel": "self", "rel": "self",
@@ -153,10 +153,10 @@ class VersionsTestV21WithV2CompatibleWrapper(test.NoDBTestCase):
expected = { expected = {
"version": { "version": {
"id": "v2.0", "id": "v2.0",
"status": "SUPPORTED", "status": "DEPRECATED",
"version": "", "version": "",
"min_version": "", "min_version": "",
"updated": "2011-01-21T11:33:21Z", "updated": "2025-07-04T12:00:00Z",
"links": [ "links": [
{ {
"rel": "self", "rel": "self",
@@ -203,7 +203,7 @@ class VersionsTestV21WithV2CompatibleWrapper(test.NoDBTestCase):
"choices": [ "choices": [
{ {
"id": "v2.0", "id": "v2.0",
"status": "SUPPORTED", "status": "DEPRECATED",
"links": [ "links": [
{ {
"href": "http://localhost/v2/images/1", "href": "http://localhost/v2/images/1",
@@ -262,7 +262,7 @@ class VersionsTestV21WithV2CompatibleWrapper(test.NoDBTestCase):
"choices": [ "choices": [
{ {
"id": "v2.0", "id": "v2.0",
"status": "SUPPORTED", "status": "DEPRECATED",
"links": [ "links": [
{ {
"href": "http://localhost/v2/servers/" + uuid, "href": "http://localhost/v2/servers/" + uuid,

9
releasenotes/notes/deprecate-v2-api-22b1ca9c35c321bc.yaml Normal file
View File

@@ -0,0 +1,9 @@
---
deprecations:
- |
The legacy v2 API is now deprecated for removal, and the status in the root
version document (``/``) has been changed from ``SUPPORTED`` to
``DEPRECATED``. This will cause some clients like keystoneauth to ignore
the endpoint by default. Users are encouraged to switch the v2.1 API, which
is functionally identical to the v2 API when using the ``2.1`` API
microversion.