Newer
Older
openapi: 3.0.2
info:
title: SOL005 - VNF Snapshot Package Management interface
description: |
SOL005 - VNF Snapshot Package Management 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/vnfsnapshotpkgm/v1
- url: https://127.0.0.1/vnfsnapshotpkgm/v1
paths:
###############################################################################
# API Versions #
###############################################################################
/api_versions:
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
/vnf_snapshot_packages:
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 creates a new "Individual VNF snapshot package" resource. See clause 11.4.2.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreateVnfSnapshotPkgInfoRequest'
responses:
201:
$ref: '#/components/responses/VnfSnapshotPackages.Post.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
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
get:
description: |
The GET method queries the information of the VNF packages matching the filter. See clause 11.4.2.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
200:
$ref: '#/components/responses/VnfSnapshotPackages.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
get:
description: |
The GET method reads the information of an individual VNF snapshot package. See clause 11.4.3.3.2.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
200:
$ref: '#/components/responses/IndividualVNFSnapshotPackage.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
patch:
description: |
The PATCH method updates the information of a VNF snapshot package. See clause 11.4.3.3.4.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
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
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotPkgInfoModifications'
responses:
200:
$ref: '#/components/responses/IndividualVNFSnapshotPackage.Patch.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
409:
# description: |
# 409 CONFLICT
# Shall be returned upon the following error: The operation cannot be executed
# currently, due to a conflict with the state of the resource.
# Typically, this is due to the fact that the state of the VNF snapshot package
# resource is in a state other than CREATED, ERROR_EXTRACTING or AVAILABLE.
# The response body shall contain a ProblemDetails structure, in which the "detail"
# attribute shall convey more information about the error.
$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
delete:
description: |
The DELETE method deletes an "Individual VNF snapshot package" resource. See clause 11.4.3.3.5.
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
responses:
204:
$ref: '#/components/responses/IndividualVNFSnapshotPackage.Delete.204'
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:
# description: |
# 409 CONFLICT
# Shall be returned upon the following error: The operation cannot be
# executed currently, due to a conflict with the state of the resource.
# Typically, this is due to the fact that the operational state of the
# VNF snapshot package resource is other than CREATED, ERROR or AVAILABLE.
# The response body shall contain a ProblemDetails structure, in which
# the "detail" attribute shall convey more information about the error.
$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
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
get:
description: |
The GET method fetches the content of a VNF snapshot package. See clause 11.4.4.3.2.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
responses:
200:
$ref: '#/components/responses/VnfSnapshotPackageContent.Get.200'
206:
$ref: '#/components/responses/VnfSnapshotPackageContent.Get.206'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
put:
description: |
The PUT method uploads the content of a VNF package. See clause 11.4.4.3.3.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
responses:
202:
$ref: '#/components/responses/VnfSnapshotPackageContent.Put.202'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/upload_from_uri:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to get the content of
a VNF snapshot package. See clause 11.4.5.3.1.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
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
requestBody:
$ref: '#/components/requestBodies/UploadVnfSnapshotPkgFromUriRequest'
responses:
202:
$ref: '#/components/responses/UploadFromUri.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
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/build:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to start building
the content of a VNF snapshot package. See clause 11.4.6.3.1.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
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
requestBody:
$ref: '#/components/requestBodies/BuildVnfSnapshotPkgRequest'
responses:
202:
$ref: '#/components/responses/BuildVnfSnapshotPkg.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
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/extract:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to start extracting the content of
a VNF snapshot package. See clause 11.4.7.3.1.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
requestBody:
$ref: '#/components/requestBodies/ExtractVnfSnapshotPkgRequest'
responses:
202:
$ref: '#/components/responses/ExtractVnfSnapshotPkg.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
/vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content/cancel:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
post:
description: |
The POST method provides the information for the NFVO to cancel the ongoing operation related to
the content of a VNF snapshot package. See clause 11.4.8.3.1.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
requestBody:
$ref: '#/components/requestBodies/CancelVnfSnapshotPkgOperationRequest'
responses:
202:
$ref: '#/components/responses/CancelVnfSnapshotPkg.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
/vnf_snapshot_packages/{vnfSnapshotPkgId}/ext_artifacts_access:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
get:
description: |
The GET method reads the access configuration information that is used by the NFVO to get the
content of external VNF snapshot package artifacts. See clause 11.4.9.3.2.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
200:
$ref: '#/components/responses/ExternalArtifactsAccess.Get.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
put:
description: |
The PUT method provides the access configuration information for the NFVO to download
the content of external VNF package artifacts. See clause 11.4.9.3.3.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfSnapshotPkgExtArtifactsAccessConfig'
responses:
200:
$ref: '#/components/responses/ExternalArtifactsAccess.Put.200'
400:
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_snapshot_packages/{vnfSnapshotPkgId}/artifacts/{artifactPath}:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/VnfSnapshotPkgId'
- $ref: '#/components/parameters/ArtifactPath'
get:
description: |
The GET method fetches the content of an artifact within the VNF snapshot package. See clause 11.4.10.3.2.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
responses:
200:
$ref: '#/components/responses/IndividualArtifact.Get.200'
206:
$ref: '#/components/responses/IndividualArtifact.Get.206'
302:
$ref: '#/components/responses/IndividualArtifact.Get.302'
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
$ref: ../responses/SOL005_resp.yaml#/components/responses/429
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
components:
parameters:
VnfSnapshotPkgId:
name: vnfSnapshotPkgId
in: path
description: |
Identifier of the VNF snapshot package. The identifier is allocated by the NFVO.
This identifier can be retrieved from the "id" attribute of the applicable "VnfSnapshotPkgInfo" in the body of
the response to requesting the creation of a new "Individual VNF snapshot package" resource or in a response to
a GET request querying the "Individual VNF snapshot package" or the "VNF snapshot packages" resource.
required: true
style: simple
explode: false
schema:
type: string
ArtifactPath:
name: artifactPath
in: path
description: |
For an artifact contained as a file in the VNF snapshot package, this variable shall contain a sequence
of one or path segments representing the path of the artifact within the VNF snapshot package, relative
to the root of the package.
EXAMPLE: foo/bar/m%40ster.sh
For an external artifact represented as a URI in the VNF snapshot package manifest, this variable shall
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
contain a sequence of one or more path segments as synthesized by the NFVO (see clause 11.5.3.3) representing
this artifact.
This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts"
entry in the body of the response to a GET request querying the "Individual VNF snapshot package" or the
"VNF snapshot packages" resource.
Since multiple path segments are allowed to be contained in this variable, the "/" character that separates
these segments is not percent-encoded. Each individual segment is percent-encoded if necessary as defined
in clause 4.1 of ETSI GS NFV-SOL 013.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
CreateVnfSnapshotPkgInfoRequest:
description: |
"VNF snapshot package" resource creation parameters, as defined in clause 11.5.2.2.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/CreateVnfSnapshotPkgInfoRequest
required: true
VnfSnapshotPkgInfoModifications:
description: |
"VNF snapshot package" resource modification parameters, as defined in clause 11.5.2.4.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfoModifications
required: true
UploadVnfSnapshotPkgFromUriRequest:
description: |
Request parameters for uploading the content of a VNF snapshot package, as defined in clause 11.5.2.5.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/UploadVnfSnapshotPkgFromUriRequest
required: true
BuildVnfSnapshotPkgRequest:
description: |
Request parameters for building the content of a VNF snapshot package, as defined in clause 11.5.2.6.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/BuildVnfSnapshotPkgRequest
required: true
ExtractVnfSnapshotPkgRequest:
description: |
Request parameters for extracting the content of a VNF snapshot package, as defined in clause 11.5.2.7.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/ExtractVnfSnapshotPkgRequest
required: true
CancelVnfSnapshotPkgOperationRequest:
description: |
Request parameters for cancelling an ongoing operation related to the content of a VNF snapshot package,
as defined in clause 11.5.2.8.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/CancelVnfSnapshotPkgOperationRequest
required: true
description: VOID
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessConfig
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
required: true
responses:
VnfSnapshotPackages.Post.200:
description: |
200 OK
Shall be returned when an "Individual VNF snapshot package" resource has been created successfully.
The response body shall contain a representation of the new "Individual VNF snapshot package" resource,
as defined in clause 11.5.2.3.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
"Individual VNF snapshot package" resource.
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/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
VnfSnapshotPackages.Get.200:
description: |
200 OK
Shall be returned when information about zero or more VNF snapshot packages has been queried successfully.
The response body shall contain in an array the VNF snapshot package info representations that match the
attribute filter, i.e. zero or more VNF snapshot package info representations as defined in clause 11.5.2.3.
If the "filter" URI parameter or one of the "all_fields", "fields", "exclude_fields" or "exclude_default" URI
parameters was supplied in the request and is supported, the data in the response body shall have been
transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this
resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3
of ETSI GS NFV-SOL 013.
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
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
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:
type: array
items:
$ref: definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo
IndividualVNFSnapshotPackage.Get.200:
description: |
200 OK
Shall be returned when information of the VNF snapshot package has been read successfully.
The response body shall contain the VNF snapshot package info representation defined in clause 11.5.2.3.
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/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
IndividualVNFSnapshotPackage.Patch.200:
description: |
200 OK
Shall be returned when the operation has been completed successfully.
The response body shall contain attribute modifications for an "Individual VNF snapshot package" resource.
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/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfoModifications
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
IndividualVNFSnapshotPackage.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the VNF snapshot package has been deleted successfully.
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
VnfSnapshotPackageContent.Get.200:
description: |
200 OK
Shall be returned when the whole content of the VNF snapshot package file has been read
successfully.
The response body shall include a copy of the VNF snapshot package file.
The "Content-Type" HTTP header shall be set according to the type of the file, i.e. to
"application/zip" for a VNF snapshot package. The VNF snapshot package format is defined
in ETSI GS NFV-SOL 010.
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
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/zip:
schema:
type: string
format: binary
VnfSnapshotPackageContent.Get.206:
description: |
206 PARTIAL CONTENT
If the NFVO supports range requests, this response shall be returned when a single consecutive
byte range from the content of the VNF snapshot package file has been read successfully according
to the request.
The response body shall contain the requested part of the VNF snapshot package file.
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined for the "200 OK" response.
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-Range:
description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
style: simple
explode: false
schema:
type: string
content:
application/zip:
schema:
type: string
format: binary
VnfSnapshotPackageContent.Put.202:
description: |
202 ACCEPTED
Shall be returned when the VNF snapshot package has been accepted for uploading, but the
processing has not been completed. It is expected to take some time for processing.
The response body shall be empty.
The API consumer can track the uploading progress by reading the status of the
"Individual VNF snapshot package" resource using the GET method.
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
UploadFromUri.Post.202:
description: |
202 ACCEPTED
Shall be returned when the information about the VNF snapshot package has been received successfully, but
the uploading has not been completed. It is expected to take some time for processing.
The response body shall be empty.
The API consumer can track the uploading progress by reading the status of the
"Individual VNF snapshot package" resource using the GET method.
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
BuildVnfSnapshotPkg.Post.202:
description: |
202 ACCEPTED
Shall be returned when the information for building the VNF snapshot package has been received successfully, but
the build has not been completed. It is expected to take some time for processing.
The response body shall be empty.
The API consumer can track the uploading progress by reading the status of the
"Individual VNF snapshot package" resource using the GET method.
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
ExtractVnfSnapshotPkg.Post.202:
description: |
202 ACCEPTED
Shall be returned when the information for extracting the VNF snapshot package has been received successfully, but
the extraction has not been completed. It is expected to take some time for processing.
The response body shall be empty.
The API consumer can track the uploading progress by reading the status of the
"Individual VNF snapshot package" resource using the GET method.
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
CancelVnfSnapshotPkg.Post.202:
description: |
202 ACCEPTED
Shall be returned when the information for cancelling the ongoing operation with the content of the VNF snapshot package
has been received successfully, but the stopping of the operation has not been completed. It is expected to take some
time for processing.
The response body shall be empty.
The API consumer can track the uploading progress by reading the status of the
"Individual VNF snapshot package" resource using the GET method.
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
ExternalArtifactsAccess.Get.200:
description: |
200 OK
Shall be returned when the access configuration information has been read successfully.
If no information has been provided previously, an empty array shall be returned.
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/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessConfig
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
ExternalArtifactsAccess.Put.200:
description: |
200 OK
Shall be returned when the attribute "state" equals "CREATED" or when the attribute "state" equals "ERROR"
and the VNF snapshot package has not been uploaded successfully previously, to indicate that the access
configuration information has been stored successfully by the NFVO.
The response body shall contain a representation of the state of the resource.
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/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessConfig
IndividualArtifact.Get.200:
description: |
200 OK
Shall be returned when the whole content of the artifact file has been read successfully.
The response body shall include a copy of the artifact file from the VNF snapshot package.
The VNF snapshot package format is defined in ETSI GS NFV-SOL 010.
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the
content type cannot be determined, the header shall be set to the value "application/octet-stream".
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/*:
schema:
type: string
format: binary
IndividualArtifact.Get.206:
description: |
206 PARTIAL CONTENT
If the NFVO supports range requests, this response shall be returned when a single consecutive byte
range from the content of the artifact file has been read successfully according to the request.
The response body shall contain the requested part of the artifact file from the VNF snapshot package.
The VNF snapshot package format is defined in ETSI GS NFV-SOL 010.
The "Content-Type" HTTP header shall be set according to the content
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
type of the artifact file. If the content type cannot be determined, the header shall be set to the
value "application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
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-Range:
description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
style: simple
explode: false
schema:
type: string
content:
application/*:
schema:
type: string
format: binary
description: |
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
Shall be returned if the referred "Individual VNF snapshot package artifact" is external to the main
VNF snapshot package file created from a build process.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the artifact.
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
Location:
description: The resource URI of the artifact.
style: simple
explode: false
schema:
type: string
format: url