aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sampleCommands.rst
blob: c635c250db98728ad290ef29828da02eea47376d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
.. Copyright 2018 Intel Corporation.
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
        http://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

====================
Sample cURL commands
====================

****
POST
****

URL: `localhost:8081/v1/vnf_instances/`

Request Body
------------

.. code-block:: json

    {
        "cloud_region_id": "region1",
        "namespace": "test-namespace",
        "csar_id": "uuid",
        "namespace": "test",
        "oof_parameters": [{
            "key1": "value1",
            "key2": "value2",
            "key3": {}
        }],
        "network_parameters": {
            "oam_ip_address": {
                "connection_point": "string",
                "ip_address": "string",
                "workload_name": "string"
            }
        }
    }

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"
            ]
        }
    }

***
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