aboutsummaryrefslogtreecommitdiffstats
path: root/common/src/main/resources/tosca/HttpControlLoopElementType.yaml
blob: fd37040c65efbc0de9ec26e7c0e7f7edff39c13c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Nordix Foundation.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
tosca_definitions_version: tosca_simple_yaml_1_3
data_types:
  org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest:
    version: 1.0.0
    derived_from: tosca.datatypes.Root
    properties:
      restRequestId:
        type:  onap.datatypes.ToscaConceptIdentifier
        typeVersion: 1.0.0
        required: true
        description: The name and version of a REST request to be sent to a REST endpoint
      httpMethod:
        type: string
        required: true
        constraints:
          - valid_values: [POST, PUT, GET, DELETE]
        description: The REST method to use
      path:
        type: string
        required: true
        description: The path of the REST request relative to the base URL
      body:
        type: string
        required: false
        description: The body of the REST request for PUT and POST requests
      expectedResponse:
        type: integer
        required: true
        constraints:
          - in_range: [100, 599]
        description: THe expected HTTP status code for the REST request
  org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity:
    version: 1.0.0
    derived_from: tosca.datatypes.Root
    properties:
      configurationEntityId:
        type:  onap.datatypes.ToscaConceptIdentifier
        typeVersion: 1.0.0
        required: true
        description: The name and version of a Configuration Entity to be handled by the HTTP Control Loop Element
      restSequence:
        type: list
        entry_schema:
          type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest
          typeVersion: 1.0.0
        description: A sequence of REST commands to send to the REST endpoint
node_types:
  org.onap.policy.clamp.controlloop.HttpControlLoopElement:
    version: 1.0.1
    derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
    properties:
      baseUrl:
        type: string
        required: true
        description: The base URL to be prepended to each path, identifies the host for the REST endpoints.
      httpHeaders:
        type: map
        required: false
        entry_schema:
          type: string
        description: HTTP headers to send on REST requests
      configurationEntities:
        type: map
        required: true
        entry_schema:
          type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity
          typeVersion: 1.0.0
        description: The connfiguration entities the Control Loop Element is managing and their associated REST requests