[api-ref] Fix api-ref to mention list port by cg
Ports can be listed by conductor group since Flamingo, but due to an error in the api-ref update, we weren't properly documenting it. Change-Id: I98b329897946ef05ff82df5f1683075f17ecd3c0 Signed-off-by: Afonne-CID <afonnepaulc@gmail.com> Signed-off-by: Jay Faulkner <jay@jvf.cc>
This commit is contained in:
@@ -32,6 +32,10 @@ By default, this query will return the UUID, name and address for each Portgroup
|
||||
Added the ``detail`` boolean request parameter. When specified ``True`` this
|
||||
causes the response to include complete details about each portgroup.
|
||||
|
||||
.. versionadded:: 1.99
|
||||
Added the ability to filter portgroups based on the ``conductor_group`` of the
|
||||
node they are associated with.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
@@ -49,6 +53,7 @@ Request
|
||||
- sort_dir: sort_dir
|
||||
- sort_key: sort_key
|
||||
- detail: detail
|
||||
- conductor_group: r_conductor_group_port
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@@ -50,12 +50,16 @@ By default, this query will return the uuid and address for each Port.
|
||||
Added the ``is_smartnic`` field.
|
||||
|
||||
.. versionadded:: 1.82
|
||||
Added the ability to filter ports based on the shard of the node they are
|
||||
associated with.
|
||||
Added the ability to filter ports based on the ``shard`` of the node they
|
||||
are associated with.
|
||||
|
||||
.. versionadded:: 1.97
|
||||
Added the ``description`` field.
|
||||
|
||||
.. versionadded:: 1.99
|
||||
Added the ability to filter ports based on the ``conductor_group`` of the
|
||||
node they are associated with.
|
||||
|
||||
.. versionadded:: 1.100
|
||||
Added the ``vendor`` field.
|
||||
|
||||
@@ -74,6 +78,7 @@ Request
|
||||
- portgroup: r_port_portgroup_ident
|
||||
- address: r_port_address
|
||||
- shard: r_port_shard
|
||||
- conductor_group: r_conductor_group_port
|
||||
- fields: fields
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
|
||||
@@ -293,7 +293,7 @@ r_conductor_group:
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_conductor_groups:
|
||||
r_conductor_group_port:
|
||||
description: |
|
||||
Filter the list of returned ports or portgroups, and only return those with
|
||||
the specified ``conductor_group`` or an empty set if none found. List of
|
||||
|
||||
Reference in New Issue
Block a user