From 7c89e7e4ec9f584f5c9dc49bf12e7dc6802c2d19 Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Mon, 30 Jan 2023 14:12:51 -0800 Subject: [PATCH] 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 --- api-ref/source/parameters.yaml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index b55ef405f2..361cca531d 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