NSDManagement.yaml 105 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
4
5
  title: SOL005 - NSD Management Interface 
  description: |
6
    SOL005 - NSD 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.
12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
13
14
  contact:
    name: NFV-SOL WG
15
  license:
16
    name: ETSI Forge copyright notice
17
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
18
  version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
19

20
externalDocs:
21
  description: ETSI GS NFV-SOL 005 V3.3.1
22
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
23

24
25
26
servers:
  - url: http://127.0.0.1/nsd/v2
  - url: https://127.0.0.1/nsd/v2
27

28
paths:
29
30
31
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
32
  /api_versions:
33
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
34

35
36
37
  ###############################################################################
  # NS Descriptors                                                              #
  ###############################################################################
38
  /ns_descriptors:
39
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
40
    parameters:
41
42
43
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
44
45
46

    post:
      summary: Create a new NS descriptor resource.
47
      description: |
48
        The POST method is used to create a new NS descriptor resource.
49
      parameters:
50
51
52
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreateNsdInfoRequest'
53
54
      responses:
        201:
55
          $ref: '#/components/responses/NSDescriptors.Post.201'
56
        400:
57
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
58
        401:
59
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
60
        403:
61
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
62
        404:
63
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
64
        405:
65
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
66
        406:
67
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
68
        500:
69
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
70
        503:
71
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
72
        504:
73
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
74

75
    get:
76
      summary: Query information about multiple NS descriptor resources.
77
      description: |
78
        The GET method queries information about multiple NS descriptor resources.
79
80
81
82
83
84
85
      parameters:      
        - $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
86
87
      responses:
        200:
88
          $ref: '#/components/responses/NSDescriptors.Get.200'
89
        400:
90
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
91
        401:
92
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
93
        403:
94
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
95
        404:
96
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
97
        405:
98
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
99
        406:
100
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
101
        500:
102
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
103
        503:
104
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
105
        504:
106
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
107
108
109
110

  ###############################################################################
  # Individual NS Descriptor                                                    #
  ###############################################################################
111
  /ns_descriptors/{nsdInfoId}:
112
113
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
114
115
116
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
117

118
    get:
119
      summary: Read information about an individual NS descriptor resource.
120
      description: |
121
        The GET method reads information about an individual NS descriptor.
122
      parameters:
123
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
124
125
      responses:
        200:
126
          $ref: '#/components/responses/IndividualNSDescriptor.Get.200'
127
        400:
128
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
129
        401:
130
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
131
        403:
132
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
133
        404:
134
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
135
        405:
136
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
137
        406:
138
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
139
        500:
140
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
141
        503:
142
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
143
        504:
144
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
145

146
    patch:
147
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
148
      description: |
149
150
151
152
153
154
155
156
        The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
        This method can be used to:
        1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new
        network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as a
        result.
        2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of
        new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change
        as a result.
157
        3) Modify the user defined data of an individual NS descriptor resource.
158
159
      requestBody:
        $ref: '#/components/requestBodies/NsdInfoModifications'
160
      responses:
161
        200:
162
          $ref: '#/components/responses/IndividualNSDescriptor.Patch.200'
163
        400:
164
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
165
        401:
166
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
167
        403:
168
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
169
        404:
170
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
171
        405:
172
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
173
        406:
174
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
175
        409:
176
          #  description: |
177
178
179
180
181
182
183
184
185
186
187
188
          #    409 CONFLICT

          #    Error: The operation cannot be executed currently,
          #    due to a conflict with the state of the resource.
          #    Typically, this is due to an operational state
          #    mismatch, i.e. enable an already enabled or
          #    disable an already disabled individual NS
          #    descriptor resource, or the "nsdOnboardingState"
          #    is not ONBOARDED.
          #    The response body shall contain a ProblemDetails
          #    structure, in which the "detail" attribute shall convey
          #    more information about the error.
189
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
190
        412:
191
          $ref: "../responses/SOL005_resp.yaml#/components/responses/412"
192
        500:
193
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
194
        503:
195
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
196
        504:
197
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
198

199
    delete:
200
      summary: Delete an individual NS descriptor resource.
201
      description: |
202
203
204
205
206
207
        The DELETE method deletes an individual NS descriptor resource.
        An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState =
        NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method
        shall fail.
      responses:
        204:
208
          $ref: '#/components/responses/IndividualNSDescriptor.Delete.204'
209
        400:
210
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
211
        401:
212
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
213
        403:
214
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
215
        404:
216
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
217
        405:
218
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
219
        406:
220
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
221
        409:
222
          #  description: |
223
224
225
226
227
228
229
230
231
232
233
234
          #    409 CONFLICT

          #    Error: The operation cannot be executed currently,
          #    due to a conflict with the state of the resource.
          #    Typically, this is due to the fact the NS descriptor
          #    resource is in the enabled operational state (i.e.
          #    operationalState = ENABLED) or there are running
          #    NS instances using the concerned individual NS
          #    descriptor resource (i.e. usageState = IN_USE).
          #    The response body shall contain a ProblemDetails
          #    structure, in which the "detail" attribute shall convey
          #    more information about the error.
235
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
236
        500:
237
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
238
        503:
239
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
240
        504:
241
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
242
243

  ###############################################################################
244
  # NSD Archive Content                                                         #
245
  ###############################################################################
246
  /ns_descriptors/{nsdInfoId}/nsd_content:
247
248
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
249
250
251
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
252

253
    get:
254
      summary: Fetch the content of a NSD.
255
      description: |
256
257
258
259
260
261
262
263
264
265
266
267
268
269
        The GET method fetches the content of the NSD archive.
        The NSD archive is implemented as a single zip file.
        The content of the NSD archive is provided as onboarded,
        i.e. depending on the security option used, 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 007.

        NOTE:	Information about the applicable security option can be
                obtained by evaluating the "archiveSecurityOption"
                attribute in the "nsdInfo" structure.

        This method shall follow the provisions specified in the T
        ables 5.4.4.3.2-1 and 5.4.4.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
270
      parameters:
271
272
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
273
274
      responses:
        200:
275
          $ref: '#/components/responses/NsdArchiveContent.Get.200'
276
        206:
277
          #  description: |
278
279
280
281
282
283
284
285
286
287
288
          #    206 PARTIAL CONTENT

          #    On success, if the NFVO supports range requests,
          #    a single consecutive byte range from the content of
          #    the NSD file is returned.
          #    The response body shall contain the requested part
          #    of the NSD file.
          #    The "Content-Range" HTTP header shall be
          #    provided according to IETF RFC 7233.
          #    The "Content-Type" HTTP header shall be set as
          #    defined above for the "200 OK" response.
289
          $ref: "../responses/SOL005_resp.yaml#/components/responses/206"
290
        400:
291
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
292
        401:
293
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
294
        403:
295
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
296
        404:
297
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
298
        405:
299
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
300
        406:
301
          #  description: |
302
303
304
305
306
307
308
309
310
          #    406 NOT ACCEPTABLE

          #    If the "Accept" header does not contain at least one
          #    name of a content type for which the NFVO can
          #    provide a representation of the NSD, the NFVO
          #    shall respond with this response code.
          #    The "ProblemDetails" structure may be included
          #    with the "detail" attribute providing more information
          #    about the error.
311
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
312
        409:
313
          #  description: |
314
315
316
317
318
319
320
321
322
323
324
          #    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
          #    "nsdOnboardingState" has a value different from
          #    ONBOARDED.
          #    The response body shall contain a ProblemDetails
          #    structure, in which the "detail" attribute shall convey
          #    more information about the error.
325
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
326
        416:
327
          #  description: |
328
329
330
331
332
333
334
          #    416 RANGE NOT SATISFIABLE

          #    The byte range passed in the "Range" header did
          #    not match any available byte range in the NSD file
          #    (e.g. "access after end of file").
          #    The response body may contain a ProblemDetails
          #    structure.
335
          $ref: "../responses/SOL005_resp.yaml#/components/responses/416"
336
        500:
337
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
338
        503:
339
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
340
        504:
341
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
342

343
    put:
344
      summary: Upload the content of a NSD.
345
      description: |
346
347
348
349
350
        The PUT method is used to upload the content of an NSD archive.
        The NSD to be uploaded is implemented as a single ZIP file as defined in clause 5.4.4.3.2.
        The "Content-Type" HTTP header in the PUT request shall be set to "application/zip".
        This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and
        5.4.4.3.3-2 for URI query parameters, request and response data structures, and response codes.
351
      parameters:
352
        - $ref: '#/components/parameters/ContentTypeZip'
353
354
      responses:
        202:
355
          $ref: '#/components/responses/NsdArchiveContent.Put.202'
356
        204:
357
          $ref: '#/components/responses/NsdArchiveContent.Put.204'
358
        400:
359
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
360
        401:
361
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
362
        403:
363
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
364
        404:
365
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
366
        405:
367
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
368
        406:
369
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
370
        409:
371
          #          description: |
372
373
374
375
376
377
378
379
380
381
          #            409 CONFLICT
          #
          #            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
          #            NsdOnboardingState has a value other than
          #            CREATED.
          #            The response body shall contain a ProblemDetails
          #            structure, in which the "detail" attribute shall convey
          #            more information about the error.
382
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
383
        500:
384
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
385
        503:
386
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
387
        504:
388
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
389
390
391
392

  ###############################################################################
  # NSD                                                                         #
  ###############################################################################
393
  /ns_descriptors/{nsdInfoId}/nsd:
394
395
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a
    parameters:
396
397
398
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
399
400

    get:
401
      description: |
402
403
404
405
406
407
408
409
410
411
412
413
414
        The GET method reads the content of the NSD within an NSD archive.
        The NSD can be implemented as a single file or as a collection of
        multiple files. If the NSD is implemented in the form of multiple files,
        a ZIP file embedding these files shall be returned. If the NSD is implemented
        as a single file, either that file or a ZIP file embedding that file shall be returned.
        The selection of the format is controlled by the "Accept" HTTP header passed in the GET request:
        •	If the "Accept" header contains only "text/plain" and the NSD is implemented as a single file,
            the file shall be returned; otherwise, an error message shall be returned.
        •	If the "Accept" header contains only "application/zip", the single file or
            the multiple files that make up the NSD shall be returned embedded in a ZIP file.
        •	If the "Accept" header contains both "text/plain" and "application/zip", it is up
            to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD,
            a ZIP file shall be returned.
415
        The default format of the ZIP file shall comply with the CSAR format as specified in ETSI GS NFV-SOL 007
416
417
        where only the YAML files representing the NSD, and information necessary to navigate
        the ZIP file and to identify the file that is the entry point for parsing the NSD and
418
        (if requested) further security information are included and other artifacts referenced from the YAML files are excluded. This means that the content
419
420
        of the ZIP archive shall contain the following files from the NSD archive:
        •	TOSCA.meta (if available in the NSD archive);
421
        •	The main TOSCA definitions YAML file (either as referenced by the Entry-Definitions keyword from TOSCA.meta or available as a
422
            file with the extension ".yml" or ".yaml" from the root of the archive);
423
424
425
426
427
428
429
430
        •	Other TOSCA YAML files, if any, as referenced by the Other-Definitions keyword from TOSCA.meta;
        •	Every component of the NSD referenced (recursively) from the theYAML files as mentioned above;
          NOTE 1: For a NSD based on TOSCA, it includes all the imported type definition files as indicated 
          in the top level the main service template and in any of the lower level service template if it 
          has any as described in ETSI GS NFV-SOL 001.
          NOTE 2: For a NSD based on YANG, it includes the file as indicated by the "yang_definitions" 
          keyname in the metadata section of the main yaml file as described in ETSI GS NFV-SOL 007.
        •	The related security information, if the "include_signatures" URI parameter is provided, as follows:
431
432
433
434
435
436
437
438
        -	the manifest file;
        -	the singleton certificate file in the root of the NSD archive (if available in the NSD archive);
        -	the signing certificates of the individual files included in the ZIP archive
            (if available in the NSD archive);
        -	the signatures of the individual files (if available in the NSD archive).
        This method shall follow the provisions specified in the Tables 5.4.4a.3.2-1 and 5.4.4a.3.2-2 for
        URI query parameters, request and response data structures, and response codes.
      parameters:
439
440
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
        - $ref: '#/components/parameters/AcceptTextOrZip'
441
442
      responses:
        200:
443
          $ref: '#/components/responses/NSD.Get.200'
444
        400:
445
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
446
        401:
447
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
448
        403:
449
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
450
        404:
451
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
452
        405:
453
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
454
        406:
455
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
456
        409:
457
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
458
        500:
459
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
460
        503:
461
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
462
        504:
463
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
464
465
466
467

  ###############################################################################
  # NSD Archive Manifest                                                        #
  ###############################################################################
468
  /ns_descriptors/{nsdInfoId}/manifest:
469
470
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b
    parameters:
471
472
473
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
474
475
476

    get:
      summary: Fetch the content of the manifest in an NSD archive.
477
      description: |
478
479
480
481
482
        The GET method reads the content of the manifest file within an NSD archive.
        This method shall follow the provisions specified in the Tables 5.4.4b.3.2-1
        and 5.4.4b.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
      parameters:
483
484
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
485
486
      responses:
        200:
487
          $ref: '#/components/responses/NsdArchiveManifest.Get.200'
488
        400:
489
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
490
        401:
491
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
492
        403:
493
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
494
        404:
495
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
496
        405:
497
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
498
        409:
499
          #  description: |
500
501
502
503
504
505
506
507
508
509
510
          #    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
          #    "nsdOnboardingState" has a value different from
          #    ONBOARDED.
          #    The response body shall contain a ProblemDetails
          #    structure, in which the "detail" attribute shall convey
          #    more information about the error.
511
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
512
        500:
513
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
514
        503:
515
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
516
        504:
517
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
518

519
520
521
  ###############################################################################
  # Individual NSD Archive Artifact                                             #
  ###############################################################################
522
  /ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}:
523
524
    #ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.4c
    parameters:
525
526
527
528
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: '#/components/parameters/ArtifactPathInNSD'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
529
    get:
530
      description: |
531
532
533
534
535
536
537
        The GET method fetches the content of an individual artifact within 
        a NSD archive.

        This method shall follow the provisions specified in the Tables 5.4.4c.3.2-1 
        and 5.4.4c.3.2-2 for URI query parameters, request and response data structures, 
        and response codes.
      parameters:
538
539
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
540
541
      responses:
        200:
542
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.200'
543
        206:
544
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.206'
545
546
547
548
549
550
551
552
553
        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"
        406:
554
          # description: |
555
556
557
558
559
560
561
562
563
564
          #   If the related request contained an "Accept" header not compatible with the Content type
          #   "application/zip" but the "include_signatures" flag was provided, the NFVO shall respond 
          #   with this response code.

          #   The "ProblemDetails" structure may be included with the "detail" attribute providing more 
          #   information about the error.
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
565
          # description: |
566
567
568
569
570
571
572
573
574
575
          #   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 "nsdOnboardingState" has a value different from
          #   "ONBOARDED".

          #   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:
576
          # description: |
577
578
579
580
581
582
583
584
585
586
587
588
          #   The byte range passed in the "Range" header did not match any available byte range in the 
          #   artifact file (e.g. "access after end of file").

          #   The response body may contain a ProblemDetails structure.
          $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"
  
589
590
591
  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
592
  /pnf_descriptors:
593
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
594
    parameters:
595
596
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
597
598
599

    post:
      summary: Create a new PNF descriptor resource.
600
      description: |
601
602
        The POST method is used to create a new PNF descriptor resource
      parameters:
603
604
605
606
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreatePnfdInfoRequest'
607
608
      responses:
        201:
609
          $ref: '#/components/responses/PNFDescriptors.Post.201'
610
        400:
611
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
612
        401:
613
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
614
        403:
615
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
616
        404:
617
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
618
        405:
619
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
620
        406:
621
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
622
        500:
623
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
624
        503:
625
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
626
        504:
627
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
628

629
    get:
630
      summary: Query information about multiple PNF descriptor resources.
631
      description: |
632
633
        "The GET method queries information about multiple PNF descriptor
        resources."
634
      parameters:
635
636
637
638
639
640
        - $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
641
642
      responses:
        200:
643
          $ref: '#/components/responses/PNFDescriptors.Get.200'
644
        400:
645
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
646
        401:
647
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
648
        403:
649
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
650
        404:
651
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
652
        405:
653
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
654
        406:
655
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
656
        500:
657
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
658
        503:
659
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
660
        504:
661
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
662

663
664
665
  ###############################################################################
  # Individual PNF Descriptor                                                   #
  ###############################################################################
666
  /pnf_descriptors/{pnfdInfoId}:
667
668
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
    parameters:
669
      - $ref: '#/components/parameters/PnfdInfoId'
670

671
    get:
672
      summary: Read an individual PNFD resource.
673
      description: |
674
675
        The GET method reads information about an individual PNF descriptor.
      parameters:
676
677
678
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
679
680
      responses:
        200:
681
          $ref: '#/components/responses/IndividualPnfDescriptor.Get.200'
682
        400:
683
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
684
        401:
685
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
686
        403:
687
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
688
        404:
689
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
690
        405:
691
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
692
        406:
693
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
694
        500:
695
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
696
        503:
697
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
698
        504:
699
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
700
701
702

    patch:
      summary: Modify the user defined data of an individual PNF descriptor resource.
703
      description: |
704
705
        The PATCH method modifies the user defined data of an individual PNF descriptor resource.
      parameters:
706
707
708
709
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/PnfdInfoModifications'
710
711
      responses:
        200:
712
          $ref: '#/components/responses/IndividualPnfDescriptor.Patch.200'
713
        400:
714
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
715
        401:
716
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
717
        403:
718
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
719
        404:
720
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
721
        405:
722
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
723
        406:
724
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
725
        412:
726
          $ref: "../responses/SOL005_resp.yaml#/components/responses/412"
727
        500:
728
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
729
        503:
730
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
731
        504:
Francesca Moscatelli's avatar