summaryrefslogtreecommitdiffstats
path: root/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml
blob: 5e2c61144f3a3c7ed805becef20205a09b2bc80d (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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
tosca_definitions_version: tosca_simple_yaml_1_3
data_types:
  onap.datatypes.ToscaConceptIdentifier:
    properties:
      name:
        name: name
        type: string
        type_version: 0.0.0
        required: true
      version:
        name: version
        type: string
        type_version: 0.0.0
        required: true
    name: onap.datatypes.ToscaConceptIdentifier
    version: 0.0.0
    derived_from: tosca.datatypes.Root
    metadata: {}
  org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest:
    properties:
      restRequestId:
        name: restRequestId
        type: onap.datatypes.ToscaConceptIdentifier
        type_version: 0.0.0
        description: The name and version of a REST request to be sent to a REST endpoint
        required: true
      httpMethod:
        name: httpMethod
        type: string
        type_version: 0.0.0
        description: The REST method to use
        required: true
        constraints:
        - valid_values:
          - POST
          - PUT
          - GET
          - DELETE
      path:
        name: path
        type: string
        type_version: 0.0.0
        description: The path of the REST request relative to the base URL
        required: true
      body:
        name: body
        type: string
        type_version: 0.0.0
        description: The body of the REST request for PUT and POST requests
        required: false
      expectedResponse:
        name: expectedResponse
        type: integer
        type_version: 0.0.0
        description: THe expected HTTP status code for the REST request
        required: true
        constraints: []
    name: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
    version: 1.0.0
    derived_from: tosca.datatypes.Root
    metadata: {}
  org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity:
    properties:
      configurationEntityId:
        name: configurationEntityId
        type: onap.datatypes.ToscaConceptIdentifier
        type_version: 0.0.0
        description: The name and version of a Configuration Entity to be handled
          by the HTTP Automation Composition Element
        required: true
      restSequence:
        name: restSequence
        type: list
        type_version: 0.0.0
        description: A sequence of REST commands to send to the REST endpoint
        required: false
        entry_schema:
          type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.RestRequest
          type_version: 1.0.0
    name: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
    version: 1.0.0
    derived_from: tosca.datatypes.Root
    metadata: {}
node_types:
  org.onap.policy.clamp.acm.Participant:
    properties:
      provider:
        name: provider
        type: string
        type_version: 0.0.0
        required: false
    name: org.onap.policy.clamp.acm.Participant
    version: 1.0.1
    derived_from: tosca.nodetypes.Root
    metadata: {}
  org.onap.policy.clamp.acm.AutomationCompositionElement:
    properties:
      provider:
        name: provider
        type: string
        type_version: 0.0.0
        description: Specifies the organization that provides the automation composition
          element
        required: false
        metadata:
          common: 'true'
      participant_id:
        name: participant_id
        type: onap.datatypes.ToscaConceptIdentifier
        type_version: 0.0.0
        required: true
        metadata:
          common: 'true'
      participantType:
        name: participantType
        type: onap.datatypes.ToscaConceptIdentifier
        type_version: 0.0.0
        description: The identity of the participant type that hosts this type of
          Automation Composition Element
        required: true
        metadata:
          common: 'true'
      startPhase:
        name: startPhase
        type: integer
        type_version: 0.0.0
        description: A value indicating the start phase in which this automation composition
          element will be started, the first start phase is zero. Automation Composition
          Elements are started in their start_phase order and stopped in reverse start
          phase order. Automation Composition Elements with the same start phase are
          started and stopped simultaneously
        required: false
        constraints:
        - greater_or_equal: '0'
        metadata:
          common: 'true'
      uninitializedToPassiveTimeout:
        name: uninitializedToPassiveTimeout
        type: integer
        type_version: 0.0.0
        description: The maximum time in seconds to wait for a state chage from uninitialized
          to passive
        default: 60.0
        required: false
        constraints:
        - greater_or_equal: '0'
        metadata:
          common: 'true'
      passiveToRunningTimeout:
        name: passiveToRunningTimeout
        type: integer
        type_version: 0.0.0
        description: The maximum time in seconds to wait for a state chage from passive
          to running
        default: 60.0
        required: false
        constraints:
        - greater_or_equal: '0'
        metadata:
          common: 'true'
      runningToPassiveTimeout:
        name: runningToPassiveTimeout
        type: integer
        type_version: 0.0.0
        description: The maximum time in seconds to wait for a state chage from running
          to passive
        default: 60.0
        required: false
        constraints:
        - greater_or_equal: '0'
        metadata:
          common: 'true'
      passiveToUninitializedTimeout:
        name: passiveToUninitializedTimeout
        type: integer
        type_version: 0.0.0
        description: The maximum time in seconds to wait for a state chage from passive
          to uninitialized
        default: 60.0
        required: false
        constraints:
        - greater_or_equal: '0'
        metadata:
          common: 'true'
    name: org.onap.policy.clamp.acm.AutomationCompositionElement
    version: 1.0.1
    derived_from: tosca.nodetypes.Root
    metadata: {}
  org.onap.policy.clamp.acm.AutomationComposition:
    properties:
      provider:
        name: provider
        type: string
        type_version: 0.0.0
        description: Specifies the organization that provides the automation composition
          element
        required: false
        metadata:
          common: 'true'
      elements:
        name: elements
        type: list
        type_version: 0.0.0
        description: Specifies a list of automation composition element definitions
          that make up this automation composition definition
        required: true
        entry_schema:
          type: onap.datatypes.ToscaConceptIdentifier
          type_version: 0.0.0
        metadata:
          common: 'true'
    name: org.onap.policy.clamp.acm.AutomationComposition
    version: 1.0.1
    derived_from: tosca.nodetypes.Root
    metadata: {}
  org.onap.policy.clamp.acm.HttpAutomationCompositionElement:
    properties:
      baseUrl:
        name: baseUrl
        type: string
        type_version: 0.0.0
        description: The base URL to be prepended to each path, identifies the host
          for the REST endpoints.
        required: true
      httpHeaders:
        name: httpHeaders
        type: map
        type_version: 0.0.0
        description: HTTP headers to send on REST requests
        required: false
        entry_schema:
          type: string
          type_version: 0.0.0
      configurationEntities:
        name: configurationEntities
        type: map
        type_version: 0.0.0
        description: The connfiguration entities the Automation Composition Element
          is managing and their associated REST requests
        required: true
        entry_schema:
          type: org.onap.datatypes.policy.clamp.acm.httpAutomationCompositionElement.ConfigurationEntity
          type_version: 1.0.0
    name: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
    version: 1.0.1
    derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
    metadata: {}
topology_template:
  node_templates:
    org.onap.policy.clamp.acm.HttpParticipant:
      type: org.onap.policy.clamp.acm.Participant
      type_version: 1.0.1
      properties:
        provider: ONAP
      name: org.onap.policy.clamp.acm.HttpParticipant
      version: 2.3.4
      metadata: {}
      description: Participant for Http requests
    onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement:
      type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
      type_version: 1.0.1
      properties:
        provider: ONAP
        participant_id:
          name: HttpParticipant0
          version: 1.0.0
        participantType:
          name: org.onap.policy.clamp.acm.HttpParticipant
          version: 2.3.4
        uninitializedToPassiveTimeout: 180
        startPhase: 0
        baseUrl: http://acelement-starter:8084
        httpHeaders:
          Content-Type: application/json
          Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0
        configurationEntities:
        - configurationEntityId:
            name: onap.policy.clamp.ac.starter
            version: 1.0.0
          restSequence:
          - restRequestId:
              name: request1
              version: 1.0.1
            httpMethod: POST
            path: /onap/policy/clamp/acelement/v2/activate
            body: '{ "receiverId": { "name": "onap.policy.clamp.ac.startertobridge",
              "version": "1.0.0" }, "timerMs": 4000, "elementType": "STARTER", "topicParameterGroup":
              { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG",
              "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure":
              "dmaap" } }'
            expectedResponse: 201
      name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement
      version: 1.2.3
      metadata: {}
      description: Automation composition element for the http requests of AC Element
        Starter microservice
    onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement:
      type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
      type_version: 1.0.1
      properties:
        provider: ONAP
        participant_id:
          name: HttpParticipant0
          version: 1.0.0
        participantType:
          name: org.onap.policy.clamp.acm.HttpParticipant
          version: 2.3.4
        uninitializedToPassiveTimeout: 180
        startPhase: 0
        baseUrl: http://acelement-bridge:8084
        httpHeaders:
          Content-Type: application/json
          Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0
        configurationEntities:
        - configurationEntityId:
            name: onap.policy.clamp.ac.bridge
            version: 1.0.0
          restSequence:
          - restRequestId:
              name: request2
              version: 1.0.1
            httpMethod: POST
            path: /onap/policy/clamp/acelement/v2/activate
            body: '{ "receiverId": { "name": "onap.policy.clamp.ac.bridgetosink",
              "version": "1.0.0" }, "timerMs": 4000, "elementType": "BRIDGE", "topicParameterGroup":
              { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG",
              "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure":
              "dmaap" } }'
            expectedResponse: 201
      name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement
      version: 1.2.3
      metadata: {}
      description: Automation composition element for the http requests of AC Element
        Bridge microservice
    onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement:
      type: org.onap.policy.clamp.acm.HttpAutomationCompositionElement
      type_version: 1.0.1
      properties:
        provider: ONAP
        participant_id:
          name: HttpParticipant0
          version: 1.0.0
        participantType:
          name: org.onap.policy.clamp.acm.HttpParticipant
          version: 2.3.4
        uninitializedToPassiveTimeout: 180
        startPhase: 0
        baseUrl: http://acelement-sink:8084
        httpHeaders:
          Content-Type: application/json
          Authorization: Basic cnVudGltZVVzZXI6emIhWHp0RzM0
        configurationEntities:
        - configurationEntityId:
            name: onap.policy.clamp.ac.sink
            version: 1.0.0
          restSequence:
          - restRequestId:
              name: request3
              version: 1.0.1
            httpMethod: POST
            path: /onap/policy/clamp/acelement/v2/activate
            body: '{ "receiverId": { "name": "onap.policy.clamp.ac.sink", "version":
              "1.0.0" }, "timerMs": 4000, "elementType": "SINK", "topicParameterGroup":
              { "server": "message-router", "listenerTopic": "POLICY_UPDATE_MSG",
              "publisherTopic": "AC_ELEMENT_MSG", "fetchTimeout": 15000, "topicCommInfrastructure":
              "dmaap" } }'
            expectedResponse: 201
      name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement
      version: 1.2.3
      metadata: {}
      description: Automation composition element for the http requests of AC Element
        Sink microservice
    onap.policy.clamp.ac.element.AutomationCompositionDefinition:
      type: org.onap.policy.clamp.acm.AutomationComposition
      type_version: 1.0.1
      properties:
        provider: ONAP
        elements:
        - name: onap.policy.clamp.ac.element.Http_StarterAutomationCompositionElement
          version: 1.2.3
        - name: onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement
          version: 1.2.3
        - name: onap.policy.clamp.ac.element.Http_SinkAutomationCompositionElement
          version: 1.2.3
      name: onap.policy.clamp.ac.element.AutomationCompositionDefinition
      version: 1.2.3
      metadata: {}
      description: Automation composition for Demp
name: tosca
version: 1.0.0
metadata: {}