From 5ac85fdd75076c59844f058978111bd2a6a6c292 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Wed, 7 Sep 2016 15:55:41 -0400 Subject: [PATCH] api-ref: add versions history The 'versions' response contains the status of the Images API versions, but does not indicate the releases when the statuses went into effect. This patch adds a Version History to the 'versions' api-ref page. The language used (for example, "Bexar changes") is consistent with what's been adopted for other parts of the images api-ref (see the discussion on https://review.openstack.org/#/c/356693/ ) This patch is current for Newton: - v1 deprecation: already merged as commit 63e6dbb1eb006758fbcf7cae83e1d2eacf46b4ab - v2 minor version bump: the dependency stated below Depends-On: I5d1c4380682efa4c15ff0f294f269c800fe6762a Change-Id: Id920a3284a4be23032cc4a23e04726fab6d24361 Closes-bug: #1621161 Partial-bug: #1618495 --- api-ref/source/versions/index.rst | 38 +++++++++++++++++++ .../samples/image-versions-response.json | 16 ++++++-- 2 files changed, 51 insertions(+), 3 deletions(-) diff --git a/api-ref/source/versions/index.rst b/api-ref/source/versions/index.rst index 677eaec354..16e4809be9 100644 --- a/api-ref/source/versions/index.rst +++ b/api-ref/source/versions/index.rst @@ -20,3 +20,41 @@ Image Service Versions .. rest_expand_all:: .. include:: versions.inc + +Version History +*************** + +**Newton changes** + +- version 2.4 is CURRENT +- version 2.3 is SUPPORTED +- version 1.1 is DEPRECATED +- version 1.0 is DEPRECATED + +**Kilo changes** + +- version 2.3 is CURRENT +- version 1.1 is SUPPORTED + +**Havana changes** + +- version 2.2 is CURRENT +- version 2.1 is SUPPORTED + +**Grizzly changes** + +- version 2.1 is CURRENT +- version 2.0 is SUPPORTED + +**Folson changes** + +- version 2.0 is CURRENT + +**Diablo changes** + +- version 1.1 is CURRENT +- version 1.0 is SUPPORTED + +**Bexar changes** + +- version 1.0 is CURRENT diff --git a/api-ref/source/versions/samples/image-versions-response.json b/api-ref/source/versions/samples/image-versions-response.json index d8746fa86b..5cd136687f 100644 --- a/api-ref/source/versions/samples/image-versions-response.json +++ b/api-ref/source/versions/samples/image-versions-response.json @@ -1,5 +1,15 @@ { "versions": [ + { + "id": "v2.4", + "links": [ + { + "href": "http://glance.openstack.example.org/v2/", + "rel": "self" + } + ], + "status": "CURRENT" + }, { "id": "v2.3", "links": [ @@ -8,7 +18,7 @@ "rel": "self" } ], - "status": "CURRENT" + "status": "SUPPORTED" }, { "id": "v2.2", @@ -48,7 +58,7 @@ "rel": "self" } ], - "status": "SUPPORTED" + "status": "DEPRECATED" }, { "id": "v1.0", @@ -58,7 +68,7 @@ "rel": "self" } ], - "status": "SUPPORTED" + "status": "DEPRECATED" } ] }