From ad97123c202d395b165b1f43ea76fe923a8b3c5a Mon Sep 17 00:00:00 2001
From: Kanagaraj Manickam <mkr1481@gmail.com>
Date: Mon, 23 May 2016 15:53:28 +0530
Subject: [PATCH] resource list filtering api-ref update

api-ref resource  list is updated to detail
on the filtering supported.

As part of this change, event list related
filtering parameters updated to leverage them
in resource filtering.

Change-Id: I61fc302219cc875e23ee1f2d57394196f64c8e63
---
 api-ref/source/v1/parameters.yaml     | 16 +++++-----------
 api-ref/source/v1/stack-events.inc    |  3 ++-
 api-ref/source/v1/stack-resources.inc | 10 +++++++++-
 3 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml
index 9f8b42c1d9..5b44d078f4 100644
--- a/api-ref/source/v1/parameters.yaml
+++ b/api-ref/source/v1/parameters.yaml
@@ -163,9 +163,7 @@ owner_id:
   type: string
 resource_action:
   description: |
-    Filters the event list by a resource action. You
-    can use this filter multiple times to filter by multiple resource
-    actions. Valid resource actions are ``ADOPT``, ``CHECK``,
+    Stack resource action. Valid resource actions are ``ADOPT``, ``CHECK``,
     ``CREATE``, ``DELETE``, ``INIT``, ``RESTORE``, ``RESUME``,
     ``ROLLBACK``, ``SNAPSHOT``, ``SUSPEND``, and ``UPDATE``.
   in: query
@@ -181,19 +179,15 @@ resource_name_2:
   type: string
 resource_status:
   description: |
-    Filters the event list by a resource status. You
-    can use this filter multiple times to filter by multiple resource
-    statuses. Valid resource statuses are ``COMPLETE``, ``FAILED``,
-    and ``IN_PROGRESS``.
+    Stack resource status. Valid resource statuses are ``COMPLETE``,
+    ``FAILED`` and ``IN_PROGRESS``.
   in: query
   required: false
   type: string
 resource_type:
   description: |
-    Filters the event list by a resource type. You
-    can use this filter multiple times to filter by multiple resource
-    types. Valid resource types include ``OS::Cinder::Volume``,
-    ``OS::Nova::Server``, ``OS::Neutron::Port``, and so on.
+    Stack resource type. Valid resource types include ``OS::Cinder::Volume``,
+    ``OS::Nova::Server``, ``OS::Neutron::Port`` and so on.
   in: query
   required: false
   type: string
diff --git a/api-ref/source/v1/stack-events.inc b/api-ref/source/v1/stack-events.inc
index f51f31a0b2..ca01f8a0dc 100644
--- a/api-ref/source/v1/stack-events.inc
+++ b/api-ref/source/v1/stack-events.inc
@@ -70,7 +70,8 @@ List stack events
 
 .. rest_method::  GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/events
 
-Lists events for a stack.
+Lists events for a stack based on filtering parameters like resource
+name, status, type, action. These parameters could be used multiple times.
 
 
 Normal response codes: 200
diff --git a/api-ref/source/v1/stack-resources.inc b/api-ref/source/v1/stack-resources.inc
index 3806f15531..f0216476e0 100644
--- a/api-ref/source/v1/stack-resources.inc
+++ b/api-ref/source/v1/stack-resources.inc
@@ -100,7 +100,9 @@ List resources
 
 .. rest_method::  GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources
 
-Lists resources in a stack.
+Lists resources in a stack based on filtering parameters like resource
+name, status, type, action, id and physical_resource_id. These parameters could
+be used multiple times.
 
 
 Normal response codes: 200
@@ -117,6 +119,12 @@ Request
    - stack_id: stack_id
    - nested_depth: nested_depth
    - with_detail: with_detail
+   - name: resource_name
+   - status: resource_status
+   - type: resource_type
+   - action: resource_action
+   - id: logical_resource_id
+   - physical_resource_id: physical_resource_id
 
 
 Response Parameters