From 03d7a182105b8706d27948b1d950686ff4066e53 Mon Sep 17 00:00:00 2001 From: chenying Date: Wed, 7 Dec 2016 21:35:51 +0800 Subject: [PATCH] Add sort and pagination parameters for karbor api-def doc Change-Id: If523e913aea8bc2e2f51ca05503a8a95aad8aaad --- api-ref/source/v1/karbor-v1-checkpoints.inc | 3 +++ api-ref/source/v1/karbor-v1-plans.inc | 3 +++ api-ref/source/v1/karbor-v1-protectables.inc | 3 +++ api-ref/source/v1/karbor-v1-providers.inc | 3 +++ api-ref/source/v1/karbor-v1-restores.inc | 3 +++ .../v1/karbor-v1-scheduled-operations.inc | 3 +++ api-ref/source/v1/karbor-v1-triggers.inc | 3 +++ api-ref/source/v1/parameters.yaml | 27 +++++++++++++++++++ 8 files changed, 48 insertions(+) diff --git a/api-ref/source/v1/karbor-v1-checkpoints.inc b/api-ref/source/v1/karbor-v1-checkpoints.inc index 52adc3aa..25ffcf11 100644 --- a/api-ref/source/v1/karbor-v1-checkpoints.inc +++ b/api-ref/source/v1/karbor-v1-checkpoints.inc @@ -58,6 +58,9 @@ Request - tenant_id: tenant_id - provider_id: provider_id_1 + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/karbor-v1-plans.inc b/api-ref/source/v1/karbor-v1-plans.inc index 41444373..a0e9e823 100644 --- a/api-ref/source/v1/karbor-v1-plans.inc +++ b/api-ref/source/v1/karbor-v1-plans.inc @@ -48,6 +48,9 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/karbor-v1-protectables.inc b/api-ref/source/v1/karbor-v1-protectables.inc index 4de1e53b..be68b99a 100644 --- a/api-ref/source/v1/karbor-v1-protectables.inc +++ b/api-ref/source/v1/karbor-v1-protectables.inc @@ -35,6 +35,9 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/karbor-v1-providers.inc b/api-ref/source/v1/karbor-v1-providers.inc index e5c838d8..a7ccbd71 100644 --- a/api-ref/source/v1/karbor-v1-providers.inc +++ b/api-ref/source/v1/karbor-v1-providers.inc @@ -35,6 +35,9 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/karbor-v1-restores.inc b/api-ref/source/v1/karbor-v1-restores.inc index b6618d3a..669b94b2 100644 --- a/api-ref/source/v1/karbor-v1-restores.inc +++ b/api-ref/source/v1/karbor-v1-restores.inc @@ -50,6 +50,9 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/karbor-v1-scheduled-operations.inc b/api-ref/source/v1/karbor-v1-scheduled-operations.inc index 746461d1..6d546b7c 100644 --- a/api-ref/source/v1/karbor-v1-scheduled-operations.inc +++ b/api-ref/source/v1/karbor-v1-scheduled-operations.inc @@ -40,6 +40,9 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/karbor-v1-triggers.inc b/api-ref/source/v1/karbor-v1-triggers.inc index f193a299..a878f5af 100644 --- a/api-ref/source/v1/karbor-v1-triggers.inc +++ b/api-ref/source/v1/karbor-v1-triggers.inc @@ -37,6 +37,9 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id + - sort: sort + - limit: limit + - marker: marker Response -------- diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index 01139557..71f9e0c9 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -59,6 +59,33 @@ trigger_id_1: # variables in query +limit: + 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 +marker: + 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 +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). + in: query + required: false + type: string # variables in body