Update Share types api-ref

Was missing a query parameter (is_public)
and some information on an existing query
parameter (extra-specs)

Change-Id: Ib70e08c963cf1f583ab6d5fbae6a69aa3593980a
Closes-Bug: #1816486
This commit is contained in:
Goutham Pacha Ravi 2020-08-06 17:06:21 -07:00
parent f78e2fdee7
commit 271214a051
2 changed files with 19 additions and 10 deletions

View File

@ -221,7 +221,10 @@ extra_specs_query:
The extra specifications as a set of one or more The extra specifications as a set of one or more
key-value pairs. In each pair, the key is the name of the extra key-value pairs. In each pair, the key is the name of the extra
specification and the value is the share type that was used to specification and the value is the share type that was used to
filter search share type list. filter search share type list. The query must be a “percent-encoded” string,
for example, the following query parameters: {'extra-specs':
{'snapshot_support': 'true', 'availability_zones': 'az1'}} is encoded as
'extra_specs=%7B%27snapshot_support%27%3A+%27true%27%2C+%27availability_zones%27%3A+%27az1%27%7D'
in: query in: query
required: false required: false
type: string type: string

View File

@ -4,16 +4,21 @@
Share types Share types
=========== ===========
A share type enables you to filter or choose back ends before you A share type provides hints to the scheduler service to aid placement of new
create a share. A share type behaves in the same way as a Block workloads. It contains extra specifications that can either match back end
Storage volume type behaves. storage capabilities or provide instructions to the Shared File Systems
service with regard to the workload being requested. A share type behaves in
the same way as a Block Storage volume type behaves. See the
`administration reference on share
types <https://docs.openstack.org/manila/latest/admin/shared-file-systems-share-types.html>`_
for more information.
You set a share type to private or public and manage the access to You can create publicly visible share type that are visible to all projects
the private share types. and users within the cloud, or make them private and control which projects
can access them.
When you issue a create a share type request, you can submit a When you issue a create a share type request, you can submit a request body
request body with either a ``share_type`` or ``volume_type`` with either a ``share_type`` or ``volume_type`` object.
object.
.. important:: .. important::
@ -88,7 +93,7 @@ other roles.
List share types List share types
================ ================
.. rest_method:: GET /v2/{project_id}/types .. rest_method:: GET /v2/{project_id}/types?is_public={is_public}&extra-specs={extra-specs-as-dict}
Lists all share types. Lists all share types.
@ -105,6 +110,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- is_public: is_public_query
- extra_specs: extra_specs_query - extra_specs: extra_specs_query
Response parameters Response parameters