blob: c3b02e412cea9c039ef7f97305bfd1746a47dfcc (
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
|
# ============LICENSE_START=======================================================
# Copyright (C) 2023 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=========================================================
openapi: 3.0.3
info:
title: ACM Simulator Participant
description: CLAMP Automation Composition Management Simulator Participant API
contact:
name: ONAP Support
url: https://lists.onap.org/g/onap-discuss
email: onap-discuss@lists.onap.org
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
version: '1.0'
externalDocs:
description: CLAMP Automation Composition Management Documentation
url: https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html
tags:
- name: Simulator-participant-controller
description: Automation Composition Element Test Participant controller
servers:
- url: http:{port}/{server}
variables:
port:
default: "8084"
description: This value is assigned by the service provider
server:
default: /onap/policy/clamp/acm/simparticipant
description: This value is assigned by the service provider
paths:
/parameters:
get:
tags:
- Simulator-participant-controller
summary: Return all Parameters
description: Return all the parameters configured in the Simulator Participant
operationId: getConfig
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: OK, reutrns a serialised instance of
[SimConfig](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/SimConfig.java)
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/SimConfig'
application/yaml:
schema:
$ref: '#/components/schemas/SimConfig'
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
put:
tags:
- Simulator-participant-controller
summary: change the parameters
description: >-
Change the parameters the behaviour of the Simulator Participant
operationId: setConfig
parameters:
- name: X-ONAP-RequestID
in: header
description: RequestID for http transaction
required: false
schema:
type: string
format: uuid
requestBody:
description: The information for the behaviour in a serialised instance of
[SimConfig](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/SimConfig.java)
content:
application/json:
schema:
$ref: '#/components/schemas/SimConfig'
application/yaml:
schema:
$ref: '#/components/schemas/SimConfig'
responses:
200:
description: OK, the parameters has been saved
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
400:
description: Bad Request
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
/instances:
get:
tags:
- Simulator-participant-controller
summary: Query details of the requested automation composition instances
description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
details of all its automation composition instances
operationId: getAutomationCompositions
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: Serialised instance of
[AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
containing a list of automation composition instances found
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationCompositions'
application/yaml:
schema:
$ref: '#/components/schemas/AutomationCompositions'
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
/datas:
get:
tags:
- Simulator-participant-controller
summary: Query details of the requested internal datas
description: Query details of the requested internal datas
operationId: getDatas
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: Serialised instance of
[InternalDatas](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalDatas.java)
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalDatas'
application/yaml:
schema:
$ref: '#/components/schemas/InternalDatas'
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
put:
tags:
- Simulator-participant-controller
summary: change the parameters
description: >-
Change the data of the Simulator Participant
operationId: setData
parameters:
- name: X-ONAP-RequestID
in: header
description: RequestID for http transaction
required: false
schema:
type: string
format: uuid
requestBody:
description: The data in a serialised instance of
[InternalData](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalData.java)
content:
application/json:
schema:
$ref: '#/components/schemas/InternalData'
application/yaml:
schema:
$ref: '#/components/schemas/InternalData'
responses:
200:
description: OK, the data has been saved
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
400:
description: Bad Request
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
/compositiondatas:
get:
tags:
- Simulator-participant-controller
summary: Query details of the requested internal composition datas
description: Query details of the requested internal composition datas
operationId: getCompositionDatas
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: Serialised instance of
[InternalDatas](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalDatas.java)
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalDatas'
application/yaml:
schema:
$ref: '#/components/schemas/InternalDatas'
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
put:
tags:
- Simulator-participant-controller
summary: change the parameters
description: >-
Change the data of the Simulator Participant
operationId: setCompositionData
parameters:
- name: X-ONAP-RequestID
in: header
description: RequestID for http transaction
required: false
schema:
type: string
format: uuid
requestBody:
description: The data in a serialised instance of
[InternalData](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/policy-clamp-participant-impl-simulator/src/main/java/org/onap/policy/clamp/acm/participant/sim/model/InternalData.java)
content:
application/json:
schema:
$ref: '#/components/schemas/InternalData'
application/yaml:
schema:
$ref: '#/components/schemas/InternalData'
responses:
200:
description: OK, the data has been saved
headers:
X-LatestVersion:
$ref: '#/components/headers/X-LatestVersion'
X-PatchVersion:
$ref: '#/components/headers/X-PatchVersion'
X-MinorVersion:
$ref: '#/components/headers/X-MinorVersion'
X-onap-RequestId:
$ref: '#/components/headers/X-onap-RequestId'
400:
description: Bad Request
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
schemas:
SimConfig:
title: SimConfig
type: object
AutomationCompositions:
title: AutomationCompositions
type: object
InternalDatas:
title: InternalDatas
type: object
InternalData:
title: InternalData
type: object
headers:
X-LatestVersion:
schema:
type: string
X-PatchVersion:
schema:
type: string
X-MinorVersion:
schema:
type: string
X-onap-RequestId:
schema:
type: string
format: uuid
|
