From aaae83acaac5f58918ff53613b4de20bbfe30d81 Mon Sep 17 00:00:00 2001 From: chenxing Date: Mon, 29 Jul 2019 15:30:32 +0800 Subject: [PATCH] Mention that list of e.g. IDs is supported in GET requests Change-Id: Ia275a8068aad110ff4225d6ac2cbdfa1a877b3e5 Closes-Bug: #1837553 --- api-ref/source/v2/intro.inc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/api-ref/source/v2/intro.inc b/api-ref/source/v2/intro.inc index 59a6578ad..4ffbe0d27 100644 --- a/api-ref/source/v2/intro.inc +++ b/api-ref/source/v2/intro.inc @@ -145,6 +145,15 @@ admin_state_up=True and shared=True and named ``foobar`` or ``bizbaz``: GET /v2.0/networks?name=foobar&name=bizbaz&admin_state_up=True&shared=True +List of resources is supported in GET requests. For example, if you want the +information of two specific ports that ``id`` is ``port_id_A`` or ``port_id_B``: + +.. code:: + + GET /v2.0/ports?id=port_id_A&id=port_id_B + +It treats ID filters as list and return ports with those 2 IDs. + Starting from Rocky release, the Networking API might support filtering attributes with empty value. For example, the request below lists all ports that have ``device_id`` attribute with empty value (which are unbound ports).