Newer
Older
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
openapi: 3.0.2
info:
title: SOL005 - NS LCM Coordination interface
description: |
SOL005 - NS LCM Coordination interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
In case of discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 005 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
servers:
- url: http://127.0.0.1/lcmcoord/v1
- url: https://127.0.0.1/lcmcoord/v1
paths:
###############################################################################
# API Versions #
###############################################################################
/api_versions:
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/coordinations:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
post:
description: |
The POST method requests the coordination of an LCM operation occurrence
with a management operation executed in the API producer.
See clause 12.4.2.3.1.
requestBody:
$ref: '#/components/requestBodies/LcmCoordRequest'
responses:
201:
$ref: '#/components/responses/CoordinationActions.Post.201'
202:
$ref: '#/components/responses/CoordinationActions.Post.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/coordinations/{coordinationId}:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: '#/components/parameters/CoordinationId'
get:
description: |
The GET method reads a coordination result.
See clause 12.4.3.3.2.
responses:
200:
$ref: '#/components/responses/IndividualCoordinationAction.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/coordinations/cancel:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
post:
description: |
The POST method initiates the cancellation of an ongoing coordination action.
See clause 12.4.4.3.1.
responses:
202:
$ref: '#/components/responses/CoordinationActionCancel.Post.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
401:
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
403:
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
404:
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
405:
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
406:
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
409:
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
416:
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
500:
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
503:
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
504:
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
components:
parameters:
CoordinationId:
name: coordinationId
in: path
description: |
Identifier of the LCM coordination.
NOTE: This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request to the
"Coordinations" resource.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
LcmCoordRequest:
description: |
Parameters for the coordination action as defined in clause 12.5.2.2.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoordRequest
required: true
responses:
CoordinationActions.Post.201:
description: |
201 CREATED
Shall be returned when the API producer has chosen the synchronous mode, which may be
chosen for coordination actions that finish within the time frame in which an HTTP
response is expected.
The response body shall contain an LcmCoord data structure that represents the result
of the coordination action.
The HTTP response shall include a "Location" HTTP header that indicates the URI of the
"Individual coordination action" resource that has been created as the result of the
finished coordination procedure.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created VNF Snapshot Package.
style: simple
explode: false
schema:
type: string
format: url
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoord
CoordinationActions.Post.202:
description: |
202 ACCEPTED
Shall be returned when the API producer has chosen the asynchronous mode and
the request has been accepted for processing.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that indicates the
URI of the "Individual coordination action" resource that will be created
once the coordination operation has finished successfully.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created VNF Snapshot Package.
style: simple
explode: false
schema:
type: string
format: url
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
IndividualCoordinationAction.Get.200:
description: |
200 OK
Shall be returned when the coordination is finished and the coordination result
has been read successfully.
A representation of the "Individual coordination action" resource shall be returned
in the response body.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: definitions/SOL005NSLCMCoordination_def.yaml#/definitions/LcmCoord
IndividualCoordinationAction.Post.202:
description: |
202 ACCEPTED
Shall be returned when the management operation with which coordination is requested
is still ongoing or in the process of being cancelled, i.e. no coordination result is
available yet.
The response body shall be empty.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
CoordinationActionCancel.Post.202:
description: |
202 ACCEPTED
Shall be returned when the cancellation request has been accepted for processing.
The response shall have an empty payload body.
headers:
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
corresponding HTTP request has provided an invalid authorization token.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string