diff options
author | adheli.tavares <adheli.tavares@est.tech> | 2022-04-05 14:21:40 +0100 |
---|---|---|
committer | Liam Fallon <liam.fallon@est.tech> | 2022-04-11 07:49:05 +0000 |
commit | 12a315f76a189a4d3a00d6f0335dccf979b9608a (patch) | |
tree | 4db364e1ae890b1a7b826a18046eafb9bb7f506a /docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json | |
parent | 21389fc50ae79f7f980534c2d2b5346744f4315c (diff) |
Updating Clamp documentation
- update rest apis definitions with renaming of control loop to acm
- rename control loop to automation composition
- fix a few cross-references missed
Issue-ID: POLICY-4063
Change-Id: Ib88074e1d2d08fe38da244b5e1eb2e5783c84a86
Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
Diffstat (limited to 'docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json')
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json | 473 |
1 files changed, 0 insertions, 473 deletions
diff --git a/docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json b/docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json deleted file mode 100644 index 8fa09368..00000000 --- a/docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json +++ /dev/null @@ -1,473 +0,0 @@ -{ - "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/controlloop/v2/commission": { - "get": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Query details of the requested commissioned control loop definitions", - "description": "Queries details of the requested commissioned control loop definitions, returning all control loop details", - "operationId": "queryUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop 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": "Dublin" - } - }, - "post": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Commissions control loop definitions", - "description": "Commissions control loop definitions, returning the commissioned control loop definition IDs", - "operationId": "createUsingPOST", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Entity Body of Control Loop", - "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": "Dublin" - } - }, - "delete": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Delete a commissioned control loop", - "description": "Deletes a Commissioned Control Loop, returning optional error details", - "operationId": "deleteUsingDELETE", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop 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": "Dublin" - } - } - }, - "/onap/controlloop/v2/commission/elements": { - "get": { - "tags": [ - "Clamp Control Loop Commissioning API" - ], - "summary": "Query details of the requested commissioned control loop element definitions", - "description": "Queries details of the requested commissioned control loop element definitions, returning all control loop elements' details", - "operationId": "queryElementsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Control Loop definition name", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Control Loop 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": "Dublin" - } - } - } - } -}
\ No newline at end of file |