From d10ba074e47e24e1f05e4ee119efc2ca6cc0dea7 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Tue, 22 May 2018 00:45:53 -0400 Subject: Eliminate Sphinx Errors and Warnings 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 --- .../AAIRESTAPI_AMSTERDAM.rst | 135 +++++++++------------ .../How_to_Docker_setup_on_Single_VM.rst | 12 +- docs/release-notes.rst | 2 +- 3 files changed, 68 insertions(+), 81 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: - - - -logical-link - - - - logical-link.link-name +.. code-block:: none - logical-link-123456789-01 + https://{serverRoot}/{namespace}/{resource}/relationship-list/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", + + logical-link + + logical-link.link-name + logical-link-123456789-01 + + - "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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - - - - - -INF0001 - -Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4) - - - -XYZ - -XYZ123 - -Successful health check:OK - -0.0.0002 - - - - - - - - +.. code-block:: xml + + + + + INF0001 + Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4) + + XYZ + XYZ123 + Successful health check:OK + 0.0.0002 + + + + 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 --------------------------- diff --git a/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst b/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst index d869c9ac..82ebf3fb 100644 --- a/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst +++ b/docs/platform/Getting Started/How_to_Docker_setup_on_Single_VM.rst @@ -1,7 +1,6 @@ .. contents:: :depth: 3 -.. _dev-setup: How to Docker setup on Single VM ================================ @@ -16,56 +15,67 @@ Step-by-step guide ------------------ 1. You would need to have a root access to the vm + .. code-block:: bash sudo su - root 2. Navigate to /opt directory + .. code-block:: bash cd /opt 3. Clone the test-config git project + .. code-block:: bash git clone http://gerrit.onap.org/r/aai/test-config 4. Navigate to /opt/test-config directory + .. code-block:: bash cd test-config 5. Create a directory called /opt/config + .. code-block:: bash mkdir /opt/config/ 6. Create a file called /opt/config/nexus\_username.txt containing the text: docker + .. code-block:: bash echo "docker" > /opt/config/nexus_username.txt 7. Create a file called /opt/config/nexus\_password.txt containing the text: docker + .. code-block:: bash echo "docker" > /opt/config/nexus_password.txt 8. Create a file called /opt/config/dmaap\_topic.txt containing the text: AAI-EVENT + .. code-block:: bash echo "AAI-EVENT" > /opt/config/dmaap_topic.txt 9. Create a file called /opt/config/nexus\_docker\_repo.txt containing text: nexus3.onap.org:10001 + .. code-block:: bash echo "nexus3.onap.org:10001" > /opt/config/nexus_docker_repo.txt 10. Create a file called /opt/config/docker\_version.txt containing text: 1.1-STAGING-latest + .. code-block:: bash echo "1.1-STAGING-latest" > /opt/config/docker_version.txt 11. Please note that in the previous step, docker version is currently 1.1-STAGING-latest and this will be changed later. Finally, run the installation scripts + .. code-block:: bash ./deploy_vm2.sh && ./deploy_vm1.sh diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 5355358c..79e8eb8e 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -187,7 +187,7 @@ There is an error to startup esr-gui docker Replace the type specification in this constructor call with the diamond operator ("<>") `AAI-417 `_ -Rackspace 20170928 fails to authenticate nexus3 on 10003 during *_init.sh (sdnc for example) +Rackspace 20170928 fails to authenticate nexus3 on 10003 during *_init.sh* (sdnc for example) `AAI-420 `_ Can not get the MSB address in esr-server -- cgit 1.2.3-korg