docs/clamp/acm/files/acm-datatypes.yaml

   1 data_types:
   2   onap.datatypes.ToscaConceptIdentifier:
   3     derived_from: tosca.datatypes.Root
   4     properties:
   5       name:
   6         type: string
   7         required: true
   8       version:
   9         type: string
  10         required: true
  11
  12   onap.datatypes.clamp.acm.httpAutomationCompositionElement.RestRequest:
  13     version: 1.0.0
  14     derived_from: tosca.datatypes.Root
  15     properties:
  16       restRequestId:
  17         type: onap.datatypes.ToscaConceptIdentifier
  18         required: true
  19         description: The name and version of a REST request to be sent to a REST endpoint
  20       httpMethod:
  21         type: string
  22         required: true
  23         constraints:
  24           - valid_values:
  25               - POST
  26               - PUT
  27               - GET
  28               - DELETE
  29         description: The REST method to use
  30       path:
  31         type: string
  32         required: true
  33         description: The path of the REST request relative to the base URL
  34       body:
  35         type: string
  36         required: false
  37         description: The body of the REST request for PUT and POST requests
  38       expectedResponse:
  39         type: integer
  40         required: true
  41         constraints: []
  42         description: THe expected HTTP status code for the REST request
  43   onap.datatypes.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
  44     version: 1.0.0
  45     derived_from: tosca.datatypes.Root
  46     properties:
  47       configurationEntityId:
  48         type: onap.datatypes.ToscaConceptIdentifier
  49         required: true
  50         description:
  51           The name and version of a Configuration Entity to be handled
  52           by the HTTP Automation Composition Element
  53       restSequence:
  54         type: list
  55         entry_schema:
  56           type: onap.datatypes.clamp.acm.httpAutomationCompositionElement.RestRequest
  57           type_version: 1.0.0
  58         description: A sequence of REST commands to send to the REST endpoint