api-ref: document sorting for resource management

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 resource management endpoints, including flavor, service_profile,
metering label and metering label rule.

Partial-Bug: #1749024
Change-Id: I2acf7fd11acd25b94cdeaf185a2be4ef5d51916a
This commit is contained in:
Hongbin Lu
2018-04-16 17:50:16 +00:00
parent d6cb64165c
commit 341f8a18c9
3 changed files with 63 additions and 0 deletions

View File

@@ -42,6 +42,8 @@ Request
.. rest_parameters:: parameters.yaml
- sort_dir: sort_dir
- sort_key: flavor-sort_key
- fields: fields
Response Parameters
@@ -339,6 +341,11 @@ Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- sort_dir: sort_dir
- sort_key: service_profile-sort_key
Response Parameters
-------------------

View File

@@ -31,6 +31,8 @@ Request
.. rest_parameters:: parameters.yaml
- sort_dir: sort_dir
- sort_key: metering_label-sort_key
- fields: fields
Response Parameters
@@ -196,6 +198,8 @@ Request
.. rest_parameters:: parameters.yaml
- sort_dir: sort_dir
- sort_key: metering_label_rule-sort_key
- fields: fields
Response Parameters

View File

@@ -415,6 +415,19 @@ fixed_ips-query:
in: query
required: false
type: array
flavor-sort_key:
description: |
Sorts by a flavor attribute. You can specify multiple pairs of sort key
and sort direction query parameters. The sort keys are limited to:
- ``description``
- ``enabled``
- ``id``
- ``name``
- ``service_type``
in: query
required: false
type: string
floating_ip_address-query:
description: |
Filter the floating IP list result by the floating IP address.
@@ -546,6 +559,32 @@ max_prefixlen-query:
in: query
required: false
type: integer
metering_label-sort_key:
description: |
Sorts by a metering label attribute. You can specify multiple pairs of
sort key and sort direction query parameters. The sort keys are limited to:
- ``id``
- ``shared``
- ``name``
- ``description``
- ``tenant_id``
in: query
required: false
type: string
metering_label_rule-sort_key:
description: |
Sorts by a metering label attribute. You can specify multiple pairs of
sort key and sort direction query parameters. The sort keys are limited to:
- ``id``
- ``metering_label_id``
- ``excluded``
- ``remote_ip_prefix``
- ``direction``
in: query
required: false
type: string
min_kbps-query:
description: |
Filter the list result by the minimum KBPS (kilobits per second) value
@@ -890,6 +929,19 @@ segment-sort_key:
in: query
required: false
type: string
service_profile-sort_key:
description: |
Sorts by a service profile attribute. You can specify multiple pairs of
sort key and sort direction query parameters. The sort keys are limited to:
- ``description``
- ``driver``
- ``enabled``
- ``id``
- ``metainfo``
in: query
required: false
type: string
shared-query:
description: |
Admin-only. Filter the list result based on whether the resource is