diff options
author | Rich Bennett <rb2745@att.com> | 2018-05-22 00:45:53 -0400 |
---|---|---|
committer | Rich Bennett <rb2745@att.com> | 2018-05-22 00:53:18 -0400 |
commit | d10ba074e47e24e1f05e4ee119efc2ca6cc0dea7 (patch) | |
tree | f14a15e07113b72ff6c1c11f8e362fefc4924b37 /docs/AAI REST API Documentation | |
parent | 68987011d4a41ed59375616a19b0cde229b9c413 (diff) |
Eliminate Sphinx Errors and Warnings2.0.0-ONAP2.0.0-ONAP
Add end of block and inline markup delimeters
Use code blocks for json, xml, and http
Change-Id: I79f69227bfb3e43d97f46e01fe2ada6d1c4872ea
Issue-ID: AAI-1152
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/AAI REST API Documentation')
-rw-r--r-- | docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst | 135 |
1 files changed, 56 insertions, 79 deletions
diff --git a/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst b/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst index 16e4a94f..9dc91f70 100644 --- a/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst +++ b/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst @@ -431,48 +431,41 @@ missing (e.g., generic-vnf) and the key data for that node type Single relationships can be PUT to the graph in the following way: -https://{serverRoot}/{namespace}/{resource} -/relationship-list/relationship - -or - -https://{hostname}:8443/aai/v11/cloud-infrastructure/pservers/pserver/pserver-123456789-01/p-interfaces/p-interface/p-interface-name-123456789-01/l-interfaces/l-interface/l-interface-name-123456789-01/relationship-list/relationship - -with a payload containing the relationship information. - -XML: - -<relationship xmlns="http://org.openecomp.aai.inventory/v11"> - -<related-to>logical-link</related-to> - -<relationship-data> - - <relationship-key>logical-link.link-name</relationship-key> +.. code-block:: none - <relationship-value>logical-link-123456789-01</relationship-value> + https://{serverRoot}/{namespace}/{resource}/relationship-list/relationship -</relationship-data> - -</relationship> +or -JSON: +.. code-block:: none -"related-to": "logical-link", + https://{hostname}:8443/aai/v11/cloud-infrastructure/pservers/pserver/pserver-123456789-01/p-interfaces/p-interface/p-interface-name-123456789-01/l-interfaces/l-interface/l-interface-name-123456789-01/relationship-list/relationship -"relationship-data": [ +with a payload containing the relationship information in XML -{ +.. code-block:: xml - "relationship-key": "logical-link.link-name", + <relationship xmlns="http://org.openecomp.aai.inventory/v11"> + <related-to>logical-link</related-to> + <relationship-data> + <relationship-key>logical-link.link-name</relationship-key> + <relationship-value>logical-link-123456789-01</relationship-value> + </relationship-data> + </relationship> - "relationship-value": " logical-link-123456789-01" +or JSON. -} +.. code-block:: json -] - -} + { + "related-to": "logical-link", + "relationship-data": [ + { + "relationship-key": "logical-link.link-name", + "relationship-value": " logical-link-123456789-01" + } + ] + } Edges ===== @@ -528,7 +521,9 @@ connectivity with AAI. The URL for the echo utility is: -https://load-balanced-address:8443/aai/util/echo +.. code-block:: none + + https://load-balanced-address:8443/aai/util/echo If the response is unsuccessful, an error will be returned following the standard format. @@ -539,56 +534,38 @@ by the client. Successful XML Response Payload ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -<Info> - -<responseMessages> - -<responseMessage> - -<messageId>INF0001</messageId> - -<text>Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4)</text> - -<variables> - -<variable>XYZ</variable> - -<variable>XYZ123</variable> - -<variable>Successful health check:OK</variable> - -<variable>0.0.0002</variable> - -</variables> - -</responseMessage> - -</responseMessages> - -</Info> +.. code-block:: xml + + <Info> + <responseMessages> + <responseMessage> + <messageId>INF0001</messageId> + <text>Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4)</text> + <variables> + <variable>XYZ</variable> + <variable>XYZ123</variable> + <variable>Successful health check:OK</variable> + <variable>0.0.0002</variable> + </variables> + </responseMessage> + </responseMessages> + </Info> Successful JSON Response Payload ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -{"responseMessages": {"responseMessage": [{ - -"messageId": "INF0001", - -"text": "Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4)", - -"variables": {"variable": [ - -"XYZ", - -"XYZ123", - -"Successful health check:OK", - -"0.0.0002" - -]} - -}]}} +.. code-block:: json + + {"responseMessages": {"responseMessage": [{ + "messageId": "INF0001", + "text": "Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4)", + "variables": {"variable": [ + "XYZ", + "XYZ123", + "Successful health check:OK", + "0.0.0002" + ]} + }]}} Cloud Infrastructure Domain --------------------------- |