aboutsummaryrefslogtreecommitdiffstats
path: root/ccsdk-app-os/src/main/resources/swagger.json
diff options
context:
space:
mode:
authorKotagiri, Ramprasad (rp5662) <rp5662@att.com>2020-08-07 15:54:10 -0400
committerKotagiri, Ramprasad (rp5662) <rp5662@att.com>2020-08-12 12:38:26 -0400
commit09762dc92a06fb885f7055796db390a3a1baa535 (patch)
treee377c24a2cccb0a7d90b7b8560a7d8eef048a610 /ccsdk-app-os/src/main/resources/swagger.json
parentf796af3a840d0fd9319e3dfe45ef0e548cd90171 (diff)
CCSDK DCAE dashboard feature changes
Issue-ID: DCAEGEN2-1857 Issue-ID: DCAEGEN2-2074 Issue-ID: DCAEGEN2-2364 Change-Id: I97f5ec4599512ed848136971b11d4c2a137a4999 Signed-off-by: Kotagiri, Ramprasad (rp5662) <rp5662@att.com>
Diffstat (limited to 'ccsdk-app-os/src/main/resources/swagger.json')
-rw-r--r--ccsdk-app-os/src/main/resources/swagger.json186
1 files changed, 5 insertions, 181 deletions
diff --git a/ccsdk-app-os/src/main/resources/swagger.json b/ccsdk-app-os/src/main/resources/swagger.json
index 9335e72..7a02e5a 100644
--- a/ccsdk-app-os/src/main/resources/swagger.json
+++ b/ccsdk-app-os/src/main/resources/swagger.json
@@ -2,14 +2,14 @@
"swagger": "2.0",
"info": {
"description": "API to manage deployment of microservices using blueprints.",
- "version": "1.3.0",
+ "version": "1.4.0",
"title": "DCAE Dashboard API",
"contact": {
"email": "rp5662@att.com"
}
},
"host": "dcae-dashboard:8080",
- "basePath": "/ccsdk-app/nb-api",
+ "basePath": "/ccsdk-app/nb-api/v2",
"tags": [
{
"name": "Blueprints",
@@ -22,10 +22,6 @@
{
"name": "Tenants",
"description": "Query Cloudify Tenants"
- },
- {
- "name": "Components",
- "description": "Query on-boarded components"
}
],
"schemes": [
@@ -61,73 +57,12 @@
}
}
},
- "/components": {
- "get": {
- "tags": [
- "Components"
- ],
- "summary": "Lists all application components",
- "description": "Query all components from database",
- "operationId": "List Components",
- "produces": [
- "application/json"
- ],
- "parameters": [],
- "responses": {
- "200": {
- "description": "successful operation",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Component"
- }
- }
- },
- "400": {
- "description": "Invalid status value"
- }
- }
- },
- "post": {
- "tags": [
- "Components"
- ],
- "summary": "add an application component",
- "description": "Insert a component into database",
- "operationId": "Add Component",
- "consumes": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "New component input",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ComponentInput"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "successful operation",
- "schema": {
- "type": "object"
- }
- },
- "400": {
- "description": "Invalid status value"
- }
- }
- }
- },
"/deployments": {
"get": {
"tags": [
"Deployments"
],
- "summary": "Lists all Deployments",
+ "summary": "List all Deployments",
"description": "Query all deployments or Service objects from Inventory",
"operationId": "List Deployments",
"produces": [
@@ -287,7 +222,7 @@
"tags": [
"Deployments"
],
- "summary": "Gets a Deployment",
+ "summary": "Get a Deployment",
"description": "Query a deployment or Service object from Inventory",
"operationId": "Get Deployment",
"produces": [
@@ -318,51 +253,6 @@
}
}
},
- "/deployments/{deploymentId}/update": {
- "put": {
- "tags": [
- "Deployments"
- ],
- "summary": "Update an existing deployment",
- "description": "Dispatch a request to Deployment handler mS to use Cloudify deployment update operation ",
- "operationId": "Update Deployment",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "name": "deploymentId",
- "in": "path",
- "description": "ID of deployment to update",
- "required": true,
- "type": "string"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Inputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeploymentInput"
- }
- }
- ],
- "responses": {
- "400": {
- "description": "Invalid ID supplied"
- },
- "404": {
- "description": "Deployment not found"
- },
- "405": {
- "description": "Validation exception"
- }
- }
- }
- },
"/deployments/{deploymentId}/executions": {
"get": {
"tags": [
@@ -622,56 +512,6 @@
}
}
}
- },
- "/blueprints/findByName": {
- "get": {
- "tags": [
- "Blueprints"
- ],
- "summary": "Find a blueprint by a name pattern",
- "description": "Fetch the blueprint objects from inventory whose names match a string pattern",
- "operationId": "Get Blueprint",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "query",
- "description": "name pattern to filter by",
- "required": true,
- "type": "string"
- },
- {
- "name": "_include",
- "in": "query",
- "description": "blueprint object properties need to be considered for filter",
- "required": false,
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "typeName",
- "typeId",
- "typeVersion"
- ],
- "default": "typeName"
- },
- "collectionFormat": "multi"
- }
- ],
- "responses": {
- "200": {
- "description": "List of `DCAEServiceType` objects",
- "schema": {
- "$ref": "#/definitions/InlineResponse200"
- }
- },
- "400": {
- "description": "Invalid tag value"
- }
- }
- }
}
},
"responses": {
@@ -694,22 +534,6 @@
}
}
},
- "Component": {
- "type": "object",
- "properties": {
- "compId": {
- "type": "integer"
- },
- "cname": {
- "type": "string",
- "description": "component namespace name"
- },
- "dname": {
- "type": "string",
- "description": "component display name"
- }
- }
- },
"ComponentInput": {
"type": "object",
"properties": {
@@ -1218,4 +1042,4 @@
"description": "Find out more about Swagger",
"url": "http://swagger.io"
}
-}
+} \ No newline at end of file