diff options
20 files changed, 3064 insertions, 14 deletions
diff --git a/docs/clamp/clamp.rst b/docs/clamp/clamp.rst index 9fe6190f..3c6a9105 100644 --- a/docs/clamp/clamp.rst +++ b/docs/clamp/clamp.rst @@ -14,4 +14,5 @@ CLAMP handles control loops in two ways, either using built in ONAP Control Loop controlloop/controlloop controlloop/system-level-dialogues controlloop/defining-controlloops - + controlloop/controlloop-participant-protocol + controlloop/controlloop-rest-apis diff --git a/docs/clamp/controlloop/controlloop-participant-protocol.rst b/docs/clamp/controlloop/controlloop-participant-protocol.rst new file mode 100644 index 00000000..208c5659 --- /dev/null +++ b/docs/clamp/controlloop/controlloop-participant-protocol.rst @@ -0,0 +1,472 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +.. _controlloop-participant-protocol-label: + +The CLAMP Control Loop Participant Protocol +########################################### + +The CLAMP Control Loop Participant protocol is an asynchronous protocol that is used by the +CLAMP runtime to coordinate life cycle management of Control Loop instances. The protocol +supports the functions described in the sections below. + + +Protocol Dialogues +================== + +The protocol supports the dialogues described below. + +Participant Registration and De-Registration +-------------------------------------------- + +Registration when a participant comes up and update of participant with control loop type +information and common parameter values for its control loop types. + +.. image:: images/clamp-cl-participants/participant-registering.png + + +De-registration is executed as a participant goes down. + +.. image:: images/clamp-cl-participants/participant-deregistration.png + + +Control Loop Priming and De-Priming +----------------------------------- + +When a control loop is primed, the portion of the Control Loop Type Definition and Common +Property values for the participants of each participant type mentioned in the Control Loop +Definition are sent to the participants. + +.. image:: images/clamp-cl-participants/controlloop-priming.png + +When a control loop is de-primed, the portion of the Control Loop Type Definition and Common +Property values for the participants of each participant type mentioned in the Control Loop +Definition are deleted on participants. + +.. image:: images/clamp-cl-participants/controlloop-depriming.png + + +Control Loop Update +------------------- + +Control Loop Update handles creation, change, and deletion of control loops on participants. +Change of control loops uses a semantic versioning approach and follow the semantics described +on the page `4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>`. + +.. image:: images/clamp-cl-participants/controlloop-update.png + +The handling of a ControlLoopUpdate message in each participant is as shown below. + +.. image:: images/clamp-cl-participants/controlloop-update-msg.png + +Control Loop State Change +------------------------- + +This dialogue is used to change the state of Control Loops and their Control Loop Elements. The +CLAMP Runtime sends a Control Loop State Change message on the control loop to all participants. +Participants that have Control Loop Elements in that Control Loop attempt an update on the state +of the control loop elements they have for that control loop, and report the result back. + +The *startPhase* in the `Definition of TOSCA fundamental Control Loop Types +<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_ +is particularly important in control loop state changes because sometime the user wishes to control +the order in which the state changes in Control Loop Elements in a control loop. In state changes +from *UNITITIALISED* → *PASSIVE* and from *PASSIVE* → *RUNNING*, control loop elements are started in +increasing order of their *startPhase*. In state changes from *RUNNING* → *PASSIVE* and from *PASSIVE* +→ *UNITITIALISED*, control loop elements are started in decreasing order of their *startPhase*. + +The CLAMP runtime controls the state change process described in the diagram below. The CLAMP runtime +sends a Control Loop State Change message on DMaaP to all participants in a particular Start Phase so, +in each state change multiple Control Loop State Change messages are sent, one for each Start Phase in +the control loop. If more than one Control Loop Element has the same Start Phase, those Control Loop +Elements receive the same Control Loop State Change message from DMaaP and start in parallel. + +The Participant reads each State Change Message it sees on DMaaP. If the Start Phase on the Control +Loop State Change message matches the Start Phase of the Control Loop Element, the participant processes +the State Change message. Otherwise the participant ignores the message. + +.. image:: images/clamp-cl-participants/controlloop-state-change.png + +The handling of a ControlLoopStateChange message in each participant is as shown below. + +.. image:: images/clamp-cl-participants/controlloop-state-change-msg.png + +Control Loop Monitoring and Reporting +------------------------------------- + +This dialogue is used as a heartbeat mechanism for participants, to monitor the status of Control Loop +Elements, and to gather statistics on control loops. The ParticipantStatus message is sent periodically +by each participant. The reporting interval for sending the message is configurable. + +.. image:: images/clamp-cl-participants/controlloop-monitoring.png + + +Messages +======== + +The CLAMP Control Loop Participant Protocol uses the following messages. The descriptions below give +an overview of each message. For the precise definition of the messages, see the `CLAMP code at Github +<https://github.com/onap/policy-clamp/tree/master/models/src/main/java/org/onap/policy/clamp/controlloop/models/messages/dmaap/participant>`_ +. All messages are carried on DMaaP. + + +.. list-table:: + :widths: 15 10 10 15 15 35 + :header-rows: 1 + + * - Message + - Source + - Target + - Purpose + - Important Fields + - Field Descriptions + * - ParticipantRegister + - Participant + - CLAMP Runtime + - Participant registers with the CLAMP runtime + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - ParticipantRegisterAck + - CLAMP Runtime + - Participant + - Acknowledgement of Participant Registration + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantUpdate + - CLAMP Runtime + - Participant + - CLAMP Runtime sends Control Loop Element Definitions and Common Parameter Values to Participants + - ParticipantDefinitionUpdateMap + - Map with Participant ID as its key, each value on the map is a ControlLoopElementDefintionMap + * - + - + - + - + - ControlLoopElementDefintionMap + - List of ControlLoopElementDefinition values for a particular participant, keyed by its Control + Loop Element Definition ID + * - + - + - + - + - ControlLoopElementDefinition + - A ControlLoopElementToscaServiceTemplate containing the definition of the Control Loop Element + and a CommonPropertiesMap with the values of the common property values for Control Loop Elements + of this type + * - + - + - + - + - ControlLoopElementToscaServiceTemplate + - The definition of the Control Loop Element in TOSCA + * - + - + - + - + - CommonPropertiesMap + - A <String, String> map indexed by the property name. Each map entry is the serialized value of + the property, which can be deserialized into an instance of the type of the property. + * - ParticipantUpdateAck + - Participant + - CLAMP Runtime + - Acknowledgement of Participant Update + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantDeregister + - Participant + - CLAMP Runtime + - Participant deregisters with the CLAMP runtime + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - ParticipantDeregisterAck + - CLAMP Runtime + - Participant + - Acknowledgement of Participant Deegistration + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ControlLoopUpdate + - CLAMP Runtime + - Participant + - CLAMP Runtime sends Control Loop Element instances and Instance Specific Parameter Values for + a Control Loop Instance to Participants + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - ParticipantUpdateMap + - Map with Participant ID as its key, each value on the map is a ControlLoopElementList + * - + - + - + - + - ControlLoopElementList + - List of ControlLoopElement values for the Control Loop + * - + - + - + - + - ControlLoopElement + - A ControlLoopElement, which contains among other things a PropertiesMap with the values of the + property values for this Control Loop Element instance and a ToscaServiceTemplateFragment with + extra concept definitions and instances that a participant may need. + * - + - + - + - + - PropertiesMap + - A <String, String> map indexed by the property name. Each map entry is the serialized value of + the property, which can be deserialized into an instance of the type of the property. + * - + - + - + - + - ToscaServiceTemplateFragment + - A well-formed TOSCA service template containing extra concept definitions and instances that a + participant may need. For example, the Policy Participant may need policy type definitions or + policy instances to be provided if they are not already stored in the Policy Framework. + * - ControlLoopUpdateAck + - Participant + - CLAMP Runtime + - Acknowledgement of Control Loop Update + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - ControlLoopResult + - Holds a Result and Message for the overall operation on the participant and a map of Result + and Message fields for each Control Loop Element of the control loop on this participant + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ControlLoopStateChange + - CLAMP Runtime + - Participant + - CLAMP Runtime asks Participants to change the state of a Control Loop + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - currentState + - The current state of the Control Loop + * - + - + - + - + - orderedState + - The state that the Control Loop should transition to + * - + - + - + - + - startPhase + - The start phase to which this ControLoopStateChange message applies + * - ControlLoopStateChangeAck + - Participant + - CLAMP Runtime + - Acknowledgement of Control Loop State Change + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop Type + Definitions + * - + - + - + - + - ControlLoopId + - The name and version of the Control Loop + * - + - + - + - + - startPhase + - The start phase to which this ControLoopStateChangeAck message applies + * - + - + - + - + - ControlLoopResult + - Holds a Result and Message for the overall operation on the participant and a map of Result and + Message fields for each Control Loop Element of the control loop on this participant + * - + - + - + - + - Result + - Success/Fail + * - + - + - + - + - Message + - Message indicating reason for failure + * - ParticipantStatusReq + - CLAMP Runtime + - Participant + - Request that the specified participants return a ParticipantStatus message immediately + - ParticipantId + - The ID of this participant, if not specified, all participants respond. + * - ParticipantStatus + - Participant + - CLAMP Runtime + - Periodic or on-demand report for heartbeat, Participant Status, Control Loop Status, and Control + Loop Statistics + - ParticipantId + - The ID of this participant + * - + - + - + - + - ParticipantType + - The type of the participant, maps to the capabilities of the participant in Control Loop + Type Definitions + * - + - + - + - + - ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only) + - See ParticipantUpdate message above for definition of this field + * - + - + - + - + - ParticipantStatus + - The current status of the participant for monitoring + * - + - + - + - + - ParticipantStatistics + - Statistics on the participant such as up time, or messages processed. Can include participant + specific data in a string blob that is opaque to CLAMP + * - + - + - + - + - ControlLoopInfoMap + - A map of ControlLoopInfo types indexed by ControlLoopId, one entry for each control loop + running on the participant + * - + - + - + - + - ControlLoopInfo + - The ControlLoopStatus and ControlLoopStatistics for a given control loop + * - + - + - + - + - ControlLoopStatus + - The current status of the control loop for monitoring + * - + - + - + - + - ControlLoopStatistics + - Statistics on the control loop such as up time, or messages processed. Can include participant + specific data in a string blob that is opaque to CLAMP + + +End of Document diff --git a/docs/clamp/controlloop/controlloop-rest-apis.rst b/docs/clamp/controlloop/controlloop-rest-apis.rst new file mode 100644 index 00000000..1012e53f --- /dev/null +++ b/docs/clamp/controlloop/controlloop-rest-apis.rst @@ -0,0 +1,130 @@ +.. 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.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/controlloop/controlloop.rst b/docs/clamp/controlloop/controlloop.rst index a505abfe..4cf242ba 100644 --- a/docs/clamp/controlloop/controlloop.rst +++ b/docs/clamp/controlloop/controlloop.rst @@ -453,8 +453,8 @@ The APIs and Protocols used by CLAMP for Control Loops are described on the page #. :ref:`System Level Dialogues <system-level-label>` #. :ref:`Defining Control Loops in TOSCA for CLAMP <defining-controlloops-label>` -#. REST APIs for CLAMP Control Loops -#. The CLAMP Control Loop Participant Protocol +#. :ref:`The CLAMP Control Loop Participant Protocol <controlloop-participant-protocol-label>` +#. :ref:`REST APIs for CLAMP Control Loops <controlloop-rest-apis-label>` 6 Design and Implementation diff --git a/docs/clamp/controlloop/defining-controlloops.rst b/docs/clamp/controlloop/defining-controlloops.rst index 66a67cec..dad5ff1a 100644 --- a/docs/clamp/controlloop/defining-controlloops.rst +++ b/docs/clamp/controlloop/defining-controlloops.rst @@ -261,21 +261,16 @@ In the case of the Gentle Guidance control loop, we define a Control Loop Elemen for each part of the domain logic we are managing. We then define the Control Loop Node Template for the control loop itself. -The code fragment below shows the TOSCA Topology Template for the Gentle Guidance domain when -no parameters are defined. Please refer to the `No Properties yaml file in Github +Please refer to the `No Properties yaml file in Github <https://github.com/onap/policy-clamp/blob/master/common/src/test/resources/gentleguidance/GentleGuidanceNoPropeties.yaml>`_ -for the definitive Yaml specification. +for the definitive Yaml specification for the TOSCA Topology Template for the Gentle Guidance +domain when no parameters are defined. -.. literalinclude:: files/gentle-cl-definition-example.yaml - :language: yaml - -The code fragment below shows the TOSCA Topology Template for the Gentle Guidance domain when -the default values of parameters are defined. Please refer to the `Default Properties yaml file in Github +Please refer to the `Default Properties yaml file in Github <https://github.com/onap/policy-clamp/blob/master/common/src/test/resources/gentleguidance/GentleGuidanceDefaultPropeties.yaml>`_ -for the definitive Yaml specification. +for the definitive Yaml specification for the TOSCA Topology Template for the Gentle Guidance +domain when the default values of parameters are defined. -.. literalinclude:: files/gentle-cl-definiftion-default-example.yaml - :language: yaml 4 Creating Custom Control Loop Elements ======================================== diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png Binary files differnew file mode 100644 index 00000000..16a923b1 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-depriming.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png Binary files differnew file mode 100644 index 00000000..f64fcd2e --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-monitoring.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png Binary files differnew file mode 100644 index 00000000..fa17429d --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-priming.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png Binary files differnew file mode 100644 index 00000000..dfcfe882 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change-msg.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png Binary files differnew file mode 100644 index 00000000..9ce9e490 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-state-change.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png Binary files differnew file mode 100644 index 00000000..e4c8ce84 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update-msg.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png Binary files differnew file mode 100644 index 00000000..be968dc7 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/controlloop-update.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png b/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png Binary files differnew file mode 100644 index 00000000..bb2ec9a3 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/participant-deregistration.png diff --git a/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png b/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png Binary files differnew file mode 100644 index 00000000..eeae2e02 --- /dev/null +++ b/docs/clamp/controlloop/images/clamp-cl-participants/participant-registering.png diff --git a/docs/clamp/controlloop/swagger/controlloop-comissioning.json b/docs/clamp/controlloop/swagger/controlloop-comissioning.json new file mode 100644 index 00000000..8fa09368 --- /dev/null +++ b/docs/clamp/controlloop/swagger/controlloop-comissioning.json @@ -0,0 +1,473 @@ +{ + "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/controlloop/swagger/controlloop-instantiation.json b/docs/clamp/controlloop/swagger/controlloop-instantiation.json new file mode 100644 index 00000000..12542425 --- /dev/null +++ b/docs/clamp/controlloop/swagger/controlloop-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/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/controlloop/swagger/controlloop-monitoring.json b/docs/clamp/controlloop/swagger/controlloop-monitoring.json new file mode 100644 index 00000000..84fbe7f0 --- /dev/null +++ b/docs/clamp/controlloop/swagger/controlloop-monitoring.json @@ -0,0 +1,521 @@ +{ + "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/monitoring/clelement": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of the requested cl element stats", + "description": "Queries details of the requested cl element stats, returning all clElement 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": "Control Loop 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/ClElementStatisticsList", + "originalRef": "ClElementStatisticsList" + } + }, + "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/controlloop/v2/monitoring/clelements/controlloop": { + "get": { + "tags": [ + "Clamp Control Loop 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", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop 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/ClElementStatisticsList", + "originalRef": "ClElementStatisticsList" + } + }, + "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/controlloop/v2/monitoring/participant": { + "get": { + "tags": [ + "Clamp Control Loop 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": "Control Loop 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": "Control Loop 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": "Dublin" + } + } + }, + "/onap/controlloop/v2/monitoring/participants/controlloop": { + "get": { + "tags": [ + "Clamp Control Loop Monitoring API" + ], + "summary": "Query details of all the participant stats in a control loop", + "description": "Queries details of the participant stats, returning all participant stats", + "operationId": "queryParticipantStatisticsPerControlLoopUsingGET", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Control Loop name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Control Loop 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": "Dublin" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/k8sparticipant.json b/docs/clamp/controlloop/swagger/k8sparticipant.json new file mode 100644 index 00000000..ae06b06d --- /dev/null +++ b/docs/clamp/controlloop/swagger/k8sparticipant.json @@ -0,0 +1,392 @@ +{ + "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/k8sparticipant/helm/chart/{name}/{version}": { + "delete": { + "tags": [ + "k8s-participant" + ], + "summary": "Delete the chart", + "operationId": "deleteChartUsingDELETE", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "204": { + "description": "Chart Deleted" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/onap/k8sparticipant/helm/charts": { + "get": { + "tags": [ + "k8s-participant" + ], + "summary": "Return all Charts", + "operationId": "getAllChartsUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "chart List", + "schema": { + "$ref": "#/definitions/ChartList", + "originalRef": "ChartList" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/install": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Install the chart", + "operationId": "installChartUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "info", + "description": "info", + "required": true, + "schema": { + "$ref": "#/definitions/InstallationInfo", + "originalRef": "InstallationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "chart Installed", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/onboard/chart": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Onboard the Chart", + "operationId": "onboardChartUsingPOST", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "chart", + "in": "formData", + "required": false, + "type": "file" + }, + { + "name": "info", + "in": "formData", + "required": false, + "type": "string" + }, + { + "in": "body", + "name": "values", + "description": "values", + "required": false, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Chart Onboarded", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/repo": { + "post": { + "tags": [ + "k8s-participant" + ], + "summary": "Configure helm repository", + "operationId": "configureRepoUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "repo", + "description": "repo", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "Repository added", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/uninstall/{name}/{version}": { + "delete": { + "tags": [ + "k8s-participant" + ], + "summary": "Uninstall the Chart", + "operationId": "uninstallChartUsingDELETE", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "name", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "201": { + "description": "chart Uninstalled", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + } + }, + "definitions": { + "ChartInfo": { + "type": "object", + "properties": { + "chartId": { + "$ref": "#/definitions/ToscaConceptIdentifier", + "originalRef": "ToscaConceptIdentifier" + }, + "namespace": { + "type": "string" + }, + "overrideParams": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "releaseName": { + "type": "string" + }, + "repository": { + "$ref": "#/definitions/HelmRepository", + "originalRef": "HelmRepository" + } + }, + "title": "ChartInfo" + }, + "ChartList": { + "type": "object", + "properties": { + "charts": { + "type": "array", + "items": { + "$ref": "#/definitions/ChartInfo", + "originalRef": "ChartInfo" + } + } + }, + "title": "ChartList" + }, + "HelmRepository": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "password": { + "type": "string" + }, + "port": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "repoName": { + "type": "string" + }, + "userName": { + "type": "string" + } + }, + "title": "HelmRepository" + }, + "InstallationInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "InstallationInfo" + }, + "ToscaConceptIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "ToscaConceptIdentifier" + } + } +}
\ No newline at end of file diff --git a/docs/clamp/controlloop/swagger/participant-sim.json b/docs/clamp/controlloop/swagger/participant-sim.json new file mode 100644 index 00000000..79fc3011 --- /dev/null +++ b/docs/clamp/controlloop/swagger/participant-sim.json @@ -0,0 +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" + } + }, + "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 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" + } + } + }, + "/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" + } + } + }, + "/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" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/xacml/decision-api.rst b/docs/xacml/decision-api.rst index 7d068c1e..8f6a9933 100644 --- a/docs/xacml/decision-api.rst +++ b/docs/xacml/decision-api.rst @@ -9,6 +9,10 @@ The Decision API is used by ONAP components that enforce policies and need a dec specific situation. The Decision API mimics closely the XACML request standard in that it supports a subject, action and resource. +When the PAP activates an xacml-pdp, the decision API becomes available. Conversely, when the PAP deactivates an xacml-pdp, the +decision API is disabled. The decision API is enabled/disabled by the PDP-STATE-CHANGE messages from PAP. If a request is made +to the decision API while it is deactivated, a "404 - Not Found" error will be returned. + .. csv-table:: :header: "Field", "Required", "XACML equivalent", "Description" |
