From 0059340be0ae3415b619dbb757019181dfe547fa Mon Sep 17 00:00:00 2001
From: TommyLike <tommylikehu@gmail.com>
Date: Mon, 20 Mar 2017 12:37:33 +0800
Subject: [PATCH] [Doc] Add missing parameter in v3 resource documentation

We have introduced a filter, sorter and pagination
in listing APIs. Adding the missing parameters
in api-ref.

Change-Id: Id32fb09ba659e2ba83910d37018de9e18302d5b6
---
 api-ref/source/v3/ext-backups.inc          |  1 +
 api-ref/source/v3/group-snapshots.inc      | 10 ++++++++++
 api-ref/source/v3/group-types.inc          |  1 +
 api-ref/source/v3/groups.inc               |  2 ++
 api-ref/source/v3/parameters.yaml          |  7 +++++++
 api-ref/source/v3/volumes-v3-snapshots.inc |  6 ++++++
 api-ref/source/v3/volumes-v3-types.inc     |  1 +
 api-ref/source/v3/volumes-v3-volumes.inc   |  8 ++++++--
 8 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc
index fb9b0910d53..78da6a2d312 100644
--- a/api-ref/source/v3/ext-backups.inc
+++ b/api-ref/source/v3/ext-backups.inc
@@ -58,6 +58,7 @@ Request
    - sort_key: sort_key
    - sort_dir: sort_dir
    - limit: limit
+   - offset: offset
    - marker: marker
 
 
diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc
index 3d37f586c88..f471f9abcfc 100644
--- a/api-ref/source/v3/group-snapshots.inc
+++ b/api-ref/source/v3/group-snapshots.inc
@@ -84,6 +84,11 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - project_id: project_id_path
+   - sort_key: sort_key
+   - sort_dir: sort_dir
+   - limit: limit
+   - offset: offset
+   - marker: marker
 
 
 Response Parameters
@@ -122,6 +127,11 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - project_id: project_id_path
+   - sort_key: sort_key
+   - sort_dir: sort_dir
+   - limit: limit
+   - offset: offset
+   - marker: marker
 
 
 Response Parameters
diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc
index d3b79ba8c30..21c3c037c09 100644
--- a/api-ref/source/v3/group-types.inc
+++ b/api-ref/source/v3/group-types.inc
@@ -181,6 +181,7 @@ Request
    - 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 7a9052c605d..89ac5a3bdca 100644
--- a/api-ref/source/v3/groups.inc
+++ b/api-ref/source/v3/groups.inc
@@ -38,6 +38,7 @@ Request
    - sort_key: sort_key
    - sort_dir: sort_dir
    - limit: limit
+   - offset: offset
    - marker: marker
 
 
@@ -202,6 +203,7 @@ Request
    - 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 bc72869e1d4..584516381bd 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -211,6 +211,13 @@ name_volume:
   in: query
   required: false
   type: string
+offset:
+  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
 sort:
   description: |
     Comma-separated list of sort keys and optional
diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc
index e3304f85283..ba9a0c51e8f 100644
--- a/api-ref/source/v3/volumes-v3-snapshots.inc
+++ b/api-ref/source/v3/volumes-v3-snapshots.inc
@@ -44,6 +44,11 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - project_id: project_id_path
+   - sort_key: sort_key
+   - sort_dir: sort_dir
+   - limit: limit
+   - offset: offset
+   - marker: marker
 
 
 Response Parameters
@@ -134,6 +139,7 @@ Request
    - 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 95e40275f40..49f4c3bc84e 100644
--- a/api-ref/source/v3/volumes-v3-types.inc
+++ b/api-ref/source/v3/volumes-v3-types.inc
@@ -192,6 +192,7 @@ Request
    - 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 1ec89b38e2f..dc265ecc18e 100644
--- a/api-ref/source/v3/volumes-v3-volumes.inc
+++ b/api-ref/source/v3/volumes-v3-volumes.inc
@@ -61,8 +61,10 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - project_id: project_id_path
-   - sort: sort
+   - sort_key: sort_key
+   - sort_dir: sort_dir
    - limit: limit
+   - offset: offset
    - marker: marker
 
 
@@ -229,8 +231,10 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - project_id: project_id_path
-   - sort: sort
+   - sort_key: sort_key
+   - sort_dir: sort_dir
    - limit: limit
+   - offset: offset
    - marker: marker