diff options
Diffstat (limited to 'docs/api/swagger/swagger.json')
| -rw-r--r-- | docs/api/swagger/swagger.json | 325 |
1 files changed, 312 insertions, 13 deletions
diff --git a/docs/api/swagger/swagger.json b/docs/api/swagger/swagger.json index 5051ba19e9..bee195c402 100644 --- a/docs/api/swagger/swagger.json +++ b/docs/api/swagger/swagger.json @@ -9,7 +9,7 @@ "name": "e2eServiceInstances" }, { - "name": "3gppservices" + "name": "Onap3gppServiceInstances" }, { "name": "globalhealthcheck" @@ -21,6 +21,9 @@ "name": "onapsoinfraorchestrationRequests" }, { + "name": "onapsoinfraorchestrationTasks" + }, + { "name": "onapsoinfraserviceInstantiation" }, { @@ -164,6 +167,57 @@ } } }, + "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}": { + "post": { + "tags": [ + "e2eServiceInstances" + ], + "summary": "Activate/Deactivate 5G slice Service on a specified version and serviceId", + "description": "", + "operationId": "activateE2EServiceInstances", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][3-5]" + }, + { + "name": "serviceId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "operationType", + "in": "path", + "required": true, + "type": "string", + "pattern": "activate/deactivate" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": { "get": { "tags": [ @@ -294,7 +348,7 @@ "/onap/so/infra/3gppservices/{version}/allocate": { "post": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Create a 3GPP Service Instance on a version provided", "description": "", @@ -335,7 +389,7 @@ "/onap/so/infra/3gppservices/{version}/deAllocate": { "delete": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Terminate/Deallocate a 3GPP Service Instance on a version provided", "description": "", @@ -376,7 +430,7 @@ "/onap/so/infra/3gppservices/{version}/modify": { "put": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Modify a 3GPP Service Instance on a version provided", "description": "", @@ -417,7 +471,7 @@ "/onap/so/infra/3gppservices/{version}/activate": { "post": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Activate a 3GPP Service Instance on a version provided", "description": "", @@ -458,7 +512,7 @@ "/onap/so/infra/3gppservices/{version}/deActivate": { "post": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Deactivate a 3GPP Service Instance on a version provided", "description": "", @@ -499,7 +553,7 @@ "/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery": { "get": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Provides subnet capability based on subnet types", "description": "", @@ -687,6 +741,251 @@ } } }, + "/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" + } + } + }, + "post": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "Create an orchestrationTask", + "description": "", + "operationId": "createOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "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}": { + "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" + } + } + }, + "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]" + }, + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + }, + "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": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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": [ @@ -2678,11 +2977,11 @@ "type": "string", "enum": [ "AN", - "AN-NF", + "AN_NF", "CN", - "TN-FH", - "TN-MH", - "TN-BH" + "TN_FH", + "TN_MH", + "TN_BH" ] }, "3gppServiceResponse": { @@ -2699,9 +2998,9 @@ }, "statusDescription": { "description": "Description on status in case of erroneous response", - "type": "string" + "type": "object" } } } } -} +}
\ No newline at end of file |