blob: a3ccd1865fd7a1d1a5d7b21178fd5ec9f6fd0e1e (
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
|
openapi: 3.0.3
info:
title: ACM Element Test Participant
description: ApiCLAMP Automation Composition Management Element Test 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
servers:
- url: http:{port}/{server}
variables:
port:
default: "30296"
description: This value is assigned by the service provider
server:
default: /onap/policy/clamp/acelement/v2
description: This value is assigned by the service provider
tags:
- name: ac-element-controller
description: Automation Composition Element Test Participant controller
paths:
/config:
get:
tags:
- ac-element-controller
summary: Return the element configuration
description: Return the configuraiton of this AC element
operationId: getElementConfig
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
200:
description: OK, serialised instance of
[ElementConfig](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/element/ElementConfig.java)
headers:
api-version:
schema:
type: string
X-LatestVersion:
schema:
type: string
description: Used only to communicate an API's latest version
X-PatchVersion:
schema:
type: string
description:
Used only to communicate a PATCH version in a response for troubleshooting purposes only,
and will not be provided by the client on request
X-MinorVersion:
schema:
type: string
description:
Used to request or communicate a MINOR version back from the client
to the server, and from the server back to the client
X-onap-RequestId:
schema:
type: string
format: uuid
description: Used to track REST transactions for logging purposes
content:
application/json:
schema:
$ref: '#/components/schemas/ElementConfig'
application/yaml:
schema:
$ref: '#/components/schemas/ElementConfig'
401:
description: Authorization Error
404:
description: Not Found
500:
description: Internal Server Error
security:
- basicAuth: []
/activate:
post:
tags:
- ac-element-controller
summary: Activates the element configuration
description: >-
Activates a configuration on an Automation Composition Element
operationId: activateElement
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
requestBody:
description: The AC element configuration to apply in a serialised instance of
[ElementConfig](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/element/ElementConfig.java)
content:
application/json:
schema:
$ref: '#/components/schemas/ElementConfig'
application/yaml:
schema:
$ref: '#/components/schemas/ElementConfig'
responses:
201:
description: OK, configuration has been created
headers:
api-version:
schema:
type: string
X-LatestVersion:
schema:
type: string
description: Used only to communicate an API's latest version
X-PatchVersion:
schema:
type: string
description:
Used only to communicate a PATCH version in a response for troubleshooting purposes only,
and will not be provided by the client on request
X-MinorVersion:
schema:
type: string
description:
Used to request or communicate a MINOR version back from the client
to the server, and from the server back to the client
X-onap-RequestId:
schema:
type: string
format: uuid
description: Used to track REST transactions for logging purposes
content:
application/json:
schema:
type: string
example: Success
application/yaml:
schema:
type: string
example: Success
400:
description: Bad Request
401:
description: Authorization Error
500:
description: Internal Server Error
security:
- basicAuth: []
/deactivate:
delete:
tags:
- ac-element-controller
summary: Delete the AC element configuration
description: Deletes the configuration of an Automation Composition Element
operationId: deleteConfig
parameters:
- name: X-onap-RequestId
in: header
description: RequestID for http transaction
schema:
type: string
format: uuid
responses:
204:
description: No Content
headers:
api-version:
schema:
type: string
X-LatestVersion:
schema:
type: string
description: Used only to communicate an API's latest version
X-PatchVersion:
schema:
type: string
description:
Used only to communicate a PATCH version in a response for troubleshooting purposes only,
and will not be provided by the client on request
X-MinorVersion:
schema:
type: string
description:
Used to request or communicate a MINOR version back from the client
to the server, and from the server back to the client
X-onap-RequestId:
schema:
type: string
format: uuid
description: Used to track REST transactions for logging purposes
400:
description: Bad Request
401:
description: Authorization Error
409:
description: Not Defined, the elemet type is not defined
headers:
api-version:
schema:
type: string
X-LatestVersion:
schema:
type: string
description: Used only to communicate an API's latest version
X-PatchVersion:
schema:
type: string
description:
Used only to communicate a PATCH version in a response for troubleshooting purposes only,
and will not be provided by the client on request
X-MinorVersion:
schema:
type: string
description:
Used to request or communicate a MINOR version back from the client
to the server, and from the server back to the client
X-onap-RequestId:
schema:
type: string
format: uuid
description: Used to track REST transactions for logging purposes
500:
description: Internal Server Error
security:
- basicAuth: []
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
schemas:
ElementConfig:
title: ElementConfig
type: object
|
