summaryrefslogtreecommitdiffstats
path: root/docs/developer_guide.rst
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-03-30 10:13:43 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-03-30 10:13:43 +0530
commit7e3a522d47e39aea335a447c439d1fc831dd46a5 (patch)
treef0b3a8c8cd43b3a213037ca1e532bedc6e91ca53 /docs/developer_guide.rst
parent461290c7da4dce7964cbd4725d940c4993c190a4 (diff)
Update docs for beijing
Issue-ID: CLI-100 Change-Id: I51a719419c5e06e7be2c9ebac29e9d696ea19473 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs/developer_guide.rst')
-rw-r--r--docs/developer_guide.rst19
1 files changed, 9 insertions, 10 deletions
diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst
index 13a6a5a7..8d3fdfe2 100644
--- a/docs/developer_guide.rst
+++ b/docs/developer_guide.rst
@@ -7,7 +7,7 @@
CLI developer guide
===================
-Develop OCLIP using plug-ins or YAML.
+OCLI provides following approaches for developing CLI:
As a Plug-in
------------
@@ -106,12 +106,6 @@ Sample hello-world YAML ::
version: sample-1.0
- service:
- name: sample-service
- version: 1.0.0
- auth: none
- mode: direct
-
parameters:
- name: name
description: name of the person
@@ -133,11 +127,16 @@ Sample hello-world YAML ::
request:
uri: /version.json
method: GET
+
+ service:
+ name: sample-service
+ version: v1
+ auth: none
+ mode: direct
+
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"}