api-ref: add filter parameters to resource management

Change-Id: I035d4faf9fe867dfcc90b47e22e8f54976a4da35
Partial-Bug: #1747995
This commit is contained in:
Hongbin Lu 2018-05-01 19:59:15 +00:00
parent 34b984ef84
commit b8be5da69d
3 changed files with 76 additions and 0 deletions

View File

@ -42,6 +42,11 @@ Request
.. rest_parameters:: parameters.yaml
- id: id-query
- service_type: flavor-service_type-query
- name: name-query
- description: description-query
- enabled: flavor-enabled-query
- sort_dir: sort_dir
- sort_key: flavor-sort_key
- fields: fields
@ -343,6 +348,10 @@ Request
.. rest_parameters:: parameters.yaml
- id: id-query
- enabled: service_profile-enabled-query
- driver: service_profile-driver-query
- description: description-query
- sort_dir: sort_dir
- sort_key: service_profile-sort_key

View File

@ -31,6 +31,12 @@ Request
.. rest_parameters:: parameters.yaml
- description: description-query
- tenant_id: project_id-query
- project_id: project_id-query
- shared: shared-query
- id: id-query
- name: name-query
- sort_dir: sort_dir
- sort_key: metering_label-sort_key
- fields: fields
@ -198,6 +204,11 @@ Request
.. rest_parameters:: parameters.yaml
- direction: metering_label_rule-direction-query
- remote_ip_prefix: metering_label_rule-remote_ip_prefix-query
- excluded : excluded-query
- metering_label_id: metering_label-id-query
- id: id-query
- sort_dir: sort_dir
- sort_key: metering_label_rule-sort_key
- fields: fields

View File

@ -393,6 +393,14 @@ ethertype-query:
in: query
required: false
type: string
excluded-query:
description: |
Filter the metering rule list result based on whether the metering
rule exclude the traffic of a specific IP address with the
``remote_ip_prefix`` value.
in: query
required: false
type: boolean
fields:
description: |
The fields that you want the server to return.
@ -415,6 +423,19 @@ fixed_ips-query:
in: query
required: false
type: array
flavor-enabled-query:
description: |
Filter the flavor list result based on whether the flavor is enabled or
not.
in: query
required: false
type: boolean
flavor-service_type-query:
description: |
Filter the flavor list result by the type of the flavor.
in: query
required: false
type: string
flavor-sort_key:
description: |
Sorts by a flavor attribute. You can specify multiple pairs of sort key
@ -559,6 +580,13 @@ max_prefixlen-query:
in: query
required: false
type: integer
metering_label-id-query:
description: |
Filter the metering rule list result by the ID of the metering label
associated with this metering rule.
in: query
required: false
type: string
metering_label-sort_key:
description: |
Sorts by a metering label attribute. You can specify multiple pairs of
@ -572,6 +600,20 @@ metering_label-sort_key:
in: query
required: false
type: string
metering_label_rule-direction-query:
description: |
Filter the metering rule list result by the direction in
which the metering rule is applied, which is ``ingress`` or ``egress``.
in: query
required: false
type: string
metering_label_rule-remote_ip_prefix-query:
description: |
Filter the metering rule list result by the remote IP prefix that
the metering rule associates with.
in: query
required: false
type: string
metering_label_rule-sort_key:
description: |
Sorts by a metering label attribute. You can specify multiple pairs of
@ -958,6 +1000,20 @@ segment-sort_key:
in: query
required: false
type: string
service_profile-driver-query:
description: |
Filter the service profile list result by the driver that this profile
uses.
in: query
required: false
type: string
service_profile-enabled-query:
description: |
Filter the service profile list result based on whether this service
profile is enabled or not.
in: query
required: false
type: boolean
service_profile-sort_key:
description: |
Sorts by a service profile attribute. You can specify multiple pairs of