summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authorHarry Huang <huangxiangyu5@huawei.com>2020-01-08 16:19:35 +0800
committerHarry Huang <huangxiangyu5@huawei.com>2020-01-09 14:29:36 +0800
commitd79a1a2910fb327afa925f4b53166f9e74d4584d (patch)
tree4c7a97de416febd7ed5222fbab83c547babd24b4 /docs/api
parent8f37667d999101c2e4e395d810376173a5714794 (diff)
Add API to support 5G usecase in swagger
Issue-ID: SO-2368 Change-Id: I659abc5e94eeb9ef08b89f0847c0cc577d8b0dca Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger.json297
1 files changed, 296 insertions, 1 deletions
diff --git a/docs/api/swagger.json b/docs/api/swagger.json
index 65d7ff0d11..6df1c21e06 100644
--- a/docs/api/swagger.json
+++ b/docs/api/swagger.json
@@ -18,6 +18,9 @@
"name": "onapsoinfraorchestrationRequests"
},
{
+ "name": "onapsoinfraorchestrationTasks"
+ },
+ {
"name": "onapsoinfraserviceInstantiation"
},
{
@@ -161,6 +164,46 @@
}
}
},
+ "/e2eServiceInstances/{version}/{serviceId}/operations/{operationType}": {
+ "get": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Activate/Deactivate e2eServiceInstances Requests for a given serviceId",
+ "description": "",
+ "operationId": "activateE2EServiceInstances",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ },
+ {
+ "name": "operationType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "activate/deactivate"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
"/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": {
"get": {
"tags": [
@@ -438,6 +481,258 @@
}
}
},
+ "/onap/so/infra/orchestrationTasks/{version}": {
+ "get": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "Get all orchestrationTasks",
+ "description": "",
+ "operationId": "getAllOrchestrationTasks",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
+ "get": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "Get orchestrationTask for a given taskId",
+ "description": "",
+ "operationId": "getOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}": {
+ "post": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "Create an orchestrationTask",
+ "description": "",
+ "operationId": "createOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
+ "put": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "update orchestrationTask for a given taskId",
+ "description": "",
+ "operationId": "updateOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
+ "delete": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "delete orchestrationTask for a given taskId",
+ "description": "",
+ "operationId": "deleteOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
+ "delete": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "delete orchestrationTask for a given taskId",
+ "description": "",
+ "operationId": "deleteOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit": {
+ "post": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "commit orchestrationTask for a given taskId",
+ "description": "",
+ "operationId": "commitOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort": {
+ "post": {
+ "tags": [
+ "onapsoinfraorchestrationTasks"
+ ],
+ "summary": "abort orchestrationTask for a given taskId",
+ "description": "",
+ "operationId": "abortOrchestrationTask",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
"/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete": {
"post": {
"tags": [
@@ -2299,4 +2594,4 @@
}
}
}
-} \ No newline at end of file
+}