Merge "resource list filtering api-ref update"

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

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

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