diff options
| author | Abhishek Kekane <akekane@redhat.com> | 2020-09-11 06:03:30 +0000 |
|---|---|---|
| committer | Abhishek Kekane <akekane@redhat.com> | 2020-09-11 06:03:30 +0000 |
| commit | e16d5c9ba3c687268eeef3df7a2832f173e42edd (patch) | |
| tree | 658c72eb683c184fb81ba2443d7d3ca2cf27fa3d /api-ref | |
| parent | b1715c96ff57b03c02d0b6b6a5dcc5b005562f32 (diff) | |
| download | glance-e16d5c9ba3c687268eeef3df7a2832f173e42edd.tar.gz | |
Corrections in default value of all_stores_must_succeed
Change-Id: I7b04f8ba86e0d6f42ef436e30ece9f019221e318
Closes-Bug: #1884996
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/v2/images-import.inc | 4 | ||||
| -rw-r--r-- | api-ref/source/v2/images-parameters.yaml | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/api-ref/source/v2/images-import.inc b/api-ref/source/v2/images-import.inc index 6603f2070..ec351d073 100644 --- a/api-ref/source/v2/images-import.inc +++ b/api-ref/source/v2/images-import.inc @@ -211,10 +211,10 @@ Note that this can't be used simultaneously with the ``stores`` parameter. To set the behavior of the import workflow in case of error, you can use the optional boolean body parameter ``all_stores_must_succeed``. -When set to True, if an error occurs during the upload in at least one store, +When set to True (default), if an error occurs during the upload in at least one store, the worfklow fails, the data is deleted from stores where copying is done and the state of the image remains unchanged. -When set to False (default), the workflow will fail only if the upload fails +When set to False, the workflow will fail only if the upload fails on all stores specified. In case of a partial success, the locations added to the image will be the stores where the data has been correctly uploaded. diff --git a/api-ref/source/v2/images-parameters.yaml b/api-ref/source/v2/images-parameters.yaml index 1a878cdf9..1e960c063 100644 --- a/api-ref/source/v2/images-parameters.yaml +++ b/api-ref/source/v2/images-parameters.yaml @@ -300,13 +300,13 @@ all-stores-succeed-in-request: description: | A boolean parameter indicating the behavior of the import workflow when an error occurs. - When set to True, if an error occurs during the upload in at least one + When set to True (default), if an error occurs during the upload in at least one store, the worfklow fails, the data is deleted from stores where copying is done (not staging), and the state of the image is unchanged. When set to False, the workflow will fail (data deleted from stores, ...) only if the import fails on all stores specified by the user. In case of a partial success, the locations added to the image will be the stores where - the data has been correctly uploaded. + the data has been correctly uploaded. Default is True. in: body required: false type: boolean |