openstack/manila
Code Issues Proposed changes

The parameters of 'list shares' are optional

Browse Source 
Only 'project_id' in the path is required,
other parameters are not required

Partial-Bug: #1760644
Change-Id: I8f5735f8b828f33c95139e5a963f56b5b6e9105a
This commit is contained in:
shaoxj 2018-11-12 09:43:07 +08:00 committed by Tom Barron
parent 4ffca949c2
commit 2736d4adcc
8 changed files with 61 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/os-share-manage.inc
View File

@ -88,7 +88,7 @@ Response parameters
- metadata: metadata
- status: status_8
- description: description
- host: host_7
- host: host_1
- is_public: is_public
- snapshot_support: snapshot_support
- name: name

29
api-ref/source/parameters.yaml
View File

@ -146,7 +146,7 @@ action_id:
type: string
description: >
The ID of the action during which the message was created.
all_tenants:
all_tenants_query:
description: |
(Admin only). Defines whether to list the requested resources for
all projects. Set to ``1`` to list resources for all projects.
@ -234,9 +234,11 @@ group_snapshot_status_query:
in: query
required: false
type: string
host_7:
host_query:
description: |
The share host name.
The host name of the resource to query with. Querying by hostname is a
privileged operation. If restricted by API policy, this query parameter
may be silently ignored by the server.
in: query
required: false
type: string
@ -265,6 +267,13 @@ message_level:
type: string
description: >
The message level.
metadata_query:
in: query
required: false
type: object
description: |
One or more metadata key and value pairs as a
url encoded dictionary of strings.
name_inexact_query:
description: |
The name pattern that can be used to filter shares,
@ -385,7 +394,7 @@ share_id_replicas_query:
type: string
share_network_id_query:
description: |
The UUID of the share network.
The UUID of the share network to filter resources by.
in: query
required: false
type: string
@ -395,6 +404,12 @@ share_server_id_query:
in: query
required: false
type: string
share_type_id_query:
description: |
The UUID of a share type to query resources by.
in: query
required: false
type: string
share_type_query:
description: |
The share type name or UUID. Allows filtering back end pools based
@ -450,12 +465,12 @@ source_share_group_snapshot_id_query:
required: false
type: string
min_version: 2.31
status_6:
status_query:
description: |
Filters by a share status. A valid value is
``creating``, ``error``, ``available``, ``deleting``,
``error_deleting``, ``manage_starting``, ``manage_error``,
``unmanage_starting``, ``unmanage_error``, ``unmanaged``,
``unmanage_starting``, ``unmanage_error``, ``migrating``,
``extending``, ``extending_error``, ``shrinking``,
``shrinking_error``, or ``shrinking_possible_data_loss_error``.
in: query
@ -469,7 +484,7 @@ user_id_query:
in: query
required: false
type: string
with_count:
with_count_query:
description: |
Whether to show ``count`` in API response or not, default is ``False``.
in: query

4
api-ref/source/security-services.inc
View File

@ -62,7 +62,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
Response parameters
-------------------
@ -107,7 +107,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
Response parameters
-------------------

4
api-ref/source/share-group-snapshots.inc
View File

@ -49,7 +49,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name: name_query
- description: description_query
- status: group_snapshot_status_query
@ -102,7 +102,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name: name_query
- description: description_query
- status: group_snapshot_status_query

2
api-ref/source/share-groups.inc
View File

@ -51,7 +51,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name: name_query
- description: description_query
- status: share_group_status_query

4
api-ref/source/share-networks.inc
View File

@ -59,7 +59,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name~: name_inexact_query
- description~: description_inexact_query
@ -105,7 +105,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name~: name_inexact_query
- description~: description_inexact_query

58
api-ref/source/shares.inc
View File

@ -110,28 +110,28 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- name: name_request
- status: status_6
- share_server_id: share_server_id
- metadata: metadata
- extra_specs: extra_specs
- share_type_id: share_type_id
- limit: limit
- offset: offset
- sort_key: sort_key
- sort_dir: sort_dir
- all_tenants: all_tenants_query
- name: name_query
- status: status_query
- share_server_id: share_server_id_query
- metadata: metadata_query
- extra_specs: extra_specs_query
- share_type_id: share_type_id_query
- snapshot_id: snapshot_id_query
- host: host_1
- share_network_id: share_network_id
- project_id: project_id
- is_public: is_public
- host: host_query
- share_network_id: share_network_id_query
- project_id: project_id_query
- is_public: is_public_query
- share_group_id: share_group_id_query
- export_location_id: export_location_id_query
- export_location_path: export_location_path_query
- name~: name_inexact_query
- description~: description_inexact_query
- with_count: with_count
- with_count: with_count_query
- limit: limit
- offset: offset
- sort_key: sort_key
- sort_dir: sort_dir
Response parameters
-------------------
@ -178,20 +178,16 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- status: status_6
- share_server_id: share_server_id
- metadata: metadata
- extra_specs: extra_specs
- share_type_id: share_type_id
- limit: limit
- offset: offset
- sort_key: sort_key
- sort_dir: sort_dir
- all_tenants: all_tenants_query
- status: status_query
- share_server_id: share_server_id_query
- metadata: metadata_query
- extra_specs: extra_specs_query
- share_type_id: share_type_id_query
- name: name_query
- snapshot_id: snapshot_id_query
- host: host_1
- share_network_id: share_network_id
- host: host_query
- share_network_id: share_network_id_query
- project_id: project_id_query
- is_public: is_public_query
- share_group_id: share_group_id_query
@ -199,7 +195,11 @@ Request
- export_location_path: export_location_path_query
- name~: name_inexact_query
- description~: description_inexact_query
- with_count: with_count
- with_count: with_count_query
- limit: limit
- offset: offset
- sort_key: sort_key
- sort_dir: sort_dir
Response parameters
-------------------

4
api-ref/source/snapshots.inc
View File

@ -68,7 +68,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name~: name_inexact_query
- description~: description_inexact_query
@ -112,7 +112,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- all_tenants: all_tenants
- all_tenants: all_tenants_query
- name~: name_inexact_query
- description~: description_inexact_query