Browse Source

api-ref: "hidden" images update

Update the api-ref for the "Operator maintained images lifecycle"
spec implemented in Rocky.

Change-Id: I8fcfb84579b655fd44759164508ce4532e4dd205
Brian Rosmaita 8 months ago
parent
commit
d8221bf16f

+ 4
- 0
api-ref/source/v2/images-images-v2.inc View File

@@ -218,6 +218,7 @@ Response Parameters
218 218
    - name: name
219 219
    - os_hash_algo: os_hash_algo
220 220
    - os_hash_value: os_hash_value
221
+   - os_hidden: os_hidden
221 222
    - owner: owner
222 223
    - protected: protected
223 224
    - schema: schema-image
@@ -284,6 +285,7 @@ Response Parameters
284 285
    - name: name
285 286
    - os_hash_algo: os_hash_algo
286 287
    - os_hash_value: os_hash_value
288
+   - os_hidden: os_hidden
287 289
    - owner: owner
288 290
    - protected: protected
289 291
    - schema: schema-image
@@ -482,6 +484,7 @@ Request
482 484
    - status: status-in-query
483 485
    - tag: tag-in-query
484 486
    - visibility: visibility-in-query
487
+   - os_hidden: os_hidden-in-query
485 488
    - member_status: member_status-in-query
486 489
    - size_max: size_max
487 490
    - size_min: size_min
@@ -606,6 +609,7 @@ Response Parameters
606 609
    - owner: owner
607 610
    - os_hash_algo: os_hash_algo
608 611
    - os_hash_value: os_hash_value
612
+   - os_hidden: os_hidden
609 613
    - protected: protected
610 614
    - schema: schema-image
611 615
    - self: self

+ 20
- 0
api-ref/source/v2/images-parameters.yaml View File

@@ -165,6 +165,14 @@ name-in-query:
165 165
   in: query
166 166
   required: false
167 167
   type: string
168
+os_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
168 176
 owner-in-query:
169 177
   description: |
170 178
     Filters the response by a project (also called a "tenant") ID.  Shows only
@@ -522,6 +530,18 @@ os_hash_value:
522 530
   in: body
523 531
   required: true
524 532
   type: string
533
+os_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
525 545
 owner:
526 546
   description: |
527 547
     An identifier for the owner of the image, usually the project (also

+ 1
- 0
api-ref/source/v2/samples/image-create-response.json View File

@@ -17,6 +17,7 @@
17 17
     "checksum": null,
18 18
     "os_hash_algo": null,
19 19
     "os_hash_value": null,
20
+    "os_hidden": false,
20 21
     "owner": "bab7d5c60cd041a0a36f7c4b6e1dd978",
21 22
     "virtual_size": null,
22 23
     "min_ram": 0,

+ 2
- 1
api-ref/source/v2/samples/image-details-deactivate-response.json View File

@@ -14,7 +14,8 @@
14 14
     "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
15 15
     "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
16 16
     "os_hash_algo": "sha512",
17
-    "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09"
17
+    "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09",
18
+    "os_hidden": false,
18 19
     "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
19 20
     "size": 13167616,
20 21
     "min_ram": 0,

+ 2
- 1
api-ref/source/v2/samples/image-show-response.json View File

@@ -14,7 +14,8 @@
14 14
     "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
15 15
     "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
16 16
     "os_hash_algo": "sha512",
17
-    "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09"
17
+    "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09",
18
+    "os_hidden": false,
18 19
     "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
19 20
     "size": 13167616,
20 21
     "min_ram": 0,

+ 2
- 1
api-ref/source/v2/samples/image-update-response.json View File

@@ -10,7 +10,8 @@
10 10
     "name": "Fedora 17",
11 11
     "owner": "02a7fb2dd4ef434c8a628c511dcbbeb6",
12 12
     "os_hash_algo": "sha512",
13
-    "os_hash_value": "ef7d1ed957ffafefb324d50ebc6685ed03d0e64549762ba94a1c44e92270cdbb69d7437dd1e101d00dd41684aaecccad1edc5c2e295e66d4733025b052497844"
13
+    "os_hash_value": "ef7d1ed957ffafefb324d50ebc6685ed03d0e64549762ba94a1c44e92270cdbb69d7437dd1e101d00dd41684aaecccad1edc5c2e295e66d4733025b052497844",
14
+    "os_hidden": false,
14 15
     "protected": false,
15 16
     "schema": "/v2/schemas/image",
16 17
     "self": "/v2/images/2b61ed2b-f800-4da0-99ff-396b742b8646",

+ 4
- 2
api-ref/source/v2/samples/images-list-response.json View File

@@ -16,7 +16,8 @@
16 16
             "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
17 17
             "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
18 18
             "os_hash_algo": "sha512",
19
-            "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09"
19
+            "os_hash_value": "073b4523583784fbe01daff81eba092a262ec37ba6d04dd3f52e4cd5c93eb8258af44881345ecda0e49f3d8cc6d2df6b050ff3e72681d723234aff9d17d0cf09",
20
+            "os_hidden": false,
20 21
             "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
21 22
             "size": 13167616,
22 23
             "min_ram": 0,
@@ -39,7 +40,8 @@
39 40
             "file": "/v2/images/781b3762-9469-4cec-b58d-3349e5de4e9c/file",
40 41
             "checksum": "afab0f79bac770d61d24b4d0560b5f70",
41 42
             "os_hash_algo": "sha512",
42
-            "os_hash_value": "ea3e20140df1cc65f53d4c5b9ee3b38d0d6868f61bbe2230417b0f98cef0e0c7c37f0ebc5c6456fa47f013de48b452617d56c15fdba25e100379bd0e81ee15ec"
43
+            "os_hash_value": "ea3e20140df1cc65f53d4c5b9ee3b38d0d6868f61bbe2230417b0f98cef0e0c7c37f0ebc5c6456fa47f013de48b452617d56c15fdba25e100379bd0e81ee15ec",
44
+            "os_hidden": false,
43 45
             "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
44 46
             "size": 476704768,
45 47
             "min_ram": 0,

+ 4
- 0
api-ref/source/v2/samples/schemas-image-show-response.json View File

@@ -163,6 +163,10 @@
163 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 170
         "os_version": {
167 171
             "description": "Operating system version as specified by the distributor",
168 172
             "is_base": false,

+ 4
- 0
api-ref/source/v2/samples/schemas-images-list-response.json View File

@@ -184,6 +184,10 @@
184 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 191
                     "os_version": {
188 192
                         "description": "Operating system version as specified by the distributor",
189 193
                         "is_base": false,

Loading…
Cancel
Save