summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-06-16 15:36:30 +0000
committerGerrit Code Review <review@openstack.org>2017-06-16 15:36:30 +0000
commit464e8fc8ea3d02d59cc1b2ccafaabebf92f831f0 (patch)
treed3b24ef94a74b8f6737defc8ee3222e3509fa18a
parenteee46144c2de7c7de7d421f7521dcf889edebfa6 (diff)
parent622a0ff4249ba11bc25a74880d282325d75a3201 (diff)
Merge "api-ref: clarify retype docs around default policy permissions"
-rw-r--r--api-ref/source/v2/parameters.yaml9
-rw-r--r--api-ref/source/v2/volumes-v2-volumes-actions.inc4
-rw-r--r--api-ref/source/v3/parameters.yaml9
-rw-r--r--api-ref/source/v3/volumes-v3-volumes-actions.inc4
4 files changed, 22 insertions, 4 deletions
diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml
index 1337236..a91c42c 100644
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@@ -973,8 +973,13 @@ metadata_items:
973 type: integer 973 type: integer
974migration_policy: 974migration_policy:
975 description: | 975 description: |
976 Specify if make migration when retyping volume, the value is 'on-demand' 976 Specify if the volume should be migrated when it is re-typed.
977 or 'never'. 977 Possible values are ``on-demand`` or ``never``. If not specified, the
978 default is ``never``.
979
980 .. note:: If the volume is attached to a server instance and will be
981 migrated, then by default policy only users with the administrative role
982 should attempt the retype operation.
978 in: body 983 in: body
979 required: false 984 required: false
980 type: string 985 type: string
diff --git a/api-ref/source/v2/volumes-v2-volumes-actions.inc b/api-ref/source/v2/volumes-v2-volumes-actions.inc
index 9f70d9f..000aa61 100644
--- a/api-ref/source/v2/volumes-v2-volumes-actions.inc
+++ b/api-ref/source/v2/volumes-v2-volumes-actions.inc
@@ -315,6 +315,10 @@ Change type of existing volume. Specify the ``os-retype`` action in the request
315Change the volume type of existing volume, Cinder may migrate the volume to 315Change the volume type of existing volume, Cinder may migrate the volume to
316proper volume host according to the new volume type. 316proper volume host according to the new volume type.
317 317
318Policy defaults enable only users with the administrative role or the owner of
319the volume to perform this operation. Cloud providers can change these
320permissions through the policy.json file.
321
318Normal response codes: 202 322Normal response codes: 202
319 323
320 324
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index 5e48821..ed57a7c 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -1187,8 +1187,13 @@ metadata_items:
1187 type: integer 1187 type: integer
1188migration_policy: 1188migration_policy:
1189 description: | 1189 description: |
1190 Specify if make migration when retyping volume, the value is 'on-demand' 1190 Specify if the volume should be migrated when it is re-typed.
1191 or 'never'. 1191 Possible values are ``on-demand`` or ``never``. If not specified, the
1192 default is ``never``.
1193
1194 .. note:: If the volume is attached to a server instance and will be
1195 migrated, then by default policy only users with the administrative role
1196 should attempt the retype operation.
1192 in: body 1197 in: body
1193 required: false 1198 required: false
1194 type: string 1199 type: string
diff --git a/api-ref/source/v3/volumes-v3-volumes-actions.inc b/api-ref/source/v3/volumes-v3-volumes-actions.inc
index 681d47f..cc69d25 100644
--- a/api-ref/source/v3/volumes-v3-volumes-actions.inc
+++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc
@@ -312,6 +312,10 @@ Change type of existing volume. Specify the ``os-retype`` action in the request
312Change the volume type of existing volume, Cinder may migrate the volume to 312Change the volume type of existing volume, Cinder may migrate the volume to
313proper volume host according to the new volume type. 313proper volume host according to the new volume type.
314 314
315Policy defaults enable only users with the administrative role or the owner of
316the volume to perform this operation. Cloud providers can change these
317permissions through the policy.json file.
318
315Normal response codes: 202 319Normal response codes: 202
316 320
317 321