diff options
author | Liam Fallon <liam.fallon@est.tech> | 2022-04-11 08:41:34 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2022-04-11 08:41:34 +0000 |
commit | 4236d55e6df1c17318995a65ad0a6e9411462456 (patch) | |
tree | c6a15d454197468cfe5a1335a5369bb7f4438296 /docs/clamp/acm/api-protocol | |
parent | c2e24ec6c9a3dab70f707744aa5bfda4f078b92e (diff) | |
parent | 12a315f76a189a4d3a00d6f0335dccf979b9608a (diff) |
Merge "Updating Clamp documentation"
Diffstat (limited to 'docs/clamp/acm/api-protocol')
-rw-r--r-- | docs/clamp/acm/api-protocol/acm-rest-apis.rst | 130 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/api-protocol-tree.rst | 2 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/controlloop-rest-apis.rst | 130 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/acm-comissioning.json | 815 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/acm-instantiation.json | 584 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/acm-monitoring.json (renamed from docs/clamp/acm/api-protocol/swagger/controlloop-monitoring.json) | 60 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.json | 473 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/controlloop-instantiation.json | 584 | ||||
-rw-r--r-- | docs/clamp/acm/api-protocol/swagger/participant-sim.json | 932 |
9 files changed, 2026 insertions, 1684 deletions
diff --git a/docs/clamp/acm/api-protocol/acm-rest-apis.rst b/docs/clamp/acm/api-protocol/acm-rest-apis.rst new file mode 100644 index 00000000..b71dae95 --- /dev/null +++ b/docs/clamp/acm/api-protocol/acm-rest-apis.rst @@ -0,0 +1,130 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _acm-rest-apis-label: + +REST APIs for CLAMP Automation Compositions +########################################### + + +Commissioning API +================= + +This API is a CRUD API that allows Automation Composition Type definitions created in a design +environment to be commissioned on the CLAMP runtime. It has endpoints that allow Automation +Composition Types to be created, read, updated, and deleted. + +The body of the create and update end points is a TOSCA Service/Topology template that +defines the new or changed Automation Composition Type. The update and delete endpoints take a +reference to the Automation Composition Type. The incoming TOSCA is verified and checked for +referential integrity. On delete requests, a check is made to ensure that no Automation +Composition Instances exist for the Automation Composition Type to be deleted. + +.. swaggerv2doc:: swagger/acm-comissioning.json + + +Instantiation API +================= + +The instantiation API has two functions: + +#. Creation, Reading, Update, and Deletion of Automation Composition Instances. +#. Instantiation and lifecycle management of Automation Composition Instances on participants. + +The Instantiation API is used by the CLAMP GUI. + +Instantiation Automation Composition Instance CRUD +-------------------------------------------------- + +This sub API allows for the creation, read, update, and deletion of Automation Composition +Instances. The endpoints for create and update take a JSON body that describes the Automation +Composition Instance. The endpoints for read and delete take a Automation Composition Instance +ID to determine which Automation Composition Instance to act on. For the delete endpoint, a check +is made to ensure that the Automation Composition Instance is not instantiated on participants. + +A call to the update endpoint for a Automation Composition Instance follows the semantics described +here: :ref:`4.1 Management of Automation Composition Instance Configurations +<management-acm-instance-configs>`. + +.. swaggerv2doc:: swagger/acm-instantiation.json + + +Instantiation Automation Composition Instance Lifecycle Management +------------------------------------------------------------------ + +This sub API is used to manage the lifecycle of Automation Composition Instances. An Automation +Composition Instance can be in the states described here: :ref:`2.1 Automation Composition Instance +States <acm-instance-states>`. Managing the lifecycle of an Automation Composition Instance amounts +to steering the Automation Composition through its states. + +The sub API allows upgrades and downgrades of Automation Composition Instances to be pushed to +participants following the semantics described here: :ref:`4.1 Management of Automation Composition +Instance Configurations <management-acm-instance-configs>`. When the API is used to update the +participants on a Automation Composition Instance, the new/upgraded/downgraded definition of the +Automation Composition is pushed to the participants. Note that the API asks the participants in an +Automation Composition Instance to perform the update, it is the responsibility of the participants +to execute the update and report the result using the protocols described here: :ref:`CLAMP +Participants <clamp-acm-participants>`. The progress and result of an update can be monitored +using the :ref:`Monitoring API <monitoring-api>`. + +The sub API also allows a state change of an Automation Composition Instance to be ordered. The +required state of the Automation Composition Instance is pushed to participants in an Automation +Composition Instance using the API. Note that the API asks the participants in an Automation +Composition Instance to perform the state change, it is the responsibility of the participants to +execute the state change and report the result using the protocols described here: :ref:`CLAMP +Participants <clamp-acm-participants>`. The progress and result of a state change can be monitored +using the `Monitoring API <monitoring-api>`. + +.. warning:: + The Swagger for the Instantiation Lifecycle Management API will appear here. + +.. _monitoring-api: + +Monitoring API +============== + +The Monitoring API allows the state and statistics of Participants, Automation Composition +Instances and their Automation Composition Elements to be monitored. This API is used by the CLAMP +GUI. The API provides filtering so that specific Participants and Automation Composition Instances +can be retrieved. In addition, the quantity of statistical information to be returned can be +scoped. + +.. swaggerv2doc:: swagger/acm-monitoring.json + +Pass Through API +================ + +This API allows information to be passed to Automation Composition Elements in an Automation +Composition. + +.. warning:: + The requirements on this API are still under discussion. + +.. warning:: + The Swagger for the Pass Through API will appear here. + + +Participant Standalone API +========================== + +This API allows a Participant to run in standalone mode and to run standalone Automation +Composition Elements. + +Kubernetes participant can also be deployed as a standalone application and provides REST endpoints +for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts +to a Kubernetes cluster. It also allows to configure a remote repository in Kubernetes participant +for installing helm charts. User can onboard a helm chart along with the overrides YAML file, the +chart gets stored in the local chart directory of Kubernetes participants. The onboarded charts can +be installed and uninstalled. The GET API fetches all the available helm charts from the chart +storage. + +.. swaggerv2doc:: swagger/k8sparticipant.json + + +Participant Simulator API +========================= + +This API allows a Participant Simulator to be started and run for test purposes. + +.. swaggerv2doc:: swagger/participant-sim.json + +End of Document diff --git a/docs/clamp/acm/api-protocol/api-protocol-tree.rst b/docs/clamp/acm/api-protocol/api-protocol-tree.rst index 95ce8f08..7cccf87b 100644 --- a/docs/clamp/acm/api-protocol/api-protocol-tree.rst +++ b/docs/clamp/acm/api-protocol/api-protocol-tree.rst @@ -12,4 +12,4 @@ The sections below describe the APIs and Protocols used in TOSCA Control Loops. system-level-dialogues acm-participant-protocol - controlloop-rest-apis + acm-rest-apis diff --git a/docs/clamp/acm/api-protocol/controlloop-rest-apis.rst b/docs/clamp/acm/api-protocol/controlloop-rest-apis.rst deleted file mode 100644 index cef2c2fb..00000000 --- a/docs/clamp/acm/api-protocol/controlloop-rest-apis.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _controlloop-rest-apis-label: - -REST APIs for CLAMP Control Loops -################################# - - -Commissioning API -================= - -This API is a CRUD API that allows Control Loop Type definitions created in a design -environment to be commissioned on the CLAMP runtime. It has endpoints that allow Control -Loop Types to be created, read, updated, and deleted. - -The body of the create and update end points is a TOSCA Service/Topology template that -defines the new or changed Control Loop Type. The update and delete endpoints take a -reference to the Control Loop Type. The incoming TOSCA is verified and checked for -referential integrity. On delete requests, a check is made to ensure that no Control -Loop Instances exist for the Control Loop Type to be deleted. - -:download:`Download Policy Control Loop Commissioning API Swagger <swagger/controlloop-comissioning.json>` - -.. swaggerv2doc:: swagger/controlloop-comissioning.json - - -Instantiation API -================= - -The instantiation API has two functions: - -#. Creation, Reading, Update, and Deletion of Control Loop Instances. -#. Instantiation and lifecycle management of Control Loop Instances on participants - -The Instantiation API is used by the CLAMP GUI. - -Instantiation Control Loop Instance CRUD ----------------------------------------- - -This sub API allows for the creation, read, update, and deletion of Control Loop Instances. -The endpoints for create and update take a JSON body that describes the Control Loop Instance. -The endpoints for read and delete take a Control Loop Instance ID to determine which Control -Loop Instance to act on. For the delete endpoint, a check is made to ensure that the Control -Loop Instance is not instantiated on participants. - -A call to the update endpoint for a Control Loop Instance follow the semantics described here: -`4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>`. - -:download:`Download Policy Control Loop Instantiation API Swagger <swagger/controlloop-instantiation.json>` - -.. swaggerv2doc:: swagger/controlloop-instantiation.json - - -Instantiation Control Loop Instance Lifecycle Management --------------------------------------------------------- - -This sub API is used to manage the life cycle of Control Loop Instances. A Control Loop Instance -can be in the states described here: `2.1 Control Loop Instance States <controlloop-instance-states>`. -Managing the life cycle of a Control Loop Instance amounts to steering the Control Loop through -its states. - -The sub API allows upgrades and downgrades of Control Loop Instances to be pushed to participants -following the semantics described here: `4.1 Management of Control Loop Instance Configurations -<management-cl-instance-configs>`. When the API is used to update the participants on a Control -Loop Instance, the new/upgraded/downgraded definition of the Control Loop is pushed to the -participants. Note that the API asks the participants in a Control Loop Instance to perform the -update, it is the responsibility of the participants to execute the update and report the result -using the protocols described here: `CLAMP Participants <#>`_. The progress and result of an update -can be monitored using the `Monitoring API <monitoring-api>`. - -The sub API also allows a state change of a Control Loop Instance to be ordered. The required state -of the Control Loop Instance is pushed to participants in a Control Loop Instance using the API. -Note that the API asks the participants in a Control Loop Instance to perform the state change, it -is the responsibility of the participants to execute the state change and report the result using -the protocols described here: CLAMP Participants. The progress and result of a state change can be -monitored using the `Monitoring API <monitoring-api>`. - -.. warning:: - The Swagger for the Instantiation Lifecycle Management API will appear here. - -.. _monitoring-api: - -Monitoring API -============== - -The Monitoring API allows the state and statistics of Participants, Control Loop Instances and their Control Loop Elements to be monitored. This API is used by the CLAMP GUI. The API provides filtering so that specific Participants and Control Loop Instances can be retrieved. In addition, the quantity of statistical information to be returned can be scoped. - -:download:`Download Policy Control Loop Monitoring API Swagger <swagger/controlloop-monitoring.json>` - -.. swaggerv2doc:: swagger/controlloop-monitoring.json - -Pass Through API -================ - -This API allows information to be passed to Control Loop Elements in a control loop. - -.. warning:: - The requirements on this API are still under discussion. - -.. warning:: - The Swagger for the Pass Through API will appear here. - - -Participant Standalone API -========================== - -This API allows a Participant to run in standalone mode and to run standalone Control Loop Elements. - -Kubernetes participant can also be deployed as a standalone application and provides REST end points -for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts to -a kubernetes cluster. It also allows to configure a remote repository in kubernetes participant for -installing helm charts. User can onboard a helm chart along with the overrides yaml file, the chart -gets stored in to the local chart directory of kubernetes participant. The onboarded charts can be -installed, uninstalled. The GET API fetches all the available helm charts from the chart storage. - -:download:`Download Policy Control Loop Participant Standalone API Swagger <swagger/k8sparticipant.json>` - -.. swaggerv2doc:: swagger/k8sparticipant.json - - -Participant Simulator API -========================= - -This API allows a Participant Simulator to be started and run for test purposes. - -:download:`Download Policy Participant Simulator API Swagger <swagger/participant-sim.json>` - -.. swaggerv2doc:: swagger/participant-sim.json - -End of Document diff --git a/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json b/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json new file mode 100644 index 00000000..ab77bd9e --- /dev/null +++ b/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json @@ -0,0 +1,815 @@ +{ + "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" + } + } + } + } +}
\ No newline at end of file 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 diff --git a/docs/clamp/acm/api-protocol/swagger/controlloop-monitoring.json b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json index 84fbe7f0..2c177fa9 100644 --- a/docs/clamp/acm/api-protocol/swagger/controlloop-monitoring.json +++ b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json @@ -12,13 +12,13 @@ } }, "paths": { - "/onap/controlloop/v2/monitoring/clelement": { + "/onap/automationcomposition/v2/monitoring/acelement": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], - "summary": "Query details of the requested cl element stats", - "description": "Queries details of the requested cl element stats, returning all clElement stats", + "summary": "Query details of the requested acElement stats", + "description": "Queries details of the requested acElement stats, returning all acElement stats", "operationId": "queryElementStatisticsUsingGET", "produces": [ "application/json", @@ -35,7 +35,7 @@ { "name": "id", "in": "query", - "description": "Control Loop element id", + "description": "Automation composition element id", "required": false, "type": "string" }, @@ -82,8 +82,8 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClElementStatisticsList", - "originalRef": "ClElementStatisticsList" + "$ref": "#/definitions/AcElementStatisticsList", + "originalRef": "AcElementStatisticsList" } }, "401": { @@ -151,18 +151,18 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } }, - "/onap/controlloop/v2/monitoring/clelements/controlloop": { + "/onap/automationcomposition/v2/monitoring/acelements/automationcomposition": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], - "summary": "Query details of the requested cl element stats in a control loop", - "description": "Queries details of the requested cl element stats, returning all clElement stats", - "operationId": "queryElementStatisticsPerControlLoopUsingGET", + "summary": "Query details of the requested acElement stats in a automation composition", + "description": "Queries details of the requested acElement stats, returning all acElement stats", + "operationId": "queryElementStatisticsPerAutomationCompositionUsingGET", "produces": [ "application/json", "application/yaml" @@ -171,14 +171,14 @@ { "name": "name", "in": "query", - "description": "Control Loop name", + "description": "Automation composition name", "required": true, "type": "string" }, { "name": "version", "in": "query", - "description": "Control Loop version", + "description": "Automation composition version", "required": true, "type": "string" }, @@ -195,8 +195,8 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClElementStatisticsList", - "originalRef": "ClElementStatisticsList" + "$ref": "#/definitions/AcElementStatisticsList", + "originalRef": "AcElementStatisticsList" } }, "401": { @@ -264,14 +264,14 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } }, - "/onap/controlloop/v2/monitoring/participant": { + "/onap/automationcomposition/v2/monitoring/participant": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], "summary": "Query details of the requested participant stats", "description": "Queries details of the requested participant stats, returning all participant stats", @@ -291,7 +291,7 @@ { "name": "name", "in": "query", - "description": "Control Loop participant name", + "description": "Automation composition participant name", "required": false, "type": "string" }, @@ -314,7 +314,7 @@ { "name": "version", "in": "query", - "description": "Control Loop participant version", + "description": "Automation composition participant version", "required": false, "type": "string" }, @@ -400,18 +400,18 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } }, - "/onap/controlloop/v2/monitoring/participants/controlloop": { + "/onap/automationcomposition/v2/monitoring/participants/automationcomposition": { "get": { "tags": [ - "Clamp Control Loop Monitoring API" + "Clamp Automation Composition Monitoring API" ], - "summary": "Query details of all the participant stats in a control loop", + "summary": "Query details of all the participant stats in a automation composition", "description": "Queries details of the participant stats, returning all participant stats", - "operationId": "queryParticipantStatisticsPerControlLoopUsingGET", + "operationId": "queryParticipantStatisticsPerAutomationCompositionUsingGET", "produces": [ "application/json", "application/yaml" @@ -420,14 +420,14 @@ { "name": "name", "in": "query", - "description": "Control Loop name", + "description": "Automation composition name", "required": true, "type": "string" }, { "name": "version", "in": "query", - "description": "Control Loop version", + "description": "Automation composition version", "required": true, "type": "string" }, @@ -513,7 +513,7 @@ ], "x-interface info": { "api-version": "1.0.0", - "last-mod-release": "Dublin" + "last-mod-release": "Istanbul" } } } 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 diff --git a/docs/clamp/acm/api-protocol/swagger/controlloop-instantiation.json b/docs/clamp/acm/api-protocol/swagger/controlloop-instantiation.json deleted file mode 100644 index 12542425..00000000 --- a/docs/clamp/acm/api-protocol/swagger/controlloop-instantiation.json +++ /dev/null @@ -1,584 +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/instantiation": { - "get": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Query details of the requested control loops", - "description": "Queries details of the requested control loops, returning all control loop details", - "operationId": "queryUsingGET_1", - "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": { - "$ref": "#/definitions/ControlLoopsRes", - "originalRef": "ControlLoopsRes" - } - }, - "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 Instantiation API" - ], - "summary": "Commissions control loop definitions", - "description": "Commissions control loop definitions, returning the control loop IDs", - "operationId": "createUsingPOST_1", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "controlLoops", - "description": "Entity Body of Control Loop", - "required": true, - "schema": { - "$ref": "#/definitions/ControlLoopsReq", - "originalRef": "ControlLoopsReq" - } - }, - { - "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": "Dublin" - } - }, - "put": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Updates control loop definitions", - "description": "Updates control loop definitions, returning the updated control loop definition IDs", - "operationId": "updateUsingPUT", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "controlLoops", - "description": "Entity Body of Control Loop", - "required": true, - "schema": { - "$ref": "#/definitions/ControlLoopsReq", - "originalRef": "ControlLoopsReq" - } - }, - { - "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": "Dublin" - } - }, - "delete": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Delete a control loop", - "description": "Deletes a control loop, returning optional error details", - "operationId": "deleteUsingDELETE_1", - "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": 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/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": "Dublin" - } - } - }, - "/onap/controlloop/v2/instantiation/command": { - "put": { - "tags": [ - "Clamp Control Loop Instantiation API" - ], - "summary": "Issue a command to the requested control loops", - "description": "Issues a command to a control loop, ordering a state change on the control loop", - "operationId": "issueControlLoopCommandUsingPUT", - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "command", - "description": "Entity Body of control loop 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": "Dublin" - } - } - } - } -}
\ No newline at end of file diff --git a/docs/clamp/acm/api-protocol/swagger/participant-sim.json b/docs/clamp/acm/api-protocol/swagger/participant-sim.json index 79fc3011..2111b607 100644 --- a/docs/clamp/acm/api-protocol/swagger/participant-sim.json +++ b/docs/clamp/acm/api-protocol/swagger/participant-sim.json @@ -1,478 +1,478 @@ { - "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" + "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/participantsim/v2/elements": { + "put": { + "tags": [ + "Clamp Automation Composition Participant Simulator API" + ], + "summary": "Updates simulated automation composition elements", + "description": "Updates simulated automation composition elements, returning the updated automation composition definition IDs", + "operationId": "updateUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a automation composition element", + "required": true, + "schema": { + "$ref": "#/definitions/AutomationCompositionElementReq", + "originalRef": "AutomationCompositionElementReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TypedSimpleResponse«AutomationCompositionElement»", + "originalRef": "TypedSimpleResponse«AutomationCompositionElement»" + } + }, + "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" } + } }, - "paths": { - "/onap/participantsim/v2/elements": { - "put": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Updates simulated control loop elements", - "description": "Updates simulated control loop elements, returning the updated control loop definition IDs", - "operationId": "updateUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Body of a control loop element", - "required": true, - "schema": { - "$ref": "#/definitions/ControlLoopElementReq", - "originalRef": "ControlLoopElementReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TypedSimpleResponse«ControlLoopElement»", - "originalRef": "TypedSimpleResponse«ControlLoopElement»" - } - }, - "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" - } + "/onap/participantsim/v2/elements/{name}/{version}": { + "get": { + "tags": [ + "Clamp Automation Composition Participant Simulator API" + ], + "summary": "Query details of the requested simulated automation composition elements", + "description": "Queries details of the requested simulated automation composition elements, returning all automation composition element details", + "operationId": "elementsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Automation composition element name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Automation composition element 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": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AutomationCompositionElementRes", + "originalRef": "AutomationCompositionElementRes" + } } - }, - "/onap/participantsim/v2/elements/{name}/{version}": { - "get": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Query details of the requested simulated control loop elements", - "description": "Queries details of the requested simulated control loop elements, returning all control loop element details", - "operationId": "elementsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Control loop element name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "description": "Control loop element 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": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ControlLoopElementRes", - "originalRef": "ControlLoopElementRes" - } - } - }, - "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" - } + }, + "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" + } + } + } }, - "/onap/participantsim/v2/participants": { - "put": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Updates simulated participants", - "description": "Updates simulated participants, returning the updated control loop definition IDs", - "operationId": "updateUsingPUT_1", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Body of a participant", - "required": true, - "schema": { - "$ref": "#/definitions/ParticipantReq", - "originalRef": "ParticipantReq" - } - }, - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TypedSimpleResponse«Participant»", - "originalRef": "TypedSimpleResponse«Participant»" - } - }, - "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" - } + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants": { + "put": { + "tags": [ + "Clamp Automation Composition Participant Simulator API" + ], + "summary": "Updates simulated participants", + "description": "Updates simulated participants, returning the updated automation composition definition IDs", + "operationId": "updateUsingPUT_1", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Body of a participant", + "required": true, + "schema": { + "$ref": "#/definitions/ParticipantReq", + "originalRef": "ParticipantReq" + } + }, + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TypedSimpleResponse«Participant»", + "originalRef": "TypedSimpleResponse«Participant»" + } + }, + "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" + } + } + } }, - "/onap/participantsim/v2/participants/{name}/{version}": { - "get": { - "tags": [ - "Clamp Control Loop Participant Simulator API" - ], - "summary": "Query details of the requested simulated participants", - "description": "Queries details of the requested simulated participants, returning all participant details", - "operationId": "participantsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Participant name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "description": "Participant 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": { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantRes", - "originalRef": "ParticipantRes" - } - } - }, - "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" - } + "security": [ + { + "basicAuth": [] + } + ], + "x-interface info": { + "api-version": "1.0.0", + "last-mod-release": "Dublin" + } + } + }, + "/onap/participantsim/v2/participants/{name}/{version}": { + "get": { + "tags": [ + "Clamp Automation Composition Participant Simulator API" + ], + "summary": "Query details of the requested simulated participants", + "description": "Queries details of the requested simulated participants, returning all participant details", + "operationId": "participantsUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Participant name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Participant 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": { + "type": "array", + "items": { + "$ref": "#/definitions/ParticipantRes", + "originalRef": "ParticipantRes" + } + } + }, + "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 |