openstack/ironic
Code Issues Proposed changes

Fix API docs to document port filtering behavior

Browse Source 
Ports cannot be filtered by node, node_uuid, or portgroup at the same
time as other potential filters. Explicitly document this.

Change-Id: Ia875a6543eb8871ce70028c055de2f1832c3ecdb
This commit is contained in:
Jay Faulkner 2023-01-30 14:12:51 -08:00
parent 4e8705dc9f
commit 7c89e7e4ec
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/source/parameters.yaml
View File

@ -343,13 +343,17 @@ r_port_node_ident:
description: |
Filter the list of returned Ports, and only return the ones associated
with this specific node (name or UUID), or an empty set if not found.
This filter takes precedence over all other filters, and cannot be set at
the same time as node_uuid or portgroup.
in: query
required: false
type: string
r_port_node_uuid:
description: |
Filter the list of returned Ports, and only return the ones associated
with this specific node UUID, or an empty set if not found.
with this specific node UUID, or an empty set if not found. This filter
takes precedence over all other filters, and cannot be set at the same
time as node or portgroup.
in: query
required: false
type: string
@ -357,6 +361,8 @@ r_port_portgroup_ident:
description: |
Filter the list of returned Ports, and only return the ones associated
with this specific Portgroup (name or UUID), or an empty set if not found.
This filter takes precedence over all other filters, and cannot be set at
the same time as node_uuid or node.
in: query
required: false
type: string