openstack/cinder
Code Issues Proposed changes

Api-ref: Reorganize volumes versions

Browse Source 
In v2 sample path, there are redundant files version-v2-show-response.json,
in v3 sample path, there are redundant files version-v2-show-response.json
and version-v3-show-response.json, This patch is to remove the redundant
JSON file and reorganize volumes versions of v2 and v3

Change-Id: I3d9337cc94ad02138459742a7b84fe97bd09bb90
This commit is contained in:
junboli 2017-07-10 17:28:40 +08:00
parent ab236e32d6
commit cca970b322
7 changed files with 110 additions and 204 deletions

61
api-ref/source/v2/samples/version-show-response.json

@ -1,29 +1,36 @@
{
"version": {
"status": "CURRENT",
"updated": "2012-01-04T11:33:21Z",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v1.0",
"links": [
{
"href": "http://23.253.228.211:8776/v1/",
"rel": "self"
},
{
"href": "http://jorgew.github.com/block-storage-api/content/os-block-storage-1.0.pdf",
"type": "application/pdf",
"rel": "describedby"
},
{
"href": "http://docs.rackspacecloud.com/servers/api/v1.1/application.wadl",
"type": "application/vnd.sun.wadl+xml",
"rel": "describedby"
}
]
}
"choices": [
{
"status": "SUPPORTED",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v1.0",
"links": [
{
"href": "http://23.253.248.171:8776/v1/v2.json",
"rel": "self"
}
]
},
{
"status": "CURRENT",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v2.0",
"links": [
{
"href": "http://23.253.248.171:8776/v2/v2.json",
"rel": "self"
}
]
}
]
}

36
api-ref/source/v2/samples/version-v2-show-response.json

@ -1,36 +0,0 @@
{
"choices": [
{
"status": "SUPPORTED",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v1.0",
"links": [
{
"href": "http://23.253.248.171:8776/v1/v2.json",
"rel": "self"
}
]
},
{
"status": "CURRENT",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v2.0",
"links": [
{
"href": "http://23.253.248.171:8776/v2/v2.json",
"rel": "self"
}
]
}
]
}

2
api-ref/source/v2/volumes-v2-versions.inc

@ -34,7 +34,7 @@ Response Parameters
Response Example
----------------
.. literalinclude:: ./samples/version-v2-show-response.json
.. literalinclude:: ./samples/version-show-response.json
:language: javascript

101
api-ref/source/v3/samples/version-show-response.json

@ -1,29 +1,76 @@
{
"version": {
"status": "CURRENT",
"updated": "2012-01-04T11:33:21Z",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v1.0",
"links": [
{
"href": "http://23.253.228.211:8776/v1/",
"rel": "self"
},
{
"href": "http://jorgew.github.com/block-storage-api/content/os-block-storage-1.0.pdf",
"type": "application/pdf",
"rel": "describedby"
},
{
"href": "http://docs.rackspacecloud.com/servers/api/v1.1/application.wadl",
"type": "application/vnd.sun.wadl+xml",
"rel": "describedby"
}
]
}
"versions": [
{
"id": "v1.0",
"links": [
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v1/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "",
"status": "DEPRECATED",
"updated": "2014-06-28T12:20:21Z",
"version": ""
},
{
"id": "v2.0",
"links": [
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v2/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "",
"status": "SUPPORTED",
"updated": "2014-06-28T12:20:21Z",
"version": ""
},
{
"id": "v3.0",
"links": [
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v3/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "3.0",
"status": "CURRENT",
"updated": "2016-02-08T12:20:21Z",
"version": "3.0"
}
]
}

36
api-ref/source/v3/samples/version-v2-show-response.json

@ -1,36 +0,0 @@
{
"choices": [
{
"status": "SUPPORTED",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v1.0",
"links": [
{
"href": "http://23.253.248.171:8776/v1/v2.json",
"rel": "self"
}
]
},
{
"status": "CURRENT",
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"id": "v2.0",
"links": [
{
"href": "http://23.253.248.171:8776/v2/v2.json",
"rel": "self"
}
]
}
]
}

76
api-ref/source/v3/samples/version-v3-show-response.json

@ -1,76 +0,0 @@
{
"versions": [
{
"id": "v1.0",
"links": [
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v1/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "",
"status": "DEPRECATED",
"updated": "2014-06-28T12:20:21Z",
"version": ""
},
{
"id": "v2.0",
"links": [
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v2/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "",
"status": "SUPPORTED",
"updated": "2014-06-28T12:20:21Z",
"version": ""
},
{
"id": "v3.0",
"links": [
{
"href": "http://docs.openstack.org/",
"rel": "describedby",
"type": "text/html"
},
{
"href": "http://23.253.248.171:8776/v3/",
"rel": "self"
}
],
"media-types": [
{
"base": "application/json",
"type": "application/vnd.openstack.volume+json;version=1"
}
],
"min_version": "3.0",
"status": "CURRENT",
"updated": "2016-02-08T12:20:21Z",
"version": "3.0"
}
]
}

2
api-ref/source/v3/volumes-v3-versions.inc

@ -36,7 +36,7 @@ Response Parameters
Response Example
----------------
.. literalinclude:: ./samples/version-v3-show-response.json
.. literalinclude:: ./samples/version-show-response.json
:language: javascript