diff options
| author | Jay Faulkner <jay@jvf.cc> | 2023-01-30 14:12:51 -0800 |
|---|---|---|
| committer | Jay Faulkner <jay@jvf.cc> | 2023-01-30 14:13:39 -0800 |
| commit | 7c89e7e4ec9f584f5c9dc49bf12e7dc6802c2d19 (patch) | |
| tree | a2a34a6af3863245e4dc2a95a57f0054b51e2a0f /api-ref | |
| parent | 4e8705dc9f6219b0af8d6d2769fb5aa554f458c5 (diff) | |
| download | ironic-7c89e7e4ec9f584f5c9dc49bf12e7dc6802c2d19.tar.gz | |
Fix API docs to document port filtering behavior
Ports cannot be filtered by node, node_uuid, or portgroup at the same
time as other potential filters. Explicitly document this.
Change-Id: Ia875a6543eb8871ce70028c055de2f1832c3ecdb
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/parameters.yaml | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index b55ef405f..361cca531 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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 |