api-ref: document sorting parameters for security
API users can use the 'sort_key' and 'sort_dir' to do the sorting on list result. This patch add documentation of these two parameters for l2 networking resources, including rbac policy, security group and security group rule. Change-Id: I985734e7f7bed56aabd8420f46dec2aa25958e02 Partial-Bug: #1749024
This commit is contained in:
parent
98d261468c
commit
43405bff26
|
@ -671,6 +671,19 @@ qos_is_default-query:
|
|||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
rbac-sort_key:
|
||||
description: |
|
||||
Sorts by a RBAC policy attribute. You can specify multiple pairs of sort
|
||||
key and sort direction query parameters. The sort keys are limited to:
|
||||
|
||||
- ``action``
|
||||
- ``id``
|
||||
- ``object_id``
|
||||
- ``target_tenant``
|
||||
- ``tenant_id``
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
remote_group_id-query:
|
||||
description: |
|
||||
Filter the security group rule list result by the ID of the remote group
|
||||
|
@ -710,6 +723,17 @@ router:external-query:
|
|||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
security_group-sort_key:
|
||||
description: |
|
||||
Sorts by a security group attribute. You can specify multiple pairs of
|
||||
sort key and sort direction query parameters. The sort keys are limited to:
|
||||
|
||||
- ``id``
|
||||
- ``name``
|
||||
- ``tenant_id``
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
security_group_rule-security_group_id-query:
|
||||
description: |
|
||||
Filter the security group rule list result by the ID of the security group
|
||||
|
@ -717,6 +741,24 @@ security_group_rule-security_group_id-query:
|
|||
in: query
|
||||
required: false
|
||||
type: string
|
||||
security_group_rule-sort_key:
|
||||
description: |
|
||||
Sorts by a security group rule attribute. You can specify multiple pairs of
|
||||
sort key and sort direction query parameters. The sort keys are limited to:
|
||||
|
||||
- ``direction``
|
||||
- ``ethertype``
|
||||
- ``id``
|
||||
- ``port_range_max``
|
||||
- ``port_range_min``
|
||||
- ``protocol``
|
||||
- ``remote_group_id```
|
||||
- ``remote_ip_prefix``
|
||||
- ``security_group_id``
|
||||
- ``tenant_id``
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
shared-query:
|
||||
description: |
|
||||
Admin-only. Filter the list result based on whether the resource is
|
||||
|
|
|
@ -137,6 +137,8 @@ Request
|
|||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: rbac-sort_key
|
||||
- fields: fields
|
||||
|
||||
Response Parameters
|
||||
|
|
|
@ -45,6 +45,8 @@ Request
|
|||
- revision_number: revision_number-query
|
||||
- id: id-query
|
||||
- description: description-query
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: security_group_rule-sort_key
|
||||
- fields: fields
|
||||
|
||||
Response Parameters
|
||||
|
|
|
@ -38,6 +38,8 @@ Request
|
|||
- revision_number: revision_number-query
|
||||
- name: name-query
|
||||
- description: description-query
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: security_group-sort_key
|
||||
- tags: tags-query
|
||||
- tags-any: tags-any-query
|
||||
- not-tags: not-tags-query
|
||||
|
|
Loading…
Reference in New Issue