api-ref: add filter parameters to trunk

Change-Id: Icdef40a41ffc721a41553814428e26100fae01ee
This commit is contained in:
Hongbin Lu
2018-03-14 20:40:10 +00:00
parent 98042e7237
commit 6f68070fdb
2 changed files with 39 additions and 0 deletions

View File

@@ -312,6 +312,13 @@ admin_state_up-query:
in: query
required: false
type: boolean
admin_state_up_trunk-query:
description: |
Filter the trunk list result by the administrative state of the trunk,
which is up (``true``) or down (``false``).
in: query
required: false
type: boolean
binding:host_id-query:
description: |
Filter the port list result by the ID of the host where the port resides.
@@ -782,6 +789,19 @@ tags-query:
in: query
required: false
type: string
trunk-status-query:
description: |
Filter the trunk list result by the status for the trunk. Possible values
are ``ACTIVE``, ``DOWN``, ``BUILD``, ``DEGRADED``, and ``ERROR``.
in: query
required: false
type: string
trunk_port_id-query:
description: |
Filter the trunk list result by the ID of the parent port.
in: query
required: false
type: string
verbose:
description: |
Show detailed information.

View File

@@ -42,6 +42,25 @@ Normal response codes: 200
Error response codes: 401, 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- admin_state_up: admin_state_up_trunk-query
- description: description-query
- id: id-query
- name: name-query
- port_id: trunk_port_id-query
- revision_number: revision_number-query
- status: trunk-status-query
- tenant_id: project_id-query
- project_id: project_id-query
- tags: tags-query
- tags-any: tags-any-query
- not-tags: not-tags-query
- not-tags-any: not-tags-any-query
Response Parameters
-------------------