diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 52a8ac568d..2e12906d07 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -221,7 +221,10 @@ extra_specs_query: The extra specifications as a set of one or more 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 - 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 required: false type: string diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index e72915ecab..0a0d6397c7 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -4,16 +4,21 @@ Share types =========== -A share type enables you to filter or choose back ends before you -create a share. A share type behaves in the same way as a Block -Storage volume type behaves. +A share type provides hints to the scheduler service to aid placement of new +workloads. It contains extra specifications that can either match back end +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 `_ +for more information. -You set a share type to private or public and manage the access to -the private share types. +You can create publicly visible share type that are visible to all projects +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 -request body with either a ``share_type`` or ``volume_type`` -object. +When you issue a create a share type request, you can submit a request body +with either a ``share_type`` or ``volume_type`` object. .. important:: @@ -88,7 +93,7 @@ other roles. 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. @@ -105,6 +110,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - is_public: is_public_query - extra_specs: extra_specs_query Response parameters