diff options
author | Zuul <zuul@review.opendev.org> | 2021-09-07 14:34:32 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2021-09-07 14:34:32 +0000 |
commit | 929190a6afd0a1593e62abb8024c339713b52b98 (patch) | |
tree | cb1fbf0f5f5801cd4d18e74a0fdb698b5a536de8 | |
parent | f24abc57849314e30fb5dce59437f1c970da0f37 (diff) | |
parent | ad755cbd2bd8bfa33927c7f74be699d4f576d1d6 (diff) | |
download | glance-929190a6afd0a1593e62abb8024c339713b52b98.tar.gz |
Merge "Add doc support for delete-from-store API"23.0.0.0b3
-rw-r--r-- | api-ref/source/v2/images-parameters.yaml | 6 | ||||
-rw-r--r-- | api-ref/source/v2/index.rst | 1 | ||||
-rw-r--r-- | api-ref/source/v2/stores.inc | 30 |
3 files changed, 37 insertions, 0 deletions
diff --git a/api-ref/source/v2/images-parameters.yaml b/api-ref/source/v2/images-parameters.yaml index 0106857f1..459a20b1c 100644 --- a/api-ref/source/v2/images-parameters.yaml +++ b/api-ref/source/v2/images-parameters.yaml @@ -104,6 +104,12 @@ member_id-in-path: in: path required: true type: string +store-in-path: + description: | + The ID of the store from which image is to be deleted. + in: path + required: true + type: string tag-in-path: description: | The image tag. A tag is limited to 255 chars in length. You may wish diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst index 34e1ec74f..f18dfbf31 100644 --- a/api-ref/source/v2/index.rst +++ b/api-ref/source/v2/index.rst @@ -29,6 +29,7 @@ Image Service API v2 (CURRENT) .. include:: images-schemas.inc .. include:: images-data.inc .. include:: images-import.inc +.. include:: stores.inc .. include:: discovery.inc .. include:: tasks.inc .. include:: tasks-schemas.inc diff --git a/api-ref/source/v2/stores.inc b/api-ref/source/v2/stores.inc new file mode 100644 index 000000000..3d08a59a0 --- /dev/null +++ b/api-ref/source/v2/stores.inc @@ -0,0 +1,30 @@ +.. -*- rst -*- + +Stores +****** + +Multi-store backend support allows for storing copies of an image in multiple places. + +Delete image from store +~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: DELETE /v2/stores/{store_id}/{image_id} + +This API allows you to delete a copy of the image from a specific store. +*(Since Image API v2.10)* + +.. note:: + * This API will not allow deletion of the last location for an image. + +Normal response codes: 204 + +Error response codes: 400, 401, 403, 404, 409 + +Request +------- + +.. rest_parameters:: images-parameters.yaml + + - store_id: store-in-path + - image_id: image_id-in-path + |