summaryrefslogtreecommitdiff
path: root/api-ref/source/parameters.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'api-ref/source/parameters.yaml')
-rw-r--r--api-ref/source/parameters.yaml8
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