From: Jimmy Forsyth Date: Wed, 29 May 2019 19:46:45 +0000 (-0400) Subject: Fix typos and clean up docs X-Git-Tag: 1.5.0~5 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=06e46ca5f35c7dd5e2f9649082744a6f768ae107;p=aai%2Faai-common.git Fix typos and clean up docs Issue-ID: AAI-2461 Signed-off-by: Jimmy Forsyth Change-Id: I8ac06c9c6f15fea9edb33294d441cf4c8d07e4be --- 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 - */aai/v10/network/logical-links/logical-link/logical-link-123456789-01* + */aai/v16/network/logical-links/logical-link/logical-link-123456789-01* logical-link logical-link.link-name @@ -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: customer - https://mtinjvmsdn30.cip.att.com:8443/aai/v16/business/customers/customer/globalspanos/ + https://aai.onap:8443/aai/v16/business/customers/customer/globalexample/ service-subscription - https://mtinjvmsdn30.cip.att.com:8443/aai/v16/business/customers/customer/globalspanos/service-subscriptions/service-subscription/ptplgamma/ + https://aai.onap:8443/aai/v16/business/customers/customer/globalexample/service-subscriptions/service-subscription/ptplgamma/ service-instance - https://mtinjvmsdn30.cip.att.com:8443/aai/v16/business/customers/customer/globalspanos/service-subscriptions/service-subscription/ptplgamma/service-instances/service-instance/arnoldave/ + https://aai.onap:8443/aai/v16/business/customers/customer/globalexample/service-subscriptions/service-subscription/ptplgamma/service-instances/service-instance/arnoldave/ @@ -118,31 +118,31 @@ Search result: cvlan-tag - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc2/cvlan-tags/cvlan-tag/333/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc2/cvlan-tags/cvlan-tag/333/ cvlan-tag - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc1/cvlan-tags/cvlan-tag/333/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc1/cvlan-tags/cvlan-tag/333/ cvlan-tag - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc1/cvlan-tags/cvlan-tag/111/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc1/cvlan-tags/cvlan-tag/111/ port-group - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc1/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc1/ vce - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/ cvlan-tag - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc2/cvlan-tags/cvlan-tag/222/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc2/cvlan-tags/cvlan-tag/222/ port-group - https://aai.onap:8443/aai/v16/network/vces/vce/spanosvce/port-groups/port-group/spanosifc2/ + https://aai.onap:8443/aai/v16/network/vces/vce/examplevce/port-groups/port-group/exampleifc2/ @@ -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: tenant - https://aai.onap:8443/aai/v16/cloud-infrastructure/tenants/tenant/spanospizzatenant/ + https://aai.onap:8443/aai/v16/cloud-infrastructure/tenants/tenant/examplepizzatenant/ @@ -208,7 +208,7 @@ Search Result: .. code-block:: xml - + service-instance https://aai.onap:8443/aai/v16/business/customers/customer/examplecustomer/service-subscriptions/service-subscription/ptplgamma/service-instances/service-instance/arnoldave/ @@ -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: image - https://aai.onap:8443/aai/v1/cloud-infrastructure/images/image/valueOfImageId/ + https://aai.onap:8443/aai/v16/cloud-infrastructure/images/image/valueOfImageId/ cvlan-tag 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 pserver - https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/mygreatpserver + https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/mygreatpserver pserver - https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/myothergreatpserver/ + https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/myothergreatpserver/ pserver - https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/stillanothergreatpserver + https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/stillanothergreatpserver pserver - https://aai.onap:8443/aai/v4/cloud-infrastructure/pservers/pserver/testbestestpserver + https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/testbestestpserver 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" },...]