summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBin Hu <bh526r@att.com>2018-09-04 20:32:50 +0000
committerGerrit Code Review <gerrit@onap.org>2018-09-04 20:32:50 +0000
commit7e9b8b6967a69ae04a37dcba5448c3017fc91d51 (patch)
treef2fe2201e2215694f330b17d14c38cf8cabee59b
parent6e2857125fdce17a1541f3ca45ee0b988e9ef4de (diff)
parent9ea39f64e077613fe004ed00f7b2b2497381faea (diff)
Merge "Update docs to include sample commands"
-rw-r--r--docs/sampleCommands.rst88
-rw-r--r--tox.ini2
2 files changed, 61 insertions, 29 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
diff --git a/tox.ini b/tox.ini
index a3971037..2e593451 100644
--- a/tox.ini
+++ b/tox.ini
@@ -18,7 +18,7 @@ commands = bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
# E006 check for lines longer than 79 columns
-print0 | xargs -0 bashate -v -iE006"
bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
- -name \*.rst -type f -print0 | xargs -0 rstcheck"
+ -name \*.rst -type f -print0 | xargs -0 rstcheck --report warning"
[testenv:docs]
deps = sphinx