cinder/api-ref/source/v3
Matt Riedemann e7732680e0 api-ref: document encryption type provider choices
This updates the encrypted volume type provider
parameter descriptions for the create and update
requests to note the two choices of 'luks' and 'plain'.
Since we don't want those choices in the response
parameter descriptions, the parameters have to be
broken down a bit in the parameters.yaml file to
be request/response and optional/required.

There are currently other supported values for the
encryption type provider, including the legacy
classpath values, but we want people using the
non-legacy values so only luks and plain are
documented here, and luks is marked as the
recommended choice over plain (dm-crypt).

Change-Id: I496d30ecf6390f51cdd8e547b7345b3da30e92de
Closes-Bug: #1803513
2018-11-15 07:39:31 -05:00
..
samples Merge "api-ref: add missing fields in volume group types" 2018-10-26 01:58:45 +00:00
api-versions.inc Fix api-ref response code title levels 2018-03-13 15:57:54 -05:00
attachments.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
capabilities-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
consistencygroups-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
ext-backups-actions-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
ext-backups.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
group-replication.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
group-snapshots.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
group-type-specs.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
group-types.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
groups.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
hosts.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
index.rst Add api-ref for mv 3.55 volume transfer 2018-08-17 14:53:07 +00:00
limits.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
messages.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
os-cgsnapshots-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
os-services.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
os-vol-pool-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
os-vol-transfer-v3.inc api-ref: add preconditions for volume transfer APIs 2018-09-11 17:43:05 -04:00
parameters.yaml api-ref: document encryption type provider choices 2018-11-15 07:39:31 -05:00
qos-specs-v3-qos-specs.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
quota-classes.inc api-ref: fix req/resp params for v3 os-quota-class-sets 2018-09-24 11:08:24 -04:00
quota-sets.inc Fix api-ref response code title levels 2018-03-13 15:57:54 -05:00
resource-filters.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
snapshot-manage.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
valid-boolean-values.inc Update api-ref and release notes for schema validation 2018-07-17 15:05:54 +05:30
vol-transfer-v3.inc api-ref: add preconditions for volume transfer APIs 2018-09-11 17:43:05 -04:00
volume-manage.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volume-type-access.inc api-ref: Fix some params in volume types 2018-06-07 00:52:01 +00:00
volumes-v3-extensions.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volumes-v3-snapshots-actions.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volumes-v3-snapshots.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volumes-v3-types.inc api-ref: document encryption type provider choices 2018-11-15 07:39:31 -05:00
volumes-v3-versions.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volumes-v3-volumes-actions.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volumes-v3-volumes.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
worker-cleanup.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30