[api-ref] Fix missing parameters in share network list

Share network list API referece was missing some filter parametes.
Add the missing parameters so users can be aware of all the options
available to query share networks.

Closes-Bug: #1945711
Change-Id: I21b4f48d0c41f052aca1d7dcd0f1b640cfa3084a
This commit is contained in:
silvacarloss 2021-10-01 16:05:35 -03:00
parent c09a5f08c4
commit b82175f30d
2 changed files with 89 additions and 0 deletions

View File

@ -201,6 +201,12 @@ backend_query:
in: query
required: false
type: string
cidr_query:
description: |
The CIDR to filter share networks.
in: query
required: false
type: string
created_before:
description: |
The date and time stamp when the query operation, only return user
@ -221,6 +227,13 @@ created_before:
required: false
type: string
min_version: 2.52
created_before_query:
description: |
Search for the list of resources that were created prior to the specified
date. The date is in 'yyyy-mm-dd' format.
in: query
required: false
type: string
created_since:
description: |
The date and time stamp when the query operation, only return user
@ -241,6 +254,13 @@ created_since:
required: false
type: string
min_version: 2.52
created_since_query:
description: |
Search for the list of resources that were created after the specified
date. The date is in 'yyyy-mm-dd' format.
in: query
required: false
type: string
description_inexact_query:
description: |
The description pattern that can be used to filter shares,
@ -306,6 +326,12 @@ host_query:
in: query
required: false
type: string
ip_version_query:
description: |
The IP version to filter share networks.
in: query
required: false
type: string
is_public_query:
description: |
A boolean query parameter that, when set to true, allows retrieving
@ -352,6 +378,31 @@ name_query:
in: query
required: false
type: string
network_type_query:
description: |
The network type to filter out share networks.
in: query
required: false
type: string
neutron_net_id_query:
description: |
The neutron network id to filter out share networks.
in: query
required: false
type: string
neutron_subnet_id_query:
description: |
The neutron network subnet id to filter out share networks.
in: query
required: false
type: string
nova_net_id_query:
description: |
The ID of a Nova network to filter out share networks.
in: query
required: false
type: string
max_version: 2.26
offset:
description: |
The offset to define start point of share or share group
@ -390,6 +441,18 @@ resource_type:
in: query
required: false
type: string
security_service_query:
description: |
The security service ID to filter out share networks.
in: query
required: false
type: string
segmentation_id_query:
description: |
The segmentation id to filter out share networks.
in: query
required: false
type: string
service_binary_query:
description: |
The service binary name. Default is the base name

View File

@ -70,6 +70,20 @@ Request
- all_tenants: all_tenants_query
- name~: name_inexact_query
- description~: description_inexact_query
- name: name_query
- description: description_query
- created_since: created_since_query
- created_before: created_before_query
- security_service_id: security_service_query
- nova_net_id: nova_net_id_query
- neutron_net_id: neutron_net_id_query
- neutron_subnet_id: neutron_subnet_id_query
- network_type: network_type_query
- segmentation_id: segmentation_id_query
- cidr: cidr_query
- ip_version: ip_version_query
- offset: offset
- limit: limit
Response parameters
-------------------
@ -116,6 +130,18 @@ Request
- all_tenants: all_tenants_query
- name~: name_inexact_query
- description~: description_inexact_query
- created_since: created_since_query
- created_before: created_before_query
- nova_net_id: nova_net_id_query
- neutron_net_id: neutron_net_id_query
- neutron_subnet_id: neutron_subnet_id_query
- network_type: network_type_query
- segmentation_id: segmentation_id_query
- cidr: cidr_query
- ip_version: ip_version_query
- offset: offset
- limit: limit
- security_service_id: security_service_query
Response parameters
-------------------