From 6b8a853b2ceccf79c952b2bc0b89da545b5cc6dd Mon Sep 17 00:00:00 2001
From: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Date: Mon, 16 Oct 2017 13:55:50 +0530
Subject: Add sample yaml

CLI-40

Change-Id: I60758eed0d4bfca59a407a9acc4636bb51827895
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
---
 docs/OOM_and_HEAT_based_deployment.rst |  2 +-
 docs/developer_guide.rst               | 53 +++++++++++++++++++++++++++++++++-
 2 files changed, 53 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/OOM_and_HEAT_based_deployment.rst b/docs/OOM_and_HEAT_based_deployment.rst
index 14197f8a..52e1aad4 100644
--- a/docs/OOM_and_HEAT_based_deployment.rst
+++ b/docs/OOM_and_HEAT_based_deployment.rst
@@ -13,7 +13,7 @@ HEAT based deployment
 ----------------------
 
 As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is
-successfully installed, it will be available at http://portal_vm-ip:8080
+successfully installed, it will be available at http://portal.api.simpledemo.openecomp.org:8080
 
 To troubleshoot any issues in CLI, please login to portal_vm and CLI docker runs with image onap/cli
 
diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst
index e345e624..2e2278e5 100644
--- a/docs/developer_guide.rst
+++ b/docs/developer_guide.rst
@@ -87,6 +87,57 @@ Follow the steps below to implement new commands in ONAP using YAML:
 
 #. Use the command 'onap schema-validate' to validate the YAML before testing its functionality.
 
-#. Run 'onap schema-refresh' command to take the new YAML file. We recommed validating the YAML before running this command.
+#. Run 'onap schema-refresh' command to take the new YAML file. We recommended validating the YAML before running this command.
 
 #. To test this command, run the command 'onap CMD-NAME --help'.
+
+Sample YAML
+~~~~~~~~~~~~
+
+Find more details about YAML specification at :ref:`open_cli_schema_version_1_0`.
+
+Sample hello-world YAML ::
+
+    open_cli_schema_version: 1.0
+
+    name: hello-world-http
+
+    description: First cmd hello world using http running under lighttpd in cli at http://<cli-ip>:8080/version.json
+
+    version: sample-1.0
+
+    service:
+        name: sample-service
+        version: 1.0.0
+        auth: none
+        mode: direct
+
+    parameters:
+        - name: name
+          description: name of the person
+          long_option: name
+          short_option: b
+          default_value: ${DEMO_NAME}
+          type: string
+          is_optional: false
+
+    results:
+        direction: landscape
+        attributes:
+          - name: output
+            description: hello world output
+            type: string
+            scope: short
+
+    http:
+        request:
+            uri: /version.json
+            method: GET
+        success_codes:
+            - 200
+            - 201
+        result_map:
+            output: Hello ${name}, You are running on $b{$.name} $b{$.version}
+
+        sample_response:
+            body: {"name": "oclip", "version": "1.0"}
-- 
cgit 1.2.3-korg