{ "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/commission": { "get": { "tags": [ "Clamp Automation Composition Commissioning API" ], "summary": "Query details of the requested commissioned automation composition definitions", "description": "Queries details of the requested commissioned automation composition definitions, returning all automation composition details", "operationId": "queryUsingGET", "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": { "type": "array", "items": { "$ref": "#/definitions/ToscaNodeTemplateRes", "originalRef": "ToscaNodeTemplateRes" } } }, "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 Commissioning API" ], "summary": "Commissions automation composition definitions", "description": "Commissions automation composition definitions, returning commissioned definition IDs", "operationId": "createUsingPOST", "consumes": [ "application/json", "application/yaml" ], "produces": [ "application/json", "application/yaml" ], "parameters": [ { "in": "body", "name": "body", "description": "Entity Body of Automation Composition", "required": true, "schema": { "$ref": "#/definitions/ToscaServiceTemplateReq", "originalRef": "ToscaServiceTemplateReq" } }, { "name": "X-ONAP-RequestID", "in": "header", "description": "RequestID for http transaction", "required": false, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommissioningResponse", "originalRef": "CommissioningResponse" } }, "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 Commissioning API" ], "summary": "Delete a commissioned automation composition", "description": "Deletes a Commissioned Automation Composition, returning optional error details", "operationId": "deleteUsingDELETE", "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/CommissioningResponse", "originalRef": "CommissioningResponse" } }, "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/commission/elements": { "get": { "tags": [ "Clamp Automation Composition Commissioning API" ], "summary": "Query details of the requested commissioned automation composition element definitions", "description": "Queries details of the requested commissioned automation composition element definitions, returning all automation composition elements' details", "operationId": "queryElementsUsingGET", "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": { "type": "array", "items": { "$ref": "#/definitions/ToscaNodeTemplateRes", "originalRef": "ToscaNodeTemplateRes" } } }, "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" } } }, "/onap/automationcomposition/v2/commission/getCommonOrInstanceProperties": { "get": { "tags": [ "Clamp Automation Composition Commissioning API" ], "summary": "Query details of the requested tosca service template common or instance properties", "description": "Queries details of the requested commissioned tosca service template json commonor instance properties, returning all tosca service template common or instance property details", "operationId": "queryToscaServiceCommonOrInstancePropertiesUsingGET", "produces": [ "application/json", "application/yaml" ], "parameters": [ { "name": "common", "in": "query", "description": "Flag, true for common properties, false for instance", "required": false, "type": "boolean", "default": false }, { "name": "name", "in": "query", "description": "Tosca service template name", "required": false, "type": "string" }, { "name": "version", "in": "query", "description": "Tosca service template 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": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ToscaNodeTemplateRes", "originalRef": "ToscaNodeTemplateRes" } } }, "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" } } }, "/onap/automationcomposition/v2/commission/toscaServiceTemplateSchema": { "get": { "tags": [ "Clamp Automation Composition Commissioning API" ], "summary": "Query details of the requested tosca service template json schema", "description": "Queries details of the requested commissioned tosca service template json schema, returning all tosca service template json schema details", "operationId": "queryToscaServiceTemplateJsonSchemaUsingGET", "produces": [ "application/json", "application/yaml" ], "parameters": [ { "name": "section", "in": "query", "description": "Section of Template schema is desired for", "required": false, "type": "string", "default": "all" }, { "name": "X-ONAP-RequestID", "in": "header", "description": "RequestID for http transaction", "required": false, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "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" } } }, "/onap/automationcomposition/v2/commission/toscaservicetemplate": { "get": { "tags": [ "Clamp Automation Composition Commissioning API" ], "summary": "Query details of the requested tosca service templates", "description": "Queries details of the requested commissioned tosca service template, returning all tosca service template details", "operationId": "queryToscaServiceTemplateUsingGET", "produces": [ "application/json", "application/yaml" ], "parameters": [ { "name": "name", "in": "query", "description": "Tosca service template name", "required": false, "type": "string" }, { "name": "version", "in": "query", "description": "Tosca service template 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": { "type": "string" } }, "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" } } } } }