From 06fe7a9c5b986bc5f48a5dc657ace1f20b171277 Mon Sep 17 00:00:00 2001
From: Hongbin Lu <hongbin.lu@huawei.com>
Date: Tue, 1 May 2018 22:53:01 +0000
Subject: [PATCH] api-ref: add filter parameters to agents

Change-Id: I776afb36d475617a80c0006c84374a16e3c98811
Closes-Bug: #1747995
---
 api-ref/source/v2/agents.inc      |  8 ++++++++
 api-ref/source/v2/parameters.yaml | 34 +++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/api-ref/source/v2/agents.inc b/api-ref/source/v2/agents.inc
index 2bec2b194..8486d1b9d 100644
--- a/api-ref/source/v2/agents.inc
+++ b/api-ref/source/v2/agents.inc
@@ -28,6 +28,14 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
+   - admin_state_up: admin_state_up-query
+   - agent_type: agent_type-query
+   - alive: alive-query
+   - binary: binary-query
+   - description: description-query
+   - host: host-query
+   - id: id-query
+   - topic: topic-query
    - fields: fields
 
 Response Parameters
diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml
index 4b72d37db..abd557ba9 100644
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@@ -325,6 +325,26 @@ admin_state_up_trunk-query:
   in: query
   required: false
   type: boolean
+agent_type-query:
+  description: |
+    Filter the list result by the type of agent such as ``Open vSwitch agent``
+    or ``DHCP agent``.
+  in: query
+  required: false
+  type: string
+alive-query:
+  description: |
+    Filter the list result based on whether the agent is alive and running.
+  in: query
+  required: false
+  type: boolean
+binary-query:
+  description: |
+    Filter the list result by the executable command used to start the agent
+    such as ``neutron-openvswitch-agent`` or ``neutron-dhcp-agent``.
+  in: query
+  required: false
+  type: string
 binding:host_id-query:
   description: |
     Filter the port list result by the ID of the host where the port resides.
@@ -505,6 +525,13 @@ floatingip-status-query:
   in: query
   required: false
   type: string
+host-query:
+  description: |
+    Filter the list result by the hostname of the system the agent is running
+    on.
+  in: query
+  required: false
+  type: string
 id-query:
   description: |
     Filter the list result by the ID of the resource.
@@ -1168,6 +1195,13 @@ target_tenant-query:
   in: query
   required: false
   type: string
+topic-query:
+  description: |
+    Filter the list result by the name of AMQP topic the agent is listening on
+    such as ``dhcp_agent``.
+  in: query
+  required: false
+  type: string
 trunk-sort_key:
   description: |
     Sorts by a trunk attribute. You can specify multiple pairs of sort key