Use 'min_version' to mark newly added parameters in DOC
This patch adds or updates the parameters by using 'min_version' for these two patches below: 1. Added sorter, filter and pagination for group snapshot in v3.29 2. Added metadata in volume/summary response in v3.36 Change-Id: I09f6565d45ea2f346a09c8cb45ff24bec6f14acc
This commit is contained in:
parent
30b501f48d
commit
c2db25ad61
@ -85,11 +85,11 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key_group_snapshot
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir_group_snapshot
|
||||||
- limit: limit
|
- limit: limit_group_snapshot
|
||||||
- offset: offset
|
- offset: offset_group_snapshot
|
||||||
- marker: marker
|
- marker: marker_group_snapshot
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -129,11 +129,11 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project_id: project_id_path
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key_group_snapshot
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir_group_snapshot
|
||||||
- limit: limit
|
- limit: limit_group_snapshot
|
||||||
- offset: offset
|
- offset: offset_group_snapshot
|
||||||
- marker: marker
|
- marker: marker_group_snapshot
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
@ -219,6 +219,28 @@ limit:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
|
limit_group_snapshot:
|
||||||
|
description: |
|
||||||
|
Requests a page size of items. Returns a number
|
||||||
|
of items up to a limit value. Use the ``limit`` parameter to make
|
||||||
|
an initial limited request and use the ID of the last-seen item
|
||||||
|
from the response as the ``marker`` parameter value in a
|
||||||
|
subsequent limited request.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: integer
|
||||||
|
min_version: 3.29
|
||||||
|
limit_group_snapshot:
|
||||||
|
description: |
|
||||||
|
Requests a page size of items. Returns a number
|
||||||
|
of items up to a limit value. Use the ``limit`` parameter to make
|
||||||
|
an initial limited request and use the ID of the last-seen item
|
||||||
|
from the response as the ``marker`` parameter value in a
|
||||||
|
subsequent limited request.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: integer
|
||||||
|
min_version: 3.29
|
||||||
marker:
|
marker:
|
||||||
description: |
|
description: |
|
||||||
The ID of the last-seen item. Use the ``limit``
|
The ID of the last-seen item. Use the ``limit``
|
||||||
@ -228,6 +250,16 @@ marker:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
marker_group_snapshot:
|
||||||
|
description: |
|
||||||
|
The ID of the last-seen item. Use the ``limit``
|
||||||
|
parameter to make an initial limited request and use the ID of the
|
||||||
|
last-seen item from the response as the ``marker`` parameter value
|
||||||
|
in a subsequent limited request.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
min_version: 3.29
|
||||||
message_id:
|
message_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the message.
|
The UUID of the message.
|
||||||
@ -261,6 +293,14 @@ offset:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
|
offset_group_snapshot:
|
||||||
|
description: |
|
||||||
|
Used in conjunction with ``limit`` to return a slice of items. ``offset``
|
||||||
|
is where to start in the list.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: integer
|
||||||
|
min_version: 3.29
|
||||||
sort:
|
sort:
|
||||||
description: |
|
description: |
|
||||||
Comma-separated list of sort keys and optional
|
Comma-separated list of sort keys and optional
|
||||||
@ -277,6 +317,15 @@ sort_dir:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
sort_dir_group_snapshot:
|
||||||
|
description: |
|
||||||
|
Sorts by one or more sets of attribute and sort
|
||||||
|
direction combinations. If you omit the sort direction in a set,
|
||||||
|
default is ``desc``.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
min_version: 3.29
|
||||||
sort_key:
|
sort_key:
|
||||||
description: |
|
description: |
|
||||||
Sorts by an attribute. A valid value is ``name``,
|
Sorts by an attribute. A valid value is ``name``,
|
||||||
@ -297,6 +346,17 @@ sort_key_1:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
sort_key_group_snapshot:
|
||||||
|
description: |
|
||||||
|
Sorts by an attribute. A valid value is ``name``,
|
||||||
|
``status``, ``group_id``, ``group_type_id``, ``size``,
|
||||||
|
``id``, ``created_at``, or ``updated_at``. Default is
|
||||||
|
``created_at``. The API uses the natural sorting direction of the
|
||||||
|
``sort_key`` attribute value.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
min_version: 3.29
|
||||||
status_query:
|
status_query:
|
||||||
description: |
|
description: |
|
||||||
Filters results by a status. Default=None.
|
Filters results by a status. Default=None.
|
||||||
@ -1940,6 +2000,14 @@ storage_protocol_1:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
summary_metadata:
|
||||||
|
description: |
|
||||||
|
The dictionary of lists contains all the volumes' metadata,
|
||||||
|
classified by metadata key.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
|
min_version: 3.36
|
||||||
total_capacity:
|
total_capacity:
|
||||||
description: |
|
description: |
|
||||||
The total capacity for the back-end volume, in
|
The total capacity for the back-end volume, in
|
||||||
|
@ -1,6 +1,10 @@
|
|||||||
{
|
{
|
||||||
"volume-summary": {
|
"volume-summary": {
|
||||||
"total_size": 4,
|
"total_size": 4,
|
||||||
"total_count": 4
|
"total_count": 4,
|
||||||
|
"metadata": {
|
||||||
|
"key1": ["value1", "value2"],
|
||||||
|
"key2": ["value2"]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
@ -723,6 +723,7 @@ Response Parameters
|
|||||||
- volume-summary: volume-summary
|
- volume-summary: volume-summary
|
||||||
- total_size: total_size
|
- total_size: total_size
|
||||||
- total_count: total_count
|
- total_count: total_count
|
||||||
|
- metadata: summary_metadata
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
|
Loading…
Reference in New Issue
Block a user