NSDManagement.yaml 69.2 KB
Newer Older
1
swagger: "2.0"
2

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

19
externalDocs:
20
21
  description: ETSI GS NFV-SOL 005 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
22

23
basePath: /nsd/v1
24

25
schemes:
26
  - http
27
  - https
28

29
consumes:
30
  - application/json
31

32
produces:
33
  - application/json
34

35
paths:
36
37
38
39
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
40
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
41

42
43
44
  ###############################################################################
  # NS Descriptors                                                              #
  ###############################################################################
45
  '/ns_descriptors':
46
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string

    post:
      summary: Create a new NS descriptor resource.
      description: >
        The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
        - name: CreateNsdInfoRequest
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
            description: >
              Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.
      responses:
        201:
          description: >
            201 CREATED

93
            An NS descriptor resource has been created successfully, as a new NS descriptor resource.
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
            The response body shall contain a representation of the new NS descriptor resource,
            as defined in clause 5.5.2.2.
            The HTTP response shall include a "Location" HTTP header that contains the resource URI
            of the new NS descriptor resource.
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
          headers:
            Content-Type:
              type: string
              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.
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
137

138
    get:
139
      summary: Query information about multiple NS descriptor resources.
140
141
      description: >
        The GET method queries information about multiple NS descriptor resources.
142
        This method shall follow the provisions specified in the
143
        Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters,
144
        request and response data structures, and response codes.
145
      parameters:
146
147
        - name: filter
          in: query
148
          required: false
149
150
          type: string
          description: >
151
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
152
153
154
155
            The NFVO shall support receiving this filtering parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the NsdInfo and in data types referenced from it shall
            be supported by the NFVO in the filter expression.
156
157
        - name: all_fields
          in: query
158
          required: false
159
160
          type: string
          description: >
161
            Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV SOL 013 for details.
162
            The NFVO shall support this parameter.
163
164
        - name: fields
          in: query
165
          required: false
166
167
          type: string
          description: >
168
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV SOL 013 for
169
170
171
            details. The NFVO should support this parameter.
        - name: exclude_fields
          in: query
172
          required: false
173
174
          type: string
          description: >
175
            Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV SOL 013 for
176
177
178
            details. The NFVO should support this parameter.
        - name: exclude_default
          in: query
179
          required: false
180
181
          type: string
          description: >
182
183
            Indicates to exclude the following complex attributes from the response.
            See clause 5.3 of ETSI GS NFV SOL 013 for details.
184
185
186
187
            The VNFM shall support this parameter.
            The following attributes shall be excluded from the NsdInfo structure in the response body if this
            parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default"
            are provided: userDefinedData.
188
189
190
191
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
192
193
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
            ETSI GS NFV-SOL 013 for this resource.
194
195
          required: false
          type: string
196
197
198
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
199
            Reference: IETF RFC 7231.
200
          in: header
201
          required: true
202
          type: string
203
204
      responses:
        200:
205
          description: >
206
            200 OK
207

208
            Information about zero or more NS descriptors.
209
210
211
212
            The response body shall contain in an array the representations of zero or more NS descriptors,
            as defined in clause 5.5.2.2.
            If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
            inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
213
214
          headers:
            Content-Type:
215
              description: The MIME type of the body of the response.
216
217
218
              type: string
              maximum: 1
              minimum: 1
219
            WWW-Authenticate:
220
              type: string
221
222
              description: >
                Challenge if the corresponding HTTP request has not provided
223
224
225
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
226
227
228
229
230
231
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
232
              minimum: 1
233
234
235
236
237
238
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
239
240
241
          schema:
            type: array
            items:
242
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
243
        400:
244
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
245
        401:
246
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
247
        403:
248
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
249
        404:
250
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
251
        405:
252
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
253
        406:
254
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
255
        500:
256
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
257
        503:
258
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
259
260
261
262

  ###############################################################################
  # Individual NS Descriptor                                                    #
  ###############################################################################
263
  '/ns_descriptors/{nsdInfoId}':
264
265
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
266
      - name: nsdInfoId
267
268
        description: >
          Identifier of the individual NS descriptor resource.
269
        in: path
270
        required: true
271
        type: string
272
273
274
275
276
277
278
279
280
281
282
283
284
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
285

286
    get:
287
      summary: Read information about an individual NS descriptor resource.
288
289
      description: >
        The GET method reads information about an individual NS descriptor.
290
291
        This method shall follow the provisions specified in GS NFV-SOL 005 Tables
        5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,
292
        request and response data structures, and response codes.
293
      parameters:
294
295
296
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
297
            Reference: IETF RFC 7231.
298
299
300
          in: header
          required: true
          type: string
301
302
      responses:
        200:
303
304
          description: >
            200 OK
305

306
            Information about the individual NS descriptor.
307
308
            The response body shall contain a representation of the individual NS descriptor,
            as defined in clause 5.5.2.2.
309
          schema:
310
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
311
          headers:
312
            Content-Type:
313
              type: string
314
315
316
              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.
317
            WWW-Authenticate:
318
              type: string
319
320
              description: >
                Challenge if the corresponding HTTP request has not provided
321
322
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
323
324
              maximum: 1
              minimum: 0
325
326
327
328
329
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
330
              minimum: 1
331
        400:
332
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
333
        401:
334
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
335
        403:
336
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
337
        404:
338
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
339
        405:
340
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
341
        406:
342
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
343
        500:
344
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
345
        503:
346
347
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

348
    patch:
349
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
350
      description: >
351
        The PATCH method modifies the operational state and/or user defined
352
353
354
355
356
357
358
359
        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 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 changes a result.
        3) Modify the user defined data of an individual NS descriptor resource.
360
      parameters:
361
        - name: NsdInfoModifications
362
363
364
          in: body
          required: true
          schema:
365
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
366
367
368
369
370
371
372
373
374
375
            description: >
              Parameters for the modification of an individual NS descriptor resource.
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
376
        200:
377
          description: >
378
            200 OK
379

380
            The operation has been completed successfully.
381
382
            The response body shall contain attribute modifications for an 'Individual NS Descriptor'
            resource (see clause 5.5.2.6).
383
384
          headers:
            Content-Type:
385
386
387
388
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
389
            WWW-Authenticate:
390
              type: string
391
392
              description: >
                Challenge if the corresponding HTTP request has not provided
393
394
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
395
396
              maximum: 1
              minimum: 0
397
398
399
400
401
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
402
              minimum: 1
403
          schema:
404
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
405
        400:
406
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
407
        401:
408
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
409
        403:
410
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
411
        404:
412
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
413
        405:
414
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
415
        406:
416
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
417
        409:
418
          description: >
419
420
            409 CONFLICT

421
422
423
424
425
            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.
426
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
427
        412:
428
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
429
        500:
430
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
431
        503:
432
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
433

434
    delete:
435
      summary: Delete an individual NS descriptor resource.
436
      description: >
437
438
439
440
441
442
443
444
        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.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
445
            Reference: IETF RFC 7235.
446
447
          in: header
          required: false
448
449
450
451
452
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
453
          required: true
454
          type: string
455
456
      responses:
        204:
457
          description: >
458
            204 NO CONTENT
459

460
461
462
463
            The operation has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
464
              type: string
465
466
              description: >
                Challenge if the corresponding HTTP request has not provided
467
468
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
469
470
              maximum: 1
              minimum: 0
471
472
473
474
475
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
476
              minimum: 1
477
        400:
478
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
479
        401:
480
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
481
        403:
482
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
483
        404:
484
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
485
        405:
486
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
487
        406:
488
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
489
        409:
490
          description: >
491
492
            409 CONFLICT

493
494
495
496
497
498
            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.
499
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
500
        500:
501
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
502
        503:
503
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
504
505
506
507

  ###############################################################################
  # NSD Content                                                                 #
  ###############################################################################
508
  '/ns_descriptors/{nsdInfoId}/nsd_content':
509
510
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
511
512
      - name: nsdInfoId
        in: path
513
        required: true
514
        type: string
515
516
517
518
519
520
521
522
523
524
525
526
527
528
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string

529
    get:
530
      summary: Fetch the content of a NSD.
531
      description: >
532
533
534
        The GET method fetches the content of the NSD.
        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
535
536
537
538
539
540
541
542
543
544
545
        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.NOTE: The structure
546
        of the NSD zip file is outside the scope of the present document.
547
      parameters:
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: Range
          in: header
          required: false
          type: string
          description: >
            "The request may contain a "Range" HTTP header to obtain single
            range of bytes from the NSD file. This can be used to continue an aborted
            transmission.If the NFVO does not support range requests, the NFVO
            shall ignore the 'Range" header, process the GET request, and return
            the whole NSD file with a 200 OK response (rather than returning a 4xx
            error status code)."
568
569
      responses:
        200:
570
          description: >
571
            200 OK
572

573
            Shall be returned when the content of the NSD has been read successfully.
574
575
576
577
578
579
580
581
            The payload body shall contain a copy of the file
            representing the NSD or a ZIP file that contains the file
            or multiple files representing the NSD, as specified
            above.
            The "Content-Type" HTTP header shall be set
            according to the format of the returned file, i.e. to
            "text/plain" for a YAML file or to "application/zip" for a
            ZIP file.
582
583
          headers:
            Content-Type:
584
585
586
587
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
588
            WWW-Authenticate:
589
              type: string
590
591
              description: >
                Challenge if the corresponding HTTP request has not provided
592
593
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
594
595
              maximum: 1
              minimum: 0
596
597
598
599
600
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
601
              minimum: 1
602
        206:
603
          description: >
604
605
            206 PARTIAL CONTENT

606
607
608
609
610
            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.
611
          $ref: "../responses/SOL005_resp.yaml#/responses/206"
612
        400:
613
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
614
        401:
615
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
616
        403:
617
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
618
        404:
619
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
620
        405:
621
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
622
        406:
623
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
624
        409:
625
          description: >
626
627
            409 CONFLICT

628
629
            Shall be returned upon the following error:
            The operation cannot be executed currently, due to a conflict with the state of the resource.
630
631
632
            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.
633
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
634
        416:
635
          description: >
636
637
            416 RANGE NOT SATISFIABLE

638
639
640
            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.
641
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
642
        500:
643
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
644
        503:
645
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
646

647
    put:
648
      summary: Upload the content of a NSD.
649
      description: >
650
651
        "The PUT method is used to upload the content of a NSD. The NSD
        to be uploaded can be implemented as a single file or as a collection of
652
653
654
655
656
        multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. 
        If the NSD is implemented in the form of multiple files, a ZIP file embedding these
        files shall be uploaded. 
        If the NSD is implemented as a single file, either that file or a ZIP file 
        embedding that file shall be uploaded. The "Content-Type"
657
        HTTP header in the PUT request shall be set accordingly based on the format
658
659
660
661
662
663
        selection of the NSD. 
        If the NSD to be uploaded is a text file, the "Content-Type"
        header is set to "text/plain". 
        If the NSD to be uploaded is a zip file,
        the "Content-Type" header is 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
664
665
        of GS-NFV-SOL 005 for URI query parameters, request and response data structures,
        and response codes."
666
      parameters:
667
668
669
670
671
672
673
674
675
676
677
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            The payload body contains a copy of the file representing the NSD
            or a ZIP file that contains the file or multiple files representing the NSD.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
678
679
      responses:
        202:
680
          description: >
681
            202 ACCEPTED
682

683
            The NSD content has been accepted for uploading, but the processing has not been completed.
684
685
            It is expected to take some time for processing (asynchronous mode).
            The response body shall be empty.
686

687
688
689
            The client can track the uploading progress by receiving the "NsdOnBoardingNotification" and
            "NsdOnBoardingFailureNotification" from the NFVO or by reading the status of the individual
            NS descriptor resource using the GET method.
690
691
692
693
694
695
696
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
697
              type: string
698
699
              description: >
                Challenge if the corresponding HTTP request has not provided
700
701
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
702
703
              maximum: 1
              minimum: 0
704
705
706
707
708
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
709
              minimum: 1
710
        204:
711
          description: >
712
            204 NO CONTENT
713

714
            The NSD content successfully uploaded and validated (synchronous mode).
715
            The response body shall be empty.
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
731
        400:
732
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
733
        401:
734
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
735
        403:
736
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
737
        404:
738
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
739
        405:
740
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
741
        406:
742
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
743
        409:
744
          description: >
745
746
            409 CONFLICT

747
748
749
750
            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.
751
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
752
        500:
753
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
754
        503:
755
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
756
757
758
759

  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
760
  '/pnf_descriptors':
761
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string

    post:
      summary: Create a new PNF descriptor resource.
      description: >
        The POST method is used to create a new PNF descriptor resource
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
        - name: CreatePnfdInfoRequest
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
            description: >
              Parameters of creating a PNF descriptor resource.
      responses:
        201:
          description: >
            201 CREATED

808
            A PNF descriptor resource has been created successfully, as a new PNF descriptor resource.
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
            The response body shall contain a representation of
            the new PNF descriptor resource, as defined in
            clause 5.5.2.5.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the new
            PNF descriptor resource.            
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
          headers:
            Content-Type:
              type: string
              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.
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
854

855
    get:
856
      summary: Query information about multiple PNF descriptor resources.
857
      description: >
858
859
        "The GET method queries information about multiple PNF descriptor
        resources."
860
      parameters:
861
862
863
864
865
        - name: filter
          in: query
          required: false
          type: string
          description: >
866
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
867
868
869
            The NFVO shall support receiving this filtering parameter as part
            of the URI query string. The OSS/BSS may supply this parameter.
            All attribute names that appear in the PnfdInfo and in data types
870
            referenced from it shall be supported by the NFVO in the filter expression.
871
872
873
874
875
        - name: all_fields
          in: query
          required: false
          type: string
          description: >
876
            Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
877
878
879
880
881
882
            The NFVO shall support this parameter.
        - name: fields
          in: query
          required: false
          type: string
          description: >
883
            Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for
884
885
886
887
888
889
            details. The NFVO should support this parameter.
        - name: exclude_fields
          in: query
          required: false
          type: string
          description: >
890
            Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for
891
892
893
894
895
896
897
            details. The NFVO should support this parameter.
        - name: exclude_default
          in: query
          required: false
          type: string
          description: >
            Indicates to exclude the following complex attributes from the response. See
898
            clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
899
900
901
902
903
904
905
906
907
908
            The following attributes shall be excluded from the PnfdInfo structure in the
            response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            userDefinedData.
        - name: nextpage_opaque_marker
          in: query
          type: string
          required: false
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
909
910
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
            ETSI GS NFV-SOL 013 for this resource.
911
912
      responses:
        200:
913
          description: >
914
            200 OK
915

916
917
918
            Information about zero or more PNF descriptors.
            The response body shall contain a representation of
            zero or more PNF descriptors, as defined in
919
920
921
922
923
            clause 5.5.2.5

            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.
924
925
          headers:
            Content-Type:
926
927
928
929
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
930
            WWW-Authenticate:
931
              type: string
932
933
              description: >
                Challenge if the corresponding HTTP request has not provided
934
935
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
936
937
              maximum: 1
              minimum: 0
938
939
940
941
942
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
943
              minimum: 1
944
945
946
947
948
949
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
950
          schema:
951
952
            description: >
              Information about zero or more PNF descriptors.
953
              The response body shall contain a representation in an array the representations
954
955
956
              of zero or more PNF descriptors, as defined in clause  5.5.2.2.
              If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
              inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
957
            type: array
958
            items:
959
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
960
        400:
961
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
962
        401:
963
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
964
        403:
965
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
966
        404:
967
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
968
        405:
969
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
970
        406:
971
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
972
        500:
973
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
974
        503:
975
976
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

977
978
979
  ###############################################################################
  # Individual PNF Descriptor                                                   #
  ###############################################################################
980
  '/pnf_descriptors/{pnfdInfoId}':
981
982
<