summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Rosmaita <rosmaita.fossdev@gmail.com>2018-08-16 11:43:53 -0400
committerBrian Rosmaita <rosmaita.fossdev@gmail.com>2018-08-16 19:05:52 +0000
commitd8221bf16fc0f5adabe4d3751c19aeed90d84f30 (patch)
treee8be4455f1ec207aba1bb2fe2995f71d0bffa53c
parent2142860353f12aea1dc4bc7e8e7a503602913c85 (diff)
api-ref: "hidden" images update
Update the api-ref for the "Operator maintained images lifecycle" spec implemented in Rocky. Change-Id: I8fcfb84579b655fd44759164508ce4532e4dd205
Notes
Notes (review): Code-Review+2: Sean McGinnis <sean.mcginnis@gmail.com> Code-Review+2: Erno Kuvaja <jokke@usr.fi> Workflow+1: Erno Kuvaja <jokke@usr.fi> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 16 Aug 2018 22:06:56 +0000 Reviewed-on: https://review.openstack.org/592561 Project: openstack/glance Branch: refs/heads/master
-rw-r--r--api-ref/source/v2/images-images-v2.inc4
-rw-r--r--api-ref/source/v2/images-parameters.yaml20
-rw-r--r--api-ref/source/v2/samples/image-create-response.json1
-rw-r--r--api-ref/source/v2/samples/image-details-deactivate-response.json3
-rw-r--r--api-ref/source/v2/samples/image-show-response.json3
-rw-r--r--api-ref/source/v2/samples/image-update-response.json3
-rw-r--r--api-ref/source/v2/samples/images-list-response.json6
-rw-r--r--api-ref/source/v2/samples/schemas-image-show-response.json4
-rw-r--r--api-ref/source/v2/samples/schemas-images-list-response.json4
9 files changed, 43 insertions, 5 deletions
diff --git a/api-ref/source/v2/images-images-v2.inc b/api-ref/source/v2/images-images-v2.inc
index d10c796..54a3788 100644
--- a/api-ref/source/v2/images-images-v2.inc
+++ b/api-ref/source/v2/images-images-v2.inc
@@ -218,6 +218,7 @@ Response Parameters
218 - name: name 218 - name: name
219 - os_hash_algo: os_hash_algo 219 - os_hash_algo: os_hash_algo
220 - os_hash_value: os_hash_value 220 - os_hash_value: os_hash_value
221 - os_hidden: os_hidden
221 - owner: owner 222 - owner: owner
222 - protected: protected 223 - protected: protected
223 - schema: schema-image 224 - schema: schema-image
@@ -284,6 +285,7 @@ Response Parameters
284 - name: name 285 - name: name
285 - os_hash_algo: os_hash_algo 286 - os_hash_algo: os_hash_algo
286 - os_hash_value: os_hash_value 287 - os_hash_value: os_hash_value
288 - os_hidden: os_hidden
287 - owner: owner 289 - owner: owner
288 - protected: protected 290 - protected: protected
289 - schema: schema-image 291 - schema: schema-image
@@ -482,6 +484,7 @@ Request
482 - status: status-in-query 484 - status: status-in-query
483 - tag: tag-in-query 485 - tag: tag-in-query
484 - visibility: visibility-in-query 486 - visibility: visibility-in-query
487 - os_hidden: os_hidden-in-query
485 - member_status: member_status-in-query 488 - member_status: member_status-in-query
486 - size_max: size_max 489 - size_max: size_max
487 - size_min: size_min 490 - size_min: size_min
@@ -606,6 +609,7 @@ Response Parameters
606 - owner: owner 609 - owner: owner
607 - os_hash_algo: os_hash_algo 610 - os_hash_algo: os_hash_algo
608 - os_hash_value: os_hash_value 611 - os_hash_value: os_hash_value
612 - os_hidden: os_hidden
609 - protected: protected 613 - protected: protected
610 - schema: schema-image 614 - schema: schema-image
611 - self: self 615 - self: self
diff --git a/api-ref/source/v2/images-parameters.yaml b/api-ref/source/v2/images-parameters.yaml
index 113e4a5..28535e0 100644
--- a/api-ref/source/v2/images-parameters.yaml
+++ b/api-ref/source/v2/images-parameters.yaml
@@ -165,6 +165,14 @@ name-in-query:
165 in: query 165 in: query
166 required: false 166 required: false
167 type: string 167 type: string
168os_hidden-in-query:
169 description: |
170 When ``true``, filters the response to display only "hidden" images. By
171 default, "hidden" images are not included in the image-list response.
172 *(Since Image API v2.7)*
173 in: query
174 required: false
175 type: boolean
168owner-in-query: 176owner-in-query:
169 description: | 177 description: |
170 Filters the response by a project (also called a "tenant") ID. Shows only 178 Filters the response by a project (also called a "tenant") ID. Shows only
@@ -522,6 +530,18 @@ os_hash_value:
522 in: body 530 in: body
523 required: true 531 required: true
524 type: string 532 type: string
533os_hidden:
534 description: |
535 This field controls whether an image is displayed in the default
536 image-list response. A "hidden" image is out of date somehow (for
537 example, it may not have the latest updates applied) and hence should
538 not be a user's first choice, but it's not deleted because it may be
539 needed for server rebuilds. By hiding it from the default image list,
540 it's easier for end users to find and use a more up-to-date version of
541 this image. *(Since Image API v2.7)*
542 in: body
543 required: true
544 type: boolean
525owner: 545owner:
526 description: | 546 description: |
527 An identifier for the owner of the image, usually the project (also 547 An identifier for the owner of the image, usually the project (also
diff --git a/api-ref/source/v2/samples/image-create-response.json b/api-ref/source/v2/samples/image-create-response.json
index afcb822..fe94899 100644
--- a/api-ref/source/v2/samples/image-create-response.json
+++ b/api-ref/source/v2/samples/image-create-response.json
@@ -17,6 +17,7 @@
17 "checksum": null, 17 "checksum": null,
18 "os_hash_algo": null, 18 "os_hash_algo": null,
19 "os_hash_value": null, 19 "os_hash_value": null,
20 "os_hidden": false,
20 "owner": "bab7d5c60cd041a0a36f7c4b6e1dd978", 21 "owner": "bab7d5c60cd041a0a36f7c4b6e1dd978",
21 "virtual_size": null, 22 "virtual_size": null,
22 "min_ram": 0, 23 "min_ram": 0,
diff --git a/api-ref/source/v2/samples/image-details-deactivate-response.json b/api-ref/source/v2/samples/image-details-deactivate-response.json
index 66a5d5b..24ba586 100644
--- a/api-ref/source/v2/samples/image-details-deactivate-response.json
+++ b/api-ref/source/v2/samples/image-details-deactivate-response.json
@@ -14,7 +14,8 @@
14 "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file", 14 "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
15 "checksum": "64d7c1cd2b6f60c92c14662941cb7913", 15 "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
16 "os_hash_algo": "sha512", 16 "os_hash_algo": "sha512",
17 "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09" 17 "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09",
18 "os_hidden": false,
18 "owner": "5ef70662f8b34079a6eddb8da9d75fe8", 19 "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
19 "size": 13167616, 20 "size": 13167616,
20 "min_ram": 0, 21 "min_ram": 0,
diff --git a/api-ref/source/v2/samples/image-show-response.json b/api-ref/source/v2/samples/image-show-response.json
index 9660d4f..33e3fd9 100644
--- a/api-ref/source/v2/samples/image-show-response.json
+++ b/api-ref/source/v2/samples/image-show-response.json
@@ -14,7 +14,8 @@
14 "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file", 14 "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
15 "checksum": "64d7c1cd2b6f60c92c14662941cb7913", 15 "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
16 "os_hash_algo": "sha512", 16 "os_hash_algo": "sha512",
17 "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09" 17 "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09",
18 "os_hidden": false,
18 "owner": "5ef70662f8b34079a6eddb8da9d75fe8", 19 "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
19 "size": 13167616, 20 "size": 13167616,
20 "min_ram": 0, 21 "min_ram": 0,
diff --git a/api-ref/source/v2/samples/image-update-response.json b/api-ref/source/v2/samples/image-update-response.json
index 3211cc8..ee5c5e0 100644
--- a/api-ref/source/v2/samples/image-update-response.json
+++ b/api-ref/source/v2/samples/image-update-response.json
@@ -10,7 +10,8 @@
10 "name": "Fedora 17", 10 "name": "Fedora 17",
11 "owner": "02a7fb2dd4ef434c8a628c511dcbbeb6", 11 "owner": "02a7fb2dd4ef434c8a628c511dcbbeb6",
12 "os_hash_algo": "sha512", 12 "os_hash_algo": "sha512",
13 "os_hash_value": "ef7d1ed957ffafefb324d50ebc6685ed03d0e64549762ba94a1c44e92270cdbb69d7437dd1e101d00dd41684aaecccad1edc5c2e295e66d4733025b052497844" 13 "os_hash_value": "ef7d1ed957ffafefb324d50ebc6685ed03d0e64549762ba94a1c44e92270cdbb69d7437dd1e101d00dd41684aaecccad1edc5c2e295e66d4733025b052497844",
14 "os_hidden": false,
14 "protected": false, 15 "protected": false,
15 "schema": "/v2/schemas/image", 16 "schema": "/v2/schemas/image",
16 "self": "/v2/images/2b61ed2b-f800-4da0-99ff-396b742b8646", 17 "self": "/v2/images/2b61ed2b-f800-4da0-99ff-396b742b8646",
diff --git a/api-ref/source/v2/samples/images-list-response.json b/api-ref/source/v2/samples/images-list-response.json
index c44504b..3d641be 100644
--- a/api-ref/source/v2/samples/images-list-response.json
+++ b/api-ref/source/v2/samples/images-list-response.json
@@ -16,7 +16,8 @@
16 "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file", 16 "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
17 "checksum": "64d7c1cd2b6f60c92c14662941cb7913", 17 "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
18 "os_hash_algo": "sha512", 18 "os_hash_algo": "sha512",
19 "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09" 19 "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09",
20 "os_hidden": false,
20 "owner": "5ef70662f8b34079a6eddb8da9d75fe8", 21 "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
21 "size": 13167616, 22 "size": 13167616,
22 "min_ram": 0, 23 "min_ram": 0,
@@ -39,7 +40,8 @@
39 "file": "/v2/images/781b3762-9469-4cec-b58d-3349e5de4e9c/file", 40 "file": "/v2/images/781b3762-9469-4cec-b58d-3349e5de4e9c/file",
40 "checksum": "afab0f79bac770d61d24b4d0560b5f70", 41 "checksum": "afab0f79bac770d61d24b4d0560b5f70",
41 "os_hash_algo": "sha512", 42 "os_hash_algo": "sha512",
42 "os_hash_value": "ea3e20140df1cc65f53d4c5b9ee3b38d0d6868f61bbe2230417b0f98cef0e0c7c37f0ebc5c6456fa47f013de48b452617d56c15fdba25e100379bd0e81ee15ec" 43 "os_hash_value": "ea3e20140df1cc65f53d4c5b9ee3b38d0d6868f61bbe2230417b0f98cef0e0c7c37f0ebc5c6456fa47f013de48b452617d56c15fdba25e100379bd0e81ee15ec",
44 "os_hidden": false,
43 "owner": "5ef70662f8b34079a6eddb8da9d75fe8", 45 "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
44 "size": 476704768, 46 "size": 476704768,
45 "min_ram": 0, 47 "min_ram": 0,
diff --git a/api-ref/source/v2/samples/schemas-image-show-response.json b/api-ref/source/v2/samples/schemas-image-show-response.json
index 5232ac7..bec4935 100644
--- a/api-ref/source/v2/samples/schemas-image-show-response.json
+++ b/api-ref/source/v2/samples/schemas-image-show-response.json
@@ -163,6 +163,10 @@
163 "string" 163 "string"
164 ] 164 ]
165 }, 165 },
166 "os_hidden": {
167 "description": "If true, image will not appear in default image list response.",
168 "type": "boolean"
169 },
166 "os_version": { 170 "os_version": {
167 "description": "Operating system version as specified by the distributor", 171 "description": "Operating system version as specified by the distributor",
168 "is_base": false, 172 "is_base": false,
diff --git a/api-ref/source/v2/samples/schemas-images-list-response.json b/api-ref/source/v2/samples/schemas-images-list-response.json
index 3365b88..f150970 100644
--- a/api-ref/source/v2/samples/schemas-images-list-response.json
+++ b/api-ref/source/v2/samples/schemas-images-list-response.json
@@ -184,6 +184,10 @@
184 "string" 184 "string"
185 ] 185 ]
186 }, 186 },
187 "os_hidden": {
188 "description": "If true, image will not appear in default image list response.",
189 "type": "boolean"
190 },
187 "os_version": { 191 "os_version": {
188 "description": "Operating system version as specified by the distributor", 192 "description": "Operating system version as specified by the distributor",
189 "is_base": false, 193 "is_base": false,