Document filter parameters in API reference

Document filter parameters when listing containers
in API reference

Closes-Bug: #1764003

Change-Id: Ica68dab668b2544ed97f0c92750a80a907a0fb79

api-ref/source/containers.inc

@@ -122,6 +122,21 @@ Response Codes
    - 401
    - 403
 
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - name: name_query
+  - image: image_query
+  - project_id: project_id_query
+  - user_id: user_id_query
+  - memory: memory_query
+  - host: host_query
+  - task_state: task_state_query
+  - status: status_query
+  - auto_remove: auto_remove_query
+
 Response
 --------
 

api-ref/source/parameters.yaml

@@ -23,6 +23,13 @@ request_ident:
   in: path
   required: true
   type: string
+auto_remove_query:
+  description: |
+    Filters the response according to whether they are
+    auto-removed on exiting.
+  in: query
+  required: false
+  type: boolean
 destination_path:
   description: |
     The destination path in a container when putting archive to a container.
@@ -75,6 +82,30 @@ height:
   in: query
   required: true
   type: string
+host_query:
+  description: |
+    Filters the response by a host name, as a string.
+  in: query
+  required: false
+  type: string
+image_query:
+  description: |
+    Filters the response by image.
+  in: query
+  required: false
+  type: string
+memory_query:
+  description: |
+    Filters the response by memory size in Mib.
+  in: query
+  required: false
+  type: integer
+name_query:
+  description: |
+    Filters the response by name.
+  in: query
+  required: false
+  type: string
 network:
   description: |
     The ID or name of the network to be detached from the container.
@@ -102,6 +133,12 @@ port-query:
   in: query
   required: false
   type: string
+project_id_query:
+  description: |
+    Filters the response by the ID of the project.
+  in: query
+  required: false
+  type: string
 ps_args:
   description: |
     The arguments of ps command.
@@ -144,6 +181,12 @@ source_path:
   in: query
   required: true
   type: string
+status_query:
+  description: |
+    Filters the response by the current state of the container.
+  in: query
+  required: false
+  type: string
 stderr:
   description: |
     Get standard error if True.
@@ -174,6 +217,12 @@ tail:
   in: query
   required: false
   type: string
+task_state_query:
+  description: |
+    Filters the response by task state.
+  in: query
+  required: false
+  type: string
 timeout:
   description: |
     Seconds to wait before operating on container.
@@ -186,6 +235,12 @@ timestamps:
   in: query
   required: false
   type: boolean
+user_id_query:
+  description: |
+    Filters the response by user ID.
+  in: query
+  required: false
+  type: string
 width:
   description: |
     The tty width of a container.