[AAI] Fix TOC for the release notes documentation
[aai/aai-common.git] / docs / AAI REST API Documentation / AAIRESTAPI_DUBLIN.rst
index 0b4f9a3..04cd6c0 100644 (file)
@@ -611,7 +611,7 @@ XML
 .. code-block:: xml
 
    <relationship xmlns="http://org.onap.aai.inventory/vX">
-     <related-link>*/aai/v10/network/logical-links/logical-link/logical-link-123456789-01*</related-link>
+     <related-link>*/aai/v16/network/logical-links/logical-link/logical-link-123456789-01*</related-link>
      <related-to>logical-link</related-to>
      <relationship-data>
        <relationship-key>logical-link.link-name</relationship-key>
@@ -624,7 +624,7 @@ JSON
 .. code-block:: json
 
    {
-       "related-link": " /aai/v10/network/logical-links/logical-link/logical-link-123456789-01",
+       "related-link": " /aai/v16/network/logical-links/logical-link/logical-link-123456789-01",
        "related-to": "logical-link",
        "relationship-data": [
           {
@@ -801,7 +801,7 @@ Imagine this is the existing resource:
        "relationship-list": {
           "relationship": [
               {
-                  "related-link": " /aai/v16network/generic-vnfs/generic-vnf/generic-vnf-20160902a",
+                  "related-link": " /aai/v16/network/generic-vnfs/generic-vnf/generic-vnf-20160902a",
                   "related-to": "generic-vnf",
                   "relationship-data": [
                       {
@@ -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
 ==================
 
@@ -1070,8 +1085,8 @@ and its related vertexes.  The following capabilities are available to
 meet more advanced search needs.  Please contact the AAI team if you
 need another search.
 
-Node Queries
-------------
+Nodes Query
+-----------
 
 The Nodes Query mechanism was implemented in support of searching the
 pservers which do not have the ipv4-oam-ipaddress set.  It will allow
@@ -1079,23 +1094,9 @@ nodes to be searched based on certain properties of the nodes. It will
 allow search based on properties being set, not set or set to specific
 values.
 
-Please reference `Node Queries <nodeQueries.html>`_ for details on the
+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 Query <nodesQuery.html>`_ for more information.
 
 Generic Queries
 ---------------
@@ -1438,7 +1439,7 @@ Example Response
                  "street1": "100 Main St",
                  "street2": "C3-3W03"
              },
-             "url": "/aai/v161/cloud-infrastructure/complexes/complex/complextest1"
+             "url": "/aai/v16/cloud-infrastructure/complexes/complex/complextest1"
          }
       ]
   }
@@ -1704,7 +1705,7 @@ children/grandchildren to return. The default depth is 1.
 
 .. code::
   
-   PUT /aai/v$/query?format={}&depth=0
+   PUT /aai/v$/query?format={format}&depth=0
 
 nodesOnly
 ^^^^^^^^^
@@ -1773,4 +1774,4 @@ The Recents API allows a client to get the list of objects that has
 been created or updated recently, up to a maximum of 1 week
 back.
 
-`Recents API <recentApi.html>`_ 
+`Recents API <recentsApi.html>`_