From 192da355babd1f4387f1620aeaa94557cbbe5e14 Mon Sep 17 00:00:00 2001 From: zhufl Date: Wed, 7 Nov 2018 13:54:58 +0800 Subject: [PATCH] api-ref: add missing volumes_links in list-volume interfaces https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=list-accessible-volumes-detail#list-accessible-volumes https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-volumes-with-details volumes_links is in the response body of list-volume and list-volume-with-details when pagination is used. So it should be an optional parameter. Change-Id: If61797f9a5cb5c522ed62886f4114d43e7cbbdef --- api-ref/source/v2/parameters.yaml | 8 +++++++- .../source/v2/samples/volumes-list-detailed-response.json | 6 +++++- api-ref/source/v2/samples/volumes-list-response.json | 6 +++++- api-ref/source/v2/volumes-v2-volumes.inc | 2 ++ api-ref/source/v3/parameters.yaml | 6 ++++++ .../source/v3/samples/volumes-list-detailed-response.json | 4 ++++ api-ref/source/v3/samples/volumes-list-response.json | 4 ++++ api-ref/source/v3/volumes-v3-volumes.inc | 2 ++ 8 files changed, 35 insertions(+), 3 deletions(-) diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 217ad09857e..f84544e2973 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -874,6 +874,12 @@ links_5: in: body required: true type: array +links_vol_optional: + description: | + The volume links. + in: body + required: false + type: array location: description: | Full URL to a service or server. @@ -1903,4 +1909,4 @@ volumes_number_for_type: the specified volume type. in: body required: true - type: integer \ No newline at end of file + type: integer diff --git a/api-ref/source/v2/samples/volumes-list-detailed-response.json b/api-ref/source/v2/samples/volumes-list-detailed-response.json index 057d1b1e307..6b861294e03 100644 --- a/api-ref/source/v2/samples/volumes-list-detailed-response.json +++ b/api-ref/source/v2/samples/volumes-list-detailed-response.json @@ -94,5 +94,9 @@ "created_at": "2015-11-29T02:25:18.000000", "volume_type": "lvmdriver-1" } - ] + ], + "volumes_links": [{ + "href": "https://158.69.65.111/volume/v2/4ad9f06ab8654e40befa59a2e7cac86d/volumes/detail?limit=1&marker=3b451d5d-9358-4a7e-a746-c6fd8b0e1462", + "rel": "next" + }] } diff --git a/api-ref/source/v2/samples/volumes-list-response.json b/api-ref/source/v2/samples/volumes-list-response.json index b3c7cc05164..27e46d56a99 100644 --- a/api-ref/source/v2/samples/volumes-list-response.json +++ b/api-ref/source/v2/samples/volumes-list-response.json @@ -28,5 +28,9 @@ ], "name": "vol-003" } - ] + ], + "volumes_links": [{ + "href": "https://158.69.65.111/volume/v2/4ad9f06ab8654e40befa59a2e7cac86d/volumes/detail?limit=1&marker=3b451d5d-9358-4a7e-a746-c6fd8b0e1462", + "rel": "next" + }] } diff --git a/api-ref/source/v2/volumes-v2-volumes.inc b/api-ref/source/v2/volumes-v2-volumes.inc index 5326f037526..46a1cf8e22d 100644 --- a/api-ref/source/v2/volumes-v2-volumes.inc +++ b/api-ref/source/v2/volumes-v2-volumes.inc @@ -119,6 +119,7 @@ Response Parameters - created_at: created_at - volumes: volumes - volume_type: volume_type + - volumes_links: links_vol_optional @@ -274,6 +275,7 @@ Response Parameters - id: id - links: links - name: name + - volumes_links: links_vol_optional diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index d1df5aa6eaf..ad9f3a11c17 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -1499,6 +1499,12 @@ links_vol: in: body required: true type: array +links_vol_optional: + description: | + The volume links. + in: body + required: false + type: array location: description: | Full URL to a service or server. diff --git a/api-ref/source/v3/samples/volumes-list-detailed-response.json b/api-ref/source/v3/samples/volumes-list-detailed-response.json index 5a1f8333251..aafa710cce5 100644 --- a/api-ref/source/v3/samples/volumes-list-detailed-response.json +++ b/api-ref/source/v3/samples/volumes-list-detailed-response.json @@ -95,5 +95,9 @@ "volume_type": "lvmdriver-1" } ], + "volumes_links": [{ + "href": "https://158.69.65.111/volume/v3/4ad9f06ab8654e40befa59a2e7cac86d/volumes/detail?limit=1&marker=3b451d5d-9358-4a7e-a746-c6fd8b0e1462", + "rel": "next" + }], "count": 10 } diff --git a/api-ref/source/v3/samples/volumes-list-response.json b/api-ref/source/v3/samples/volumes-list-response.json index 96ad313c197..29e737abfda 100644 --- a/api-ref/source/v3/samples/volumes-list-response.json +++ b/api-ref/source/v3/samples/volumes-list-response.json @@ -29,5 +29,9 @@ "name": "vol-003" } ], + "volumes_links": [{ + "href": "https://158.69.65.111/volume/v3/4ad9f06ab8654e40befa59a2e7cac86d/volumes/detail?limit=1&marker=3b451d5d-9358-4a7e-a746-c6fd8b0e1462", + "rel": "next" + }], "count": 10 } diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 6e13758ed07..513bd72a103 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -128,6 +128,7 @@ Response Parameters - created_at: created_at - volumes: volumes - volume_type: volume_type_vol + - volumes_links: links_vol_optional - count: count @@ -294,6 +295,7 @@ Response Parameters - id: id_vol - links: links_vol - name: name_vol + - volumes_links: links_vol_optional - count: count