diff options
Diffstat (limited to 'docs/clamp/acm/api-protocol')
| -rw-r--r-- | docs/clamp/acm/api-protocol/acm-rest-apis.rst | 88 | ||||
| -rw-r--r-- | docs/clamp/acm/api-protocol/swagger/acm-comissioning.json | 709 | ||||
| -rw-r--r-- | docs/clamp/acm/api-protocol/swagger/acm-instantiation.json | 1511 | ||||
| -rw-r--r-- | docs/clamp/acm/api-protocol/swagger/acm-monitoring.json | 521 |
4 files changed, 36 insertions, 2793 deletions
diff --git a/docs/clamp/acm/api-protocol/acm-rest-apis.rst b/docs/clamp/acm/api-protocol/acm-rest-apis.rst index 1770c756..4a360caa 100644 --- a/docs/clamp/acm/api-protocol/acm-rest-apis.rst +++ b/docs/clamp/acm/api-protocol/acm-rest-apis.rst @@ -9,19 +9,22 @@ 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 +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 +The body of the *create* and *update* endpoints is a TOSCA Service/Topology template that +defines the new or changed Automation Composition Type. The *update* and *delete* endpoints take a +UUID 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. +An endpoint is used for *priming* or *depriming* an Automation Composition Definition, and it sends +the Automation Composition Element Types to the participants. +:ref:`More info here<clamp-runtime-acm>`. .. csv-table:: :header: "Commissioning API" - :widths: 10 + :widths: 10 `ACM-R Commissioning Swagger <./local-swagger.html#tag/Automation-Composition-Definition>`_ @@ -34,47 +37,40 @@ 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. +This 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 and needs the UUID of the Automation Composition Type. +The endpoints for *read* and *delete* take a Automation Composition Type +UUID to determine which Automation Composition Type to act on, and if specified the UUID of the +Automation Composition Instance. +For the *delete* endpoint it needs both the UUID of the Automation Composition Type and UUID of the +Automation Composition Instance, and 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>`. - -.. csv-table:: - :header: "Instantiation API" - :widths: 10 +here: :ref:`Issues AC instance to change status<clamp-runtime-acm>`. - `ACM-R Instantiation Swagger <./local-swagger.html#tag/Automation-Composition-Instance>`_ - - -Instantiation Automation Composition Instance Lifecycle Management ------------------------------------------------------------------- - -This sub API is used to manage the lifecycle of Automation Composition Instances. An Automation +The endpoint to issue Automation Composition Instances to change status 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 +The 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 +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 +The 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 @@ -82,19 +78,21 @@ execute the state change and report the result using the protocols described her 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. +.. csv-table:: + :header: "Instantiation API" + :widths: 10 + + `ACM-R Instantiation Swagger <./local-swagger.html#tag/Automation-Composition-Instance>`_ .. _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. +The Monitoring API allows the information and status of *Participants*, *Automation Composition +Instances* and their *Automation Composition Elements* to be monitored, via an hearthbeat report. +The API provides filtering so that specific Participants and Automation Composition Instances +can be retrieved. .. csv-table:: :header: "Monitoring API" @@ -102,18 +100,4 @@ scoped. `ACM-R Monitoring Swagger <./local-swagger.html#tag/Participant-Monitoring>`_ - -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. - - 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 deleted file mode 100644 index 3ab03bc0..00000000 --- a/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json +++ /dev/null @@ -1,709 +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/policy/clamp/acm/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/policy/clamp/acm/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/policy/clamp/acm/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/policy/clamp/acm/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 deleted file mode 100644 index 092b6ea6..00000000 --- a/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json +++ /dev/null @@ -1,1511 +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/policy/clamp/acm/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/policy/clamp/acm/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" - } - } - }, - "/onap/policy/clamp/acm/v2/instantiationState":{ - "get":{ - "tags":[ - "Clamp Automation Composition Instantiation API" - ], - "summary":"Query details of the requested automation compositions", - "description":"Queries details of requested automation compositions, returning all automation composition details", - "operationId":"getInstantiationOrderStateUsingGET", - "produces":[ - "application/json", - "application/yaml" - ], - "parameters":[ - { - "name":"name", - "in":"query", - "description":"Automation composition name", - "required":false, - "type":"string" - }, - { - "name":"version", - "in":"query", - "description":"Automation composition 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/AutomationCompositionOrderStateResponse", - "originalRef":"AutomationCompositionOrderStateResponse" - } - }, - "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" - } - } - } - }, - "responsesObject":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/AutomationCompositionOrderStateResponse", - "originalRef":"AutomationCompositionOrderStateResponse" - } - }, - "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/policy/clamp/acm/v2/instanceProperties":{ - "post":{ - "tags":[ - "Clamp Automation Composition Instantiation API" - ], - "summary":"Saves instance properties", - "description":"Saves instance properties, returning the saved instances properties and it's version", - "operationId":"createInstancePropertiesUsingPOST", - "consumes":[ - "application/json", - "application/yaml" - ], - "produces":[ - "application/json", - "application/yaml" - ], - "parameters":[ - { - "in":"body", - "name":"body", - "description":"Body of instance properties", - "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/InstancePropertiesResponse", - "originalRef":"InstancePropertiesResponse" - } - }, - "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" - } - } - } - }, - "responsesObject":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/InstancePropertiesResponse", - "originalRef":"InstancePropertiesResponse" - } - }, - "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 instance properties", - "description":"Updates instance properties, returning the saved instances properties and it's version", - "operationId":"updatesInstancePropertiesUsingPUT", - "consumes":[ - "application/json", - "application/yaml" - ], - "produces":[ - "application/json", - "application/yaml" - ], - "parameters":[ - { - "in":"body", - "name":"body", - "description":"Body of instance properties", - "required":true, - "schema":{ - "$ref":"#/definitions/ToscaServiceTemplateReq", - "originalRef":"ToscaServiceTemplateReq" - } - }, - { - "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/InstancePropertiesResponse", - "originalRef":"InstancePropertiesResponse" - } - }, - "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" - } - } - } - }, - "responsesObject":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/InstancePropertiesResponse", - "originalRef":"InstancePropertiesResponse" - } - }, - "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 and instance properties", - "description":"Deletes a automation composition and instance properties, returning optional error details", - "operationId":"deleteInstancePropertiesUsingDELETE", - "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" - } - } - } - }, - "responsesObject":{ - "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/policy/clamp/acm/v2/automationCompositionPriming":{ - "get":{ - "tags":[ - "Clamp Automation Composition Instantiation API" - ], - "summary":"Query priming details of the requested automation compositions", - "description":"Queries priming details of requested automation compositions, returning primed/deprimed compositions", - "operationId":"getAutomationCompositionPrimingUsingGET", - "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/AutomationCompositionPrimedResponse", - "originalRef":"AutomationCompositionPrimedResponse" - } - }, - "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" - } - } - } - }, - "responsesObject":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/AutomationCompositionPrimedResponse", - "originalRef":"AutomationCompositionPrimedResponse" - } - }, - "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-monitoring.json b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json deleted file mode 100644 index 2c23abec..00000000 --- a/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json +++ /dev/null @@ -1,521 +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/policy/clamp/acm/v2/monitoring/acelement": { - "get": { - "tags": [ - "Clamp Automation Composition Monitoring API" - ], - "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", - "application/yaml" - ], - "parameters": [ - { - "name": "endTime", - "in": "query", - "description": "end time", - "required": false, - "type": "string" - }, - { - "name": "id", - "in": "query", - "description": "Automation composition element id", - "required": false, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "Participant name", - "required": true, - "type": "string" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count", - "required": false, - "type": "integer", - "default": 0, - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "start time", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "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": { - "$ref": "#/definitions/AcElementStatisticsList", - "originalRef": "AcElementStatisticsList" - } - }, - "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/policy/clamp/acm/v2/monitoring/acelements/automationcomposition": { - "get": { - "tags": [ - "Clamp Automation Composition Monitoring API" - ], - "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" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Automation composition name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Automation composition 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/AcElementStatisticsList", - "originalRef": "AcElementStatisticsList" - } - }, - "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/policy/clamp/acm/v2/monitoring/participant": { - "get": { - "tags": [ - "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", - "operationId": "queryParticipantStatisticsUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "endTime", - "in": "query", - "description": "end time", - "required": false, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "Automation composition participant name", - "required": false, - "type": "string" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count", - "required": false, - "type": "integer", - "default": 0, - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "start time", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Automation composition participant 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/ParticipantStatisticsList", - "originalRef": "ParticipantStatisticsList" - } - }, - "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/policy/clamp/acm/v2/monitoring/participants/automationcomposition": { - "get": { - "tags": [ - "Clamp Automation Composition Monitoring API" - ], - "summary": "Query details of all the participant stats in a automation composition", - "description": "Queries details of the participant stats, returning all participant stats", - "operationId": "queryParticipantStatisticsPerAutomationCompositionUsingGET", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Automation composition name", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "query", - "description": "Automation composition 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/ParticipantStatisticsList", - "originalRef": "ParticipantStatisticsList" - } - }, - "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 |