summaryrefslogtreecommitdiffstats
path: root/docs/sampleCommands.rst
diff options
context:
space:
mode:
authorShashank Kumar Shankar <shashank.kumar.shankar@intel.com>2018-08-31 11:36:01 -0700
committerVictor Morales <victor.morales@intel.com>2018-09-04 09:02:35 -0700
commit9ea39f64e077613fe004ed00f7b2b2497381faea (patch)
treec94574687e088762e224e6a51e90fe5c99e8c69f /docs/sampleCommands.rst
parent28376cbc428324577451181f67f383ea9d8de164 (diff)
Update docs to include sample commands
This patch updates the docs to include sample request and response. Change-Id: I5f1c29477587a2b0cda8b188ec5a9ff3bb34e5d2 Issue-ID: MULTICLOUD-301 Signed-off-by: Shashank Kumar Shankar <shashank.kumar.shankar@intel.com>
Diffstat (limited to 'docs/sampleCommands.rst')
-rw-r--r--docs/sampleCommands.rst88
1 files changed, 60 insertions, 28 deletions
diff --git a/docs/sampleCommands.rst b/docs/sampleCommands.rst
index 2407b260..c635c250 100644
--- a/docs/sampleCommands.rst
+++ b/docs/sampleCommands.rst
@@ -17,7 +17,7 @@ Sample cURL commands
POST
****
-URL: `localhost:8081/v1/vnf_instances/cloudregion1/namespacetest`
+URL: `localhost:8081/v1/vnf_instances/`
Request Body
------------
@@ -26,6 +26,7 @@ Request Body
{
"cloud_region_id": "region1",
+ "namespace": "test-namespace",
"csar_id": "uuid",
"namespace": "test",
"oof_parameters": [{
@@ -48,37 +49,68 @@ Expected Response
.. code-block:: json
{
- "response": "Created Deployment:nginx-deployment"
+ "vnf_id": "52fdfc07",
+ "cloud_region_id": "cloudregion1",
+ "namespace": "test-namespace",
+ "vnf_components": {
+ "deployment": [
+ "cloudregion1-test-namespace-52fdfc07-kubedeployment"
+ ],
+ "service": [
+ "cloudregion1-test-namespace-52fdfc07-kubeservice"
+ ]
+ }
}
-The above POST request will download the following YAML file and run it on the Kubernetes cluster.
-
-.. code-block:: yaml
-
- apiVersion: apps/v1
- kind: Deployment
- metadata:
- name: nginx-deployment
- labels:
- app: nginx
- spec:
- replicas: 3
- selector:
- matchLabels:
- app: nginx
- template:
- metadata:
- labels:
- app: nginx
- spec:
- containers:
- - name: nginx
- image: nginx:1.7.9
- ports:
- - containerPort: 80
-
***
GET
***
URL: `localhost:8081/v1/vnf_instances`
+
+Expected Response
+-----------------
+
+.. code-block:: json
+
+ {
+ "vnf_id_list": [
+ "52fdfc07"
+ ]
+ }
+
+***
+GET
+***
+
+URL: `localhost:8081/v1/vnf_instances/cloudregion1/test-namespace/52fdfc07`
+
+Expected Response
+-----------------
+
+.. code-block:: json
+
+ {
+ "vnf_id": "52fdfc07",
+ "cloud_region_id": "cloudregion1",
+ "namespace": "test-namespace",
+ "vnf_components": {
+ "deployment": [
+ "cloudregion1-test-namespace-52fdfc07-kubedeployment"
+ ],
+ "service": [
+ "cloudregion1-test-namespace-52fdfc07-kubeservice"
+ ]
+ }
+ }
+
+***
+DELETE
+***
+
+URL: `localhost:8081/v1/vnf_instances/cloudregion1/test-namespace/52fdfc07`
+
+Expected Response
+-----------------
+
+202 Accepted \ No newline at end of file