summaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/swagger.json
diff options
context:
space:
mode:
authortragait <rahul.tyagi@est.tech>2021-01-14 16:07:07 +0000
committertragait <rahul.tyagi@est.tech>2021-01-14 16:07:13 +0000
commit5e9676e8319a1867976ce2a09c607681c3445887 (patch)
tree4ab27ca9fcd674c966024236484180407965cc55 /docs/api/swagger/swagger.json
parente998ae0a7cd16f53ade786fc83140d2e78e0892e (diff)
Fix swagger documentation for PNFSWU
Issue-ID: SO-3121 Signed-off-by: tragait <rahul.tyagi@est.tech> Change-Id: Ifb3a1eeb5f7a02aee4c72838b9692cad5f41b468
Diffstat (limited to 'docs/api/swagger/swagger.json')
-rw-r--r--docs/api/swagger/swagger.json155
1 files changed, 155 insertions, 0 deletions
diff --git a/docs/api/swagger/swagger.json b/docs/api/swagger/swagger.json
index 4ec404e0bd..0f2bd535b6 100644
--- a/docs/api/swagger/swagger.json
+++ b/docs/api/swagger/swagger.json
@@ -2940,6 +2940,62 @@
}
}
}
+ },
+ "/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/pnfs/${pnfName}/workflows/${workflow_UUID}": {
+ "post": {
+ "tags": [
+ "onapsoinfrainstanceManagement"
+ ],
+ "summary": "Executing download/activate custom workflow",
+ "description": "",
+ "operationId": "executePNFCustomWorkflow",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/PNFCustomWorkflowExecution"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "pnfName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workflow_UUID",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
}
},
"definitions": {
@@ -3256,6 +3312,105 @@
}
}
+ },
+ "PNFCustomWorkflowExecution": {
+ "description": "This describes the request body of PNF custom workflow execution",
+ "type": "object",
+ "properties": {
+ "requestInfo": {
+ "description": "Request object contains source information",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "Name of the sender",
+ "type": "string"
+ },
+ "suppressRollback": {
+ "description": "Enable/disable rollback suppression",
+ "type": "boolean"
+ },
+ "requestorId": {
+ "description": "Id of the sender",
+ "type": "string"
+ }
+ }
+ },
+ "modelInfo": {
+ "description": "Parameters related to the service model",
+ "type": "object",
+ "properties": {
+ "modelType": {
+ "description": "Type of the model to be executed",
+ "type": "string"
+ },
+ "modelInvariantUuid": {
+ "description": "Model invariant id corresponding to the service",
+ "type": "string"
+ },
+ "modelUuid": {
+ "description": "Model uuid corresponding to the service",
+ "type": "string"
+ },
+ "modelVersionId": {
+ "description": "Model version of the service instance",
+ "type": "string"
+ },
+ "modelName": {
+ "description": "Name of the service",
+ "type": "string"
+ },
+ "modelVersion": {
+ "description": "Version of the service instance",
+ "type": "string"
+ }
+ }
+ },
+ "requestParameters": {
+ "description": "User parameter object",
+ "type": "object",
+ "properties": {
+ "subscriptionServiceType": {
+ "description": "Type of service subscription",
+ "type": "string"
+ }
+ }
+ },
+ "subscriberInfo": {
+ "description": "Subscriber id information",
+ "type": "object",
+ "properties": {
+ "globalSubscriberId": {
+ "description": "Id of the subscriber sending the request",
+ "type": "string"
+ }
+ }
+ },
+ "project": {
+ "description": "Information about the target project name",
+ "type": "object",
+ "properties": {
+ "projectName":{
+ "description": "Name of the target project",
+ "type": "string"
+ }
+ }
+ },
+ "owningEntity": {
+ "description": "Object describes the entity details",
+ "type": "object",
+ "properties": {
+ "owningEntityId": {
+ "description": "Id of the owning Entity",
+ "type": "string"
+ },
+ "owningEntityName": {
+ "description": "Name of the owning Entity",
+ "type": "string"
+ }
+ }
+ }
+
+ }
}
}
} \ No newline at end of file