Add sort and pagination parameters for karbor api-def doc

Change-Id: If523e913aea8bc2e2f51ca05503a8a95aad8aaad
This commit is contained in:
chenying 2016-12-07 21:35:51 +08:00
parent 0bbea03760
commit 03d7a18210
8 changed files with 48 additions and 0 deletions

View File

@ -58,6 +58,9 @@ Request
- tenant_id: tenant_id
- provider_id: provider_id_1
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -48,6 +48,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -35,6 +35,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -35,6 +35,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -50,6 +50,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -40,6 +40,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -37,6 +37,9 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- sort: sort
- limit: limit
- marker: marker
Response
--------

View File

@ -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