diff options
| author |   Jimmy Forsyth <jf2512@att.com> | 2019-06-07 09:47:07 -0400 |
|---|---|---|
| committer | Jimmy Forsyth <jf2512@att.com> | 2019-06-07 12:22:59 -0400 |
| commit | b31816bbe73439bab7546e1412981106ab0c4bf8 (patch) | |
| tree | 04b8ec04b83b6136a8d076775b79de6af876ceb6 /docs/AAI REST API Documentation/AAIRESTAPI.rst | |
| parent | c21c6aac0b93f8a368b155b8426a4a4f6d8127fd (diff) | |
Add instructions for AAF role for sparky
Move nodes API block to proper location
Issue-ID: AAI-2411
Signed-off-by: Jimmy Forsyth <jf2512@att.com>
Change-Id: If21e610366c765a251fe4fb78ded7ca90bcfa142
Diffstat (limited to 'docs/AAI REST API Documentation/AAIRESTAPI.rst')
| -rw-r--r-- | docs/AAI REST API Documentation/AAIRESTAPI.rst | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/docs/AAI REST API Documentation/AAIRESTAPI.rst b/docs/AAI REST API Documentation/AAIRESTAPI.rst index 5cd758bb..04cd6c08 100644 --- a/docs/AAI REST API Documentation/AAIRESTAPI.rst +++ b/docs/AAI REST API Documentation/AAIRESTAPI.rst @@ -1062,6 +1062,21 @@ The Bulk API allows clients to make multiple requests in a single transaction. Please look for additional details on the following wiki page: `Bulk API <bulkApi.html>`_ +Nodes API +--------- + +In working with A&AI's standard REST API, you may have noticed that +certain API paths have a hierarchy to them and require a client to +know multiple object keys to preform GETs. For example: the vserver +object is under tenant, which is itself under cloud-region. If you +wanted to look up a vserver by name, you would still need to know the +tenant-id and cloud-region-id (and cloud-owner) in order to +successfully perform that GET. The nodes API allows for more freedom +in querying A&AI, allowing clients to circumvent the need to know +every key in the hierarchy. + +See `Nodes API <nodesApi.html>`_ for more information. + AAI Traversal APIs ================== @@ -1082,20 +1097,6 @@ values. Please reference `Nodes Query <nodesQuery.html>`_ for details on the API and test queries. -Nodes API ---------- - -In working with A&AI's standard REST API, you may have noticed that -certain API paths have a hierarchy to them and require a client to -know multiple object keys to preform GETs. For example: the vserver -object is under tenant, which is itself under cloud-region. If you -wanted to look up a vserver by name, you would still need to know the -tenant-id and cloud-region-id (and cloud-owner) in order to -successfully perform that GET. The nodes API allows for more freedom -in querying A&AI, allowing clients to circumvent the need to know -every key in the hierarchy. - -See `Nodes API <nodesApi.html>`_ for more information. Generic Queries --------------- |