VNFPackageManagement.yaml 63.6 KB
Newer Older
1
openapi: 3.0.2
2
3

info:
4
  title: SOL005 - VNF Package Management Interface
5
  description: |
rameshnaraya's avatar
rameshnaraya committed
6
    SOL005 - VNF Package Management Interface
7
8
9
10
11
    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/bugzilla/buglist.cgi?component=Nfv-Openapis
  contact:
    name: NFV-SOL WG
12
  license:
13
    name: ETSI Forge copyright notice
14
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
15
16
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

17
externalDocs:
18
19
  description: ETSI GS NFV-SOL 005 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
20

21
22
23
24
servers:
  - url: http://127.0.0.1/vnfpkgm/v2
  - url: https://127.0.0.1/vnfpkgm/v2

25
paths:
26
27
  /api_versions:
    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
28

29
  /vnf_packages:
30
    parameters:
31
32
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
33
    get:
rameshnaraya's avatar
rameshnaraya committed
34
      summary: Query VNF packages information.
35
36
37
38
      description: |
        The GET method queries the information of the VNF packages matching the filter. This method shall follow the
        provisions specified in the  Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters, request and response
        data structures, and response codes.
39
      parameters:
40
41
42
43
44
45
46
        - $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
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
47
      responses:
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
        "200":
          $ref: '#/components/responses/VnfPackages.Get'
        "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
        "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
68

69
70
71
72
    post:
      summary: Create a new individual VNF package resource.
      description: |
        The POST method creates a new individual VNF package resource.
73
74
75
        Upon successful creation of the "Individual VNF package" resource, the NFVO shall set the "onboardingState"
        attribute in the "VnPkgInfo" structure to "CREATED", the "operationalState" attribute to "DISABLED", and the
        "usageState" attribute to "NOT_IN_USE".
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
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageCreationRequest'
      responses:
        "201":
          $ref: '#/components/responses/VnfPackages.Post'
        "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
106

107
  /vnf_packages/{vnfPkgId}:
108
    parameters:
109
110
111
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
112
113
    get:
      summary: Read information about an individual VNF package.
114
      description: |
115
        The GET method reads the information of a VNF package.
116
      parameters:
117
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
118
      responses:
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Get'
        "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
        "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
139
140
141

    delete:
      summary: Delete an individual VNF package.
142
      description: |
143
144
        The DELETE method deletes an individual VNF Package resource.
      responses:
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
        "204":
          $ref: '#/components/responses/IndividualVnfPackage.Delete'
        "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
        "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
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
    patch:
      summary: Update information about an individual VNF package.
      description: |
        The PATCH method updates the information of a VNF package.
        This method shall follow the provisions specified in the  Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query
        parameters, request and response data structures, and response codes.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageModificationRequest'
      responses:
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Patch'
        "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
        "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
201

202
  /vnf_packages/{vnfPkgId}/vnfd:
203
    parameters:
204
205
206
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
207
208
    get:
      summary: Read VNFD of an on-boarded VNF package.
209
      description: |
210
        The GET method reads the content of the VNFD within a VNF package.
211
212
213
214
215
216
217
218
219
        The default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 where only the files
        representing the VNFD and information necessary to navigate the ZIP file and to identify the file that is the
        entry point for parsing the VNFD and (if requested) further security information are included. This means that
        the structure of the ZIP archive shall correspond to the directory structure used in the VNF package and that
        the archive shall contain the following files from the package: • TOSCA.meta (if available in the package).
        The main TOSCA definitions YAML file (either as referenced from TOSCA.meta or available as a file with the extension
        ".yml" or ".yaml" from the root of the archive). Every component of the VNFD referenced (recursively) from the main
        TOSCA definitions YAML file. • The related security information, if the "include_signatures" URI parameter is provided,
        as follows:
220
221
222
223
224
        - the manifest file;
        - the singleton certificate file in the root of the VNF package (if available in the package);
        - the signing certificates of the individual files included in the ZIP archive (if available in the package);
        - the signatures of the individual files (if available in the package).
      parameters:
225
226
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
227
      responses:
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
        "200":
          $ref: '#/components/responses/IndividualVnfPackageVnfd.Get'
        "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
        "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
250

251
  /vnf_packages/{vnfPkgId}/ext_artifacts_access:
252
    parameters:
253
254
255
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
256
    get:
257
      summary: Get the content of external VNF package artifacts.
258
      description: |
259
        The GET method reads the access configuration information that is used by the NFVO to get the content of external
260
261
        VNF package artifacts. This method shall follow the provisions specified in the Tables 9.4.4a.3.2-1 and 9.4.4a.3.2-2
        for URI query parameters, request and response data structures, and response codes.
262
      parameters:
263
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
264
      responses:
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
        "200":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Get'
        "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
        "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
285

286
287
    put:
      summary: Download the content of external VNF package artifacts.
288
289
290
291
292
293
294
      description: |
        The PUT method provides the access configuration information for the NFVO to download the content of external
        VNF package artifacts. As precondition for invoking this method, the individual VNF package resource shall have
        been created, and the value of "onboardingState" attribute shall equal to "CREATED" or "ERROR". The resource
        representation in the payload body of the PUT request shall replace the current state of the resource. This method
        shall follow the provisions specified in the Tables 9.4.4a.3.3-1 and 9.4.4a.3.3-2 for URI query parameters, request
        and response data structures, and response codes.
295
      parameters:
296
297
298
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageExtArtifactsRequest'
299
      responses:
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
        "200":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.200'
        "202":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.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
        "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
324

325
  /vnf_packages/{vnfPkgId}/manifest:
326
    parameters:
327
328
329
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
330
    get:
331
      description: |
332
        The GET method reads the content of the manifest within a VNF package.
333
      parameters:
334
335
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
336
      responses:
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
        "200":
          $ref: '#/components/responses/IndividualVnfPackageManifest.Get'
        "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
        "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
359

360
  /vnf_packages/{vnfPkgId}/package_content:
361
    parameters:
362
363
364
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
365
    get:
rameshnaraya's avatar
rameshnaraya committed
366
      summary: Fetch an on-boarded VNF package.
367
      description: |
368
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the
369
370
371
372
373
374
        NFVO. The content of the package is provided as onboarded, i.e. depending on the security option used, the CSAR
        or the CSAR wrapped in a ZIP archive together with an external signature is returned, as defined in clause 5.1
        of ETSI GS NFV-SOL 004 [5]. NOTE: Information about the applicable security option can be obtained by evaluating
        the "packageSecurityOption" attribute in the "VnfPkgInfo" structure. This method shall follow the provisions
        specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
375
      parameters:
376
377
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
378
      responses:
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
        "200":
          $ref: '#/components/responses/IndividualVnfPackageContent.Get'
        "206":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/206
        "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
405
406

    put:
rameshnaraya's avatar
rameshnaraya committed
407
      summary: Upload a VNF package by providing the content of the VNF package.
408
409
410
411
      description: |
        The PUT method uploads the content of a VNF package. This method shall follow the provisions specified in the
        Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters, request and response data structures, and response
        codes. Upon start of the upload of the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo"
412
        structure to "UPLOADING". Upon successful upload of the package, if the package references external artifacts, the
413
414
415
416
417
        NFVO shall obtain the external artifacts. Subsequently, upon success, the NFVO shall set that attribute to "PROCESSING"
        and shall process the package, which shall include checking package consistency. Upon successful processing, the NFVO
        shall set the "onboardingState" attribute to "ONBOARDED". If an error occurs during uploading the package, downloading
        the external artifacts or processing the package, the NFVO shall set the "onboardingState" attribute to "ERROR" and
        shall populate the "onboardingFailureDetails" attribute in "VnfPkgInfo".
418
      parameters:
419
420
421
422
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageContentRequest'
423
      responses:
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
        "202":
          $ref: '#/components/responses/IndividualVnfPackageContent.Put'
        "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
448

449
  /vnf_packages/{vnfPkgId}/artifacts:
450
    parameters:
451
452
453
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
454
455
    get:
      summary: Fetch set of VNF package artifacts.
456
      description: |
457
458
459
        The GET method shall return an archive that contains a set of artifacts according to the provisions for
        inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package.
        The criteria for exclusion/inclusion of an artifact in the archive are defined as follows:
460
461
462
463
464
465
466
467
468
469
470
471
472
473
        * Artifacts that are software images shall be excluded from the archive.
        * Artifacts that are external to the VNF package shall be excluded from the archive.
        * All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive,
          unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts
          shall be excluded.
        * All additional artifacts included in the VNF package that are non-MANO artifacts shall be included in the archive,
          unless:
          - the URI query parameter "exclude_all_non_mano_artifacts" has been provided, in which case such artifacts shall
            be excluded;
          - the URI query parameter "select_non_mano_artifact_sets" has been provided and is supported by the NFVO,
            in which case only those non-MANO artifacts shall be included whose non-MANO artifact set identifier matches
            one of the values of the query parameter. Package metadata such as manifest file or VNFD shall not be included
            in the archive. This method shall follow the provisions specified in the Tables 9.4.5a.3.2-1 and 9.4.5a.3.2-2
            for URI query parameters, request and response data structures, and response codes.
474
      parameters:
475
476
477
478
479
480
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_all_mano_artifacts
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_all_non_mano_artifacts
        - $ref: ../components/SOL005_params.yaml#/components/parameters/select_non_mano_artifact_sets
481
      responses:
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
        "200":
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get'
        "206":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/206
        "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
508

509
510
511
512
513
  /vnf_packages/{vnfPkgId}/package_content/upload_from_uri:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
514
    post:
515
516
517
518
519
520
521
522
523
524
      summary: Upload a VNF package by providing the address information of the VNF
        package.
      description: |
        The POST method provides the information for the NFVO to get the content of a VNF package. This method shall
        follow the provisions specified in the Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters, request
        and response data structures, and response codes. Upon start of obtaining the package, the NFVO shall set the
        "onboardingState" attribute in the "VnfPkgInfo" structure to "UPLOADING". Upon successfully obtaining the
        package, if the package references external artifacts, the NFVO shall obtain the external artifacts. Subsequently,
        upon success, the NFVO shall set that attribute to "PROCESSING" and shall process the package, which shall include
        checking package consistency. Upon successful processing, the NFVO shall set the "onboardingState" attribute to
525
526
527
        "ONBOARDED", the "operationalState" attribute to "ENABLED", and the "usageState" attribute to "NOT_IN_USE".
        In addition, the NFVO shall set the value of the attributes in the "VnfPkgInfo" that are copied from the VNFD
        (refer to clause 9.5.2.5). If an error occurs during obtaining the package, downloading the external artifacts or processing
528
529
        the package, the NFVO shall set the "onboardingState" attribute to "ERROR" and shall populate the "onboardingFailureDetails"
        attribute in "VnfPkgInfo".
530
      parameters:
531
532
533
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageUploadFromUriRequest'
534
      responses:
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
        "202":
          $ref: '#/components/responses/IndividualVnfPackageUploadFromUri.Post'
        "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
559

560
  /vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
561
    parameters:
562
563
564
565
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: '#/components/parameters/ArtifactPath'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
566
567
    get:
      summary: Fetch individual VNF package artifact.
568
569
570
571
      description: |
        The GET method fetches the content of an artifact within a VNF package. This method shall follow the provisions
        specified in the Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
572
      parameters:
573
574
575
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
576
      responses:
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
        "200":
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get'
        "206":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/206
        "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
603

604
  /subscriptions:
605
    parameters:
606
607
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
608
    get:
609
      summary: Query multiple subscriptions.
610
611
612
613
614
      description: |
        The GET method queries the list of active subscriptions of the functional block that invokes the method.
        It can be used e.g. for resynchronization after error situations. This method shall follow the provisions
        specified in the Tables 9.4.8.3.2-1 and 9.4.8.3.2-2 for URI query parameters, request and response data
        structures, and response codes.
615
      parameters:
616
617
618
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
619
      responses:
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
        "200":
          $ref: '#/components/responses/VnfPkgSubscriptions.Get'
        "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
        "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
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
    post:
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
      description: |
        The POST method creates a new subscription. This method shall follow the provisions specified in the Tables
        9.4.8.3.1-1 and 9.4.8.3.1-2 for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, a new "Individual subscription" resource shall exist as
        defined in clause 9.4.9. This method shall not trigger any notification. Creation of two subscription resources
        with the same callbackURI and the same filter can result in performance degradation and will provide duplicates
        of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either
        allow creating a subscription resource if another subscription resource with the same filter and callbackUri
        already exists (in which case it shall return the "201 Created" response code), or may decide to not create a
        duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing the
        existing subscription resource with the same filter and callbackUri).
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPkgSubscriptionRequest'
      responses:
        "201":
          $ref: '#/components/responses/VnfPkgSubscriptions.Post'
        "303":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/303
        "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
        "422":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/422
        "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
684

685
  /subscriptions/{subscriptionId}:
686
    parameters:
687
688
689
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
690
    get:
691
      summary: Read an individual subscription resource.
692
693
      description: |
        Query Subscription Information The GET method reads an individual subscription.
694
      parameters:
695
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
696
      responses:
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
        "200":
          $ref: '#/components/responses/VnfPkgSubscription.Get'
        "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
        "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
717

718
    delete:
719
      summary: Terminate a subscription.
720
721
722
723
724
725
726
      description: |
        The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the
        Tables 9.4.9.3.5-1 and 9.4.9.3.5-2 for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, the "Individual subscription" resource shall not exist any longer.
        This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer.
        NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer
        for a certain time period after the deletion.
727
      responses:
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
        "204":
          $ref: '#/components/responses/VnfPkgSubscription.Delete'
        "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
        "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:
    VnfPkgId:
      name: vnfPkgId
      in: path
      description: |
        Identifier of the VNF package. The identifier is allocated by the NFVO.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPath:
      name: artifactPath
      in: path
      description: |
766
        For an artifact contained as a file in the VNF package, this variable shall contain a sequence of one or more path
767
768
769
770
771
772
773
774
775
        segments representing the path of the artifact within the VNF package, relative to the root of the package.
        See note 3. EXAMPLE: foo/bar/m%40ster.sh For an external artifact represented as a URI in the VNF package manifest,
        this variable shall contain a sequence of one or more path segments as synthesized by the NFVO (see clause 9.5.3.3),
        representing this artifact. See note 2 and note 3
      required: true
      style: simple
      explode: false
      schema:
        type: string
776

777
778
779
780
781
    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
        Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
782
        HTTP header in the response to a POST request creating a new "Individual subscription" resource. It can also be retrieved
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
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
860
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
895
896
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
        from the "id" attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

  requestBodies:
    VnfPackageCreationRequest:
      description: |
        IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest
      required: true

    VnfPackageModificationRequest:
      description: |
        Parameters for VNF package information modifications.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
      required: true

    VnfPackageExtArtifactsRequest:
      description: |
        The payload body contains the access configuration information based on which the NFVO can obtain the
        external VNF package artifact files.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
      required: true

    VnfPackageContentRequest:
      content:
        application/binary:
          schema:
            properties:
              file:
                type: string
                description: |
                  The payload body contains a ZIP file that represents the VNF package. The "Content-Type" HTTP header shall
                  be set according to the type of the file, i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
                format: binary
      required: true

    VnfPackageUploadFromUriRequest:
      description: |
        The payload body contains the address information based on which the NFVO can obtain the content of the VNF package.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest
      required: true

    VnfPkgSubscriptionRequest:
      description: |
        Details of the subscription to be created.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest
      required: true

  responses:
    VnfPackages.Get:
      description: |
        200 OK
        Shall be returned when information about zero or more VNF packages has been queried successfully.
        The response body shall contain in an array the VNF package info representations that match the attribute
        filter, i.e. zero or more VNF package info representations as defined in clause 9.5.2.5.
        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: |
            Version of the API used in the response.
          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:
            type: array
            items:
              $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo

    VnfPackages.Post:
      description: |
        201 Created
        Shall be returned when an "Individual VNF package" resource has been created successfully. The response body
        shall contain a representation of the new individual VNF package resource, as defined in clause 9.5.2.5.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the individual
        VNF package resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo

    IndividualVnfPackage.Get:
      description: |
        200 OK
        Shall be returned when information of the VNF package has been read successfully. The response body shall
        contain the VNF package info representation defined in clause 9.5.2.5.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo

    IndividualVnfPackage.Delete:
      description: |
        204 No Content
        The VNF package has been deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackage.Patch:
      description: |
        200 OK
        Shall be returned when the operation has been completed successfully. The response body shall contain
        attribute modifications for an "Individual VNF package" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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
For faster browsing, not all history is shown. View entire blame