diff options
Diffstat (limited to 'docs/AAI REST API Documentation')
| -rw-r--r-- | docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst | 10 | ||||
| -rw-r--r-- | docs/AAI REST API Documentation/genericQueries.rst | 30 | ||||
| -rw-r--r-- | docs/AAI REST API Documentation/nodesQuery.rst | 10 | ||||
| -rw-r--r-- | docs/AAI REST API Documentation/recentsApi.rst | 12 |
4 files changed, 31 insertions, 31 deletions
diff --git a/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst b/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst index 0b4f9a3c..8c4e43cf 100644 --- a/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst +++ b/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst @@ -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": [ { @@ -1438,7 +1438,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 +1704,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 ^^^^^^^^^ diff --git a/docs/AAI REST API Documentation/genericQueries.rst b/docs/AAI REST API Documentation/genericQueries.rst index 887bce4b..e2f7e200 100644 --- a/docs/AAI REST API Documentation/genericQueries.rst +++ b/docs/AAI REST API Documentation/genericQueries.rst @@ -93,15 +93,15 @@ Search result: <search-results xmlns="http://com.att.aai.inventory/v16"> <result-data> <resource-type>customer</resource-type> - <resource-link>https://mtinjvmsdn30.cip.att.com:8443/aai/v16/business/customers/customer/globalspanos/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/business/customers/customer/globalexample/</resource-link> </result-data> <result-data> <resource-type>service-subscription</resource-type> - <resource-link>https://mtinjvmsdn30.cip.att.com:8443/aai/v16/business/customers/customer/globalspanos/service-subscriptions/service-subscription/ptplgamma/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/business/customers/customer/globalexample/service-subscriptions/service-subscription/ptplgamma/</resource-link> </result-data> <result-data> <resource-type>service-instance</resource-type> - <resource-link>https://mtinjvmsdn30.cip.att.com:8443/aai/v16/business/customers/customer/globalspanos/service-subscriptions/service-subscription/ptplgamma/service-instances/service-instance/arnoldave/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/business/customers/customer/globalexample/service-subscriptions/service-subscription/ptplgamma/service-instances/service-instance/arnoldave/</resource-link> </result-data> </search-results> @@ -118,31 +118,31 @@ Search result: <search-results xmlns="http://org.onap.aai.inventory/v16"> <result-data> <resource-type>cvlan-tag</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc2/cvlan-tags/cvlan-tag/333/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc2/cvlan-tags/cvlan-tag/333/</resource-link> </result-data> <result-data> <resource-type>cvlan-tag</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc1/cvlan-tags/cvlan-tag/333/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc1/cvlan-tags/cvlan-tag/333/</resource-link> </result-data> <result-data> <resource-type>cvlan-tag</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc1/cvlan-tags/cvlan-tag/111/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc1/cvlan-tags/cvlan-tag/111/</resource-link> </result-data> <result-data> <resource-type>port-group</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc1/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc1/</resource-link> </result-data> <result-data> <resource-type>vce</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/</resource-link> </result-data> <result-data> <resource-type>cvlan-tag</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc2/cvlan-tags/cvlan-tag/222/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc2/cvlan-tags/cvlan-tag/222/</resource-link> </result-data> <result-data> <resource-type>port-group</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc2/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc2/</resource-link> </result-data> </search-results> @@ -152,7 +152,7 @@ Customer GET based on tenant id URL: - /aai/v16/search/generic-query?key=tenant.tenant-id:spanospizzatenant&start-node-type=tenant&include=tenant&include=customer&include=service-subscription&depth=2 + /aai/v16/search/generic-query?key=tenant.tenant-id:examplepizzatenant&start-node-type=tenant&include=tenant&include=customer&include=service-subscription&depth=2 Search Result: @@ -192,7 +192,7 @@ Search Result: </result-data> <result-data> <resource-type>tenant</resource-type> - <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/tenants/tenant/spanospizzatenant/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/tenants/tenant/examplepizzatenant/</resource-link> </result-data> </search-results> @@ -208,7 +208,7 @@ Search Result: .. code-block:: xml - <search-results xmlns="http://org.onap.aai.inventory/v4"> + <search-results xmlns="http://org.onap.aai.inventory/v6"> <result-data> <resource-type>service-instance</resource-type> <resource-link>https://aai.onap:8443/aai/v16/business/customers/customer/examplecustomer/service-subscriptions/service-subscription/ptplgamma/service-instances/service-instance/arnoldave/</resource-link> @@ -220,7 +220,7 @@ Get service-instance and service-subscription from vce .. code-block:: URL: - /aai/v16/search/generic-query?key=vce.vnf-id:spanosvce&start-node-type=vce&include=service-instance&include=service-subscription&depth=2 + /aai/v16/search/generic-query?key=vce.vnf-id:examplevce&start-node-type=vce&include=service-instance&include=service-subscription&depth=2 Search Result: @@ -312,7 +312,7 @@ Search Result: </result-data> <result-data> <resource-type>image</resource-type> - <resource-link>https://aai.onap:8443/aai/v1/cloud-infrastructure/images/image/valueOfImageId/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/images/image/valueOfImageId/</resource-link> </result-data> <result-data> <resource-type>cvlan-tag</resource-type> diff --git a/docs/AAI REST API Documentation/nodesQuery.rst b/docs/AAI REST API Documentation/nodesQuery.rst index 3c2ae554..4b0a61f4 100644 --- a/docs/AAI REST API Documentation/nodesQuery.rst +++ b/docs/AAI REST API Documentation/nodesQuery.rst @@ -98,7 +98,7 @@ Supported queries .. code:: URL: - /aai/v4/search/nodes-query?search-node-type=pserver&filter=ipv4-oam-address:DOES-NOT-EXIST: + /aai/v16/search/nodes-query?search-node-type=pserver&filter=ipv4-oam-address:DOES-NOT-EXIST: Search result @@ -107,18 +107,18 @@ Search result <search-results xmlns="http://org.onap.aai.inventory/v16"> <result-data> <resource-type>pserver</resource-type> - <resource-link>https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/mygreatpserver</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/mygreatpserver</resource-link> </result-data> <result-data> <resource-type>pserver</resource-type> - <resource-link>https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/myothergreatpserver/</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/myothergreatpserver/</resource-link> </result-data> <result-data> <resource-type>pserver</resource-type> - <resource-link>https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/stillanothergreatpserver</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/stillanothergreatpserver</resource-link> </result-data> <result-data> <resource-type>pserver</resource-type> - <resource-link>https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/testbestestpserver</resource-link> + <resource-link>https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/testbestestpserver</resource-link> </result-data> </search-results> diff --git a/docs/AAI REST API Documentation/recentsApi.rst b/docs/AAI REST API Documentation/recentsApi.rst index f0f65c3f..74e423c8 100644 --- a/docs/AAI REST API Documentation/recentsApi.rst +++ b/docs/AAI REST API Documentation/recentsApi.rst @@ -12,7 +12,7 @@ Recents API Overview The Recents API will allow a client to get the list of objects that has been created or updated recently, up to a maximum of 1 week back. -This API is accessed through the NARAD Rest Interface, utilizing the +This API is accessed through the AAI Rest Interface, utilizing the same certificates and headers. Request @@ -26,16 +26,16 @@ Querying with number of hours .. code:: - GET /narad/recents/v$/{node-type}?hours={hours} + GET /aai/recents/v$/{node-type}?hours={hours} Querying with an epoch timestamp .. code:: - GET /narad/v$/{node-type}?date-time={timestamp} + GET /aai/recents/v$/{node-type}?date-time={timestamp} Example: - GET /narad/recents/v1/pnf?date-time=1531413113815 + GET /aai/recents/v$/pnf?date-time=1531413113815 Response -------- @@ -51,12 +51,12 @@ Sample response: "results": [ { "resource-type": "pnf", - "resource-link": "/narad/v1/network/pnfs/pnf/lab20105v" + "resource-link": "/aai/v16/network/pnfs/pnf/lab20105v" "resource-version": "1531413113815" }, { "resource-type": "pnf", - "resource-link": "/narad/v1/network/pnfs/pnf/ro-stack01" + "resource-link": "/aai/v16/network/pnfs/pnf/stack01" "resource-version": "1531413113612" },...] |