summaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/clamp/acm/api-protocol/swagger/acm-instantiation.json')
-rw-r--r--docs/clamp/acm/api-protocol/swagger/acm-instantiation.json584
1 files changed, 584 insertions, 0 deletions
diff --git a/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json b/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json
new file mode 100644
index 00000000..cdad2b61
--- /dev/null
+++ b/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json
@@ -0,0 +1,584 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "description": "Api Documentation",
+ "version": "1.0",
+ "title": "Api Documentation",
+ "termsOfService": "urn:tos",
+ "contact": {},
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ }
+ },
+ "paths": {
+ "/onap/automationcomposition/v2/instantiation": {
+ "get": {
+ "tags": [
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary": "Query details of the requested automation compositions",
+ "description": "Queries details of the requested automation compositions, returning all composition details",
+ "operationId": "queryUsingGET_1",
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Automation composition definition name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "description": "Automation composition definition version",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "X-ONAP-RequestID",
+ "in": "header",
+ "description": "RequestID for http transaction",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AutomationCompositionsRes",
+ "originalRef": "AutomationCompositionsRes"
+ }
+ },
+ "401": {
+ "description": "Authentication Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "403": {
+ "description": "Authorization Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "basicAuth": []
+ }
+ ],
+ "x-interface info": {
+ "api-version": "1.0.0",
+ "last-mod-release": "Istanbul"
+ }
+ },
+ "post": {
+ "tags": [
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary": "Commissions automation composition definitions",
+ "description": "Commissions automation composition definitions, returning the automation composition IDs",
+ "operationId": "createUsingPOST_1",
+ "consumes": [
+ "application/json",
+ "application/yaml"
+ ],
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "automationCompositions",
+ "description": "Entity Body of automation composition",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AutomationCompositionsReq",
+ "originalRef": "AutomationCompositionsReq"
+ }
+ },
+ {
+ "name": "X-ONAP-RequestID",
+ "in": "header",
+ "description": "RequestID for http transaction",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/InstantiationResponse",
+ "originalRef": "InstantiationResponse"
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Authentication Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "403": {
+ "description": "Authorization Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "basicAuth": []
+ }
+ ],
+ "x-interface info": {
+ "api-version": "1.0.0",
+ "last-mod-release": "Istanbul"
+ }
+ },
+ "put": {
+ "tags": [
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary": "Updates automation composition definitions",
+ "description": "Updates automation composition definitions, returning the updated composition definition IDs",
+ "operationId": "updateUsingPUT",
+ "consumes": [
+ "application/json",
+ "application/yaml"
+ ],
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "automationCompositions",
+ "description": "Entity Body of Automation Composition",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AutomationCompositionsReq",
+ "originalRef": "AutomationCompositionsReq"
+ }
+ },
+ {
+ "name": "X-ONAP-RequestID",
+ "in": "header",
+ "description": "RequestID for http transaction",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/InstantiationResponse",
+ "originalRef": "InstantiationResponse"
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Authentication Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "403": {
+ "description": "Authorization Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "basicAuth": []
+ }
+ ],
+ "x-interface info": {
+ "api-version": "1.0.0",
+ "last-mod-release": "Istanbul"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary": "Delete a automation composition",
+ "description": "Deletes a automation composition, returning optional error details",
+ "operationId": "deleteUsingDELETE_1",
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Automation composition definition name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "description": "Automation composition definition version",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "X-ONAP-RequestID",
+ "in": "header",
+ "description": "RequestID for http transaction",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/InstantiationResponse",
+ "originalRef": "InstantiationResponse"
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Authentication Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "403": {
+ "description": "Authorization Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "basicAuth": []
+ }
+ ],
+ "x-interface info": {
+ "api-version": "1.0.0",
+ "last-mod-release": "Istanbul"
+ }
+ }
+ },
+ "/onap/automationcomposition/v2/instantiation/command": {
+ "put": {
+ "tags": [
+ "Clamp Automation Composition Instantiation API"
+ ],
+ "summary": "Issue a command to the requested automation compositions",
+ "description": "Issues a command to an automation composition, ordering a state change on the composition",
+ "operationId": "issueAutomationCompositionCommandUsingPUT",
+ "consumes": [
+ "application/json",
+ "application/yaml"
+ ],
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "command",
+ "description": "Entity Body of automation composition command",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/InstantiationCommand",
+ "originalRef": "InstantiationCommand"
+ }
+ },
+ {
+ "name": "X-ONAP-RequestID",
+ "in": "header",
+ "description": "RequestID for http transaction",
+ "required": false,
+ "type": "string",
+ "format": "uuid"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/InstantiationResponse",
+ "originalRef": "InstantiationResponse"
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Authentication Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "403": {
+ "description": "Authorization Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "headers": {
+ "X-LatestVersion": {
+ "type": "string"
+ },
+ "X-PatchVersion": {
+ "type": "string"
+ },
+ "X-MinorVersion": {
+ "type": "string"
+ },
+ "X-ONAP-RequestID": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "basicAuth": []
+ }
+ ],
+ "x-interface info": {
+ "api-version": "1.0.0",
+ "last-mod-release": "Istanbul"
+ }
+ }
+ }
+ }
+} \ No newline at end of file