diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index cb37848658a..613ab4f7bfb 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -161,6 +161,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker @@ -216,6 +218,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index 799491fdd4b..f8690bbde33 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -38,7 +38,10 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit + - offset: offset - marker: marker @@ -248,7 +251,10 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit + - offset: offset - marker: marker diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index 74a56af14f8..f765a443ca6 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -65,6 +65,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker @@ -405,7 +407,10 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit + - offset: offset - marker: marker - with_count: with_count diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 9a769d7f164..b49b99cefec 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -116,6 +116,7 @@ Request - project_id: project_id_path - all_tenants: all-tenants + - sort: sort_group_snapshot - sort_key: sort_key_group_snapshot - sort_dir: sort_dir_group_snapshot - limit: limit_group_snapshot @@ -172,6 +173,7 @@ Request - project_id: project_id_path - all_tenants: all-tenants + - sort: sort_group_snapshot - sort_key: sort_key_group_snapshot - sort_dir: sort_dir_group_snapshot - limit: limit_group_snapshot diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc index b94279ef3b0..d9bac20ba52 100644 --- a/api-ref/source/v3/group-types.inc +++ b/api-ref/source/v3/group-types.inc @@ -213,6 +213,8 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index 910f2751b69..0cbc752def4 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -45,6 +45,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker @@ -294,6 +296,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker diff --git a/api-ref/source/v3/messages.inc b/api-ref/source/v3/messages.inc index 7741f80a81d..1a138c270b1 100644 --- a/api-ref/source/v3/messages.inc +++ b/api-ref/source/v3/messages.inc @@ -119,6 +119,8 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 45271d7a93f..2468906e9fb 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -468,8 +468,8 @@ service_binary_query: sort: description: | Comma-separated list of sort keys and optional - sort directions in the form of < key > [: < direction > ]. A valid - direction is ``asc`` (ascending) or ``desc`` (descending). + sort directions in the form of ``< key > [: < direction > ]``. + A valid direction is ``asc`` (ascending) or ``desc`` (descending). in: query required: false type: string @@ -478,6 +478,7 @@ sort_dir: Sorts by one or more sets of attribute and sort direction combinations. If you omit the sort direction in a set, default is ``desc``. + Deprecated in favour of the combined ``sort`` parameter. in: query required: false type: string @@ -486,6 +487,7 @@ sort_dir_group_snapshot: Sorts by one or more sets of attribute and sort direction combinations. If you omit the sort direction in a set, default is ``desc``. + Deprecated in favour of the combined ``sort`` parameter. in: query required: false type: string @@ -495,10 +497,20 @@ sort_dir_transfer: Sorts by one or more sets of attribute and sort direction combinations. If you omit the sort direction in a set, default is ``desc``. + Deprecated in favour of the combined ``sort`` parameter. in: query required: false type: string min_version: 3.59 +sort_group_snapshot: + description: | + Comma-separated list of sort keys and optional + sort directions in the form of ``< key > [: < direction > ]``. + A valid direction is ``asc`` (ascending) or ``desc`` (descending). + in: query + required: false + type: string + min_version: 3.29 sort_key: description: | Sorts by an attribute. A valid value is ``name``, @@ -506,6 +518,7 @@ sort_key: ``id``, ``created_at``, or ``updated_at``. Default is ``created_at``. The API uses the natural sorting direction of the ``sort_key`` attribute value. + Deprecated in favour of the combined ``sort`` parameter. in: query required: false type: string @@ -516,6 +529,7 @@ sort_key_group_snapshot: ``id``, ``created_at``, or ``updated_at``. Default is ``created_at``. The API uses the natural sorting direction of the ``sort_key`` attribute value. + Deprecated in favour of the combined ``sort`` parameter. in: query required: false type: string @@ -525,6 +539,16 @@ sort_key_transfer: Sorts by an attribute. Default is ``created_at``. The API uses the natural sorting direction of the ``sort_key`` attribute value. + Deprecated in favour of the combined ``sort`` parameter. + in: query + required: false + type: string + min_version: 3.59 +sort_transfer: + description: | + Comma-separated list of sort keys and optional + sort directions in the form of ``< key > [: < direction > ]``. + A valid direction is ``asc`` (ascending) or ``desc`` (descending). in: query required: false type: string diff --git a/api-ref/source/v3/qos-specs-v3-qos-specs.inc b/api-ref/source/v3/qos-specs-v3-qos-specs.inc index a9df2a3fd9b..03cb1cf45ad 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -365,7 +365,10 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit + - offset: offset - marker: marker diff --git a/api-ref/source/v3/snapshot-manage.inc b/api-ref/source/v3/snapshot-manage.inc index 6d54edbfa13..f6ef4a1c6bc 100644 --- a/api-ref/source/v3/snapshot-manage.inc +++ b/api-ref/source/v3/snapshot-manage.inc @@ -99,6 +99,8 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - offset: offset - limit: limit - marker: marker @@ -150,6 +152,8 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - offset: offset - limit: limit - marker: marker diff --git a/api-ref/source/v3/vol-transfer-v3.inc b/api-ref/source/v3/vol-transfer-v3.inc index 89c353c6fa5..a8b67b58e1b 100644 --- a/api-ref/source/v3/vol-transfer-v3.inc +++ b/api-ref/source/v3/vol-transfer-v3.inc @@ -148,11 +148,12 @@ Request - project_id: project_id_path - all_tenants: all-tenants + - sort: sort_transfer + - sort_key: sort_key_transfer + - sort_dir: sort_dir_transfer - limit: limit_transfer - offset: offset_transfer - marker: marker_transfer - - sort_key: sort_key_transfer - - sort_dir: sort_dir_transfer Response Parameters diff --git a/api-ref/source/v3/volume-manage.inc b/api-ref/source/v3/volume-manage.inc index cd03eaccae3..43df591a227 100644 --- a/api-ref/source/v3/volume-manage.inc +++ b/api-ref/source/v3/volume-manage.inc @@ -123,6 +123,8 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - offset: offset - limit: limit - marker: marker @@ -172,6 +174,8 @@ Request - project_id: project_id_path - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - offset: offset - limit: limit - marker: marker diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index cede89a4210..19ff5c79e23 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -63,6 +63,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker @@ -195,6 +197,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc index b118c2f7f70..44013ae1b09 100644 --- a/api-ref/source/v3/volumes-v3-types.inc +++ b/api-ref/source/v3/volumes-v3-types.inc @@ -440,6 +440,8 @@ Request - project_id: project_id_path - is_public: is_public_volume_type_query - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 99d11684089..a5546e1ba5a 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -92,6 +92,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker @@ -308,6 +310,8 @@ Request - project_id: project_id_path - all_tenants: all-tenants - sort: sort + - sort_key: sort_key + - sort_dir: sort_dir - limit: limit - offset: offset - marker: marker