diff options
| author |   wr148d <wr148d@att.com> | 2022-10-31 09:42:06 -0400 |
|---|---|---|
| committer | wr148d <wr148d@att.com> | 2022-11-09 09:52:45 -0500 |
| commit | 5b83ba0814d6a046d45146e97762626700440520 (patch) | |
| tree | 020798e93a78dd1d72847803174c8bbb0f58ee65 /docs/AAI REST API Documentation/nodesQuery.rst | |
| parent | 58f0fd2f6ef58de52e1f9a73540c1bb895c0d6e6 (diff) | |
[AAI] Fix doc config files
Issue-ID: AAI-3572
Change-Id: Icb2bce5d096d9c807aa6fe2a72243c6dc16e5028
Signed-off-by: wr148d <wr148d@att.com>
Diffstat (limited to 'docs/AAI REST API Documentation/nodesQuery.rst')
| -rw-r--r-- | docs/AAI REST API Documentation/nodesQuery.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/AAI REST API Documentation/nodesQuery.rst b/docs/AAI REST API Documentation/nodesQuery.rst index 4b0a61f4..a86a9e8a 100644 --- a/docs/AAI REST API Documentation/nodesQuery.rst +++ b/docs/AAI REST API Documentation/nodesQuery.rst @@ -7,13 +7,13 @@ Nodes Query =========== -A&AI Nodes Query Implementation Notes: +A&AI Nodes Query Implementation Notes: Overview -------- -AAI continues to support this API, but clients may find that `Custom -Queries <customQueries.html>`_ meet the needs more most queries. +AAI continues to support this API, but clients may find that custom +queries meet the needs more most queries. The Nodes Query mechanism is mostly being implemented in support of searching the pservers which do not have the ipv4-oam-ipaddress @@ -35,7 +35,7 @@ use in which environment/release. The URL expects the following URL parameters: -**search-node-type** - node type of the node to be searched. +**search-node-type** - node type of the node to be searched. **filter** – list of properties that specify the search criterion. Format will be @@ -43,7 +43,7 @@ criterion. Format will be .. code:: filter=<property-name>:<EQUALS|DOES-NOT-EQUAL|EXISTS|DOES-NOT-EXIST>:<property-value> - + such as filter=ipv4-oam-address:DOES-NOT-EXIST: @@ -53,7 +53,7 @@ For EXISTS and DOES-NOT-EXIST the property value is not specified The queries return a search-results object back which includes a list of result-data which contains the node-type and a link for each -resource that was found. +resource that was found. Requirements @@ -67,7 +67,7 @@ Requirements * The search results can be asked to be returned in json or xml based on the ACCEPT header. - + * If no filter params are specified, it would return all nodes of that node type. Design @@ -93,13 +93,13 @@ Design Supported queries ----------------- -* Search pserver nodes for which ipv4-oam-address DOES-NOT-EXIST +* Search pserver nodes for which ipv4-oam-address DOES-NOT-EXIST .. code:: URL: /aai/v16/search/nodes-query?search-node-type=pserver&filter=ipv4-oam-address:DOES-NOT-EXIST: - + Search result .. code:: |