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

3
info:
4
  version: "2.0.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.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
22

23
basePath: /nsd/v2
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
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
39
  '/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
    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: >
65
        The POST method is used to create a new NS descriptor resource.
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: 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 94 95 96 97 98
            Shall be returned when a new "Individual NS descriptor" resource
            and the associated NS descriptor identifier has been created successfully.
            The response body shall contain a representation of the created 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 created NS descriptor resource.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
          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"
138 139
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
140

141
    get:
142
      summary: Query information about multiple NS descriptor resources.
143 144
      description: >
        The GET method queries information about multiple NS descriptor resources.
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
            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"
187 188 189
            are provided:
              - userDefinedData
              - onboardingFailureDetails
190 191 192 193
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
194 195
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
            ETSI GS NFV-SOL 013 for this resource.
196 197
          required: false
          type: string
198 199 200
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
201
            Reference: IETF RFC 7231.
202
          in: header
203
          required: true
204
          type: string
205 206
      responses:
        200:
207
          description: >
208
            200 OK
209

210 211
            Shall be returned when information about zero or
            more NS descriptors has been queried successfully.
212 213 214 215 216 217 218 219
            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 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.
220 221
          headers:
            Content-Type:
222
              description: The MIME type of the body of the response.
223 224 225
              type: string
              maximum: 1
              minimum: 1
226
            WWW-Authenticate:
227
              type: string
228 229
              description: >
                Challenge if the corresponding HTTP request has not provided
230 231 232
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
233 234 235 236 237 238
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
239
              minimum: 1
240 241 242 243 244 245
            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
246 247 248
          schema:
            type: array
            items:
249
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
250
        400:
251
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
252
        401:
253
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
254
        403:
255
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
256
        404:
257
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
258
        405:
259
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
260
        406:
261
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
262
        500:
263
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
264
        503:
265
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
266 267
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
268 269 270 271

  ###############################################################################
  # Individual NS Descriptor                                                    #
  ###############################################################################
272
  '/ns_descriptors/{nsdInfoId}':
273 274
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
275
      - name: nsdInfoId
276 277
        description: >
          Identifier of the individual NS descriptor resource.
278
        in: path
279
        required: true
280
        type: string
281 282 283 284 285 286 287 288 289 290 291 292 293
      - 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
294

295
    get:
296
      summary: Read information about an individual NS descriptor resource.
297 298
      description: >
        The GET method reads information about an individual NS descriptor.
299
      parameters:
300 301 302
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
303
            Reference: IETF RFC 7231.
304 305 306
          in: header
          required: true
          type: string
307 308
      responses:
        200:
309 310
          description: >
            200 OK
311

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

358
    patch:
359
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
360
      description: >
361 362 363 364 365 366 367 368
        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.
369
        3) Modify the user defined data of an individual NS descriptor resource.
370
      parameters:
371
        - name: NsdInfoModifications
372 373 374
          in: body
          required: true
          schema:
375
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
376
            description: >
377 378
              Parameters for the modification of an individual NS descriptor resource, as defined in clause 5.5.2.1.
              The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
379 380 381 382 383 384 385 386
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
387
        200:
388
          description: >
389
            200 OK
390

391
            Shall be returned when the operation has been accepted and completed successfully.
392 393
            The response body shall contain attribute modifications for an 'Individual NS Descriptor'
            resource (see clause 5.5.2.6).
394 395
          headers:
            Content-Type:
396 397 398 399
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
400
            WWW-Authenticate:
401
              type: string
402 403
              description: >
                Challenge if the corresponding HTTP request has not provided
404 405
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
406 407
              maximum: 1
              minimum: 0
408 409 410 411 412
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
413
              minimum: 1
414
          schema:
415
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
416
        400:
417
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
418
        401:
419
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
420
        403:
421
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
422
        404:
423
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
424
        405:
425
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
426
        406:
427
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
428
        409:
429 430 431 432 433 434 435 436 437 438 439 440 441
#          description: >
#            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.
442
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
443
        412:
444
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
445
        500:
446
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
447
        503:
448
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
449 450
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
451

452
    delete:
453
      summary: Delete an individual NS descriptor resource.
454
      description: >
455 456 457 458 459 460 461 462
        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.
463
            Reference: IETF RFC 7235.
464 465
          in: header
          required: false
466 467 468 469 470
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
471
          required: true
472
          type: string
473 474
      responses:
        204:
475
          description: >
476
            204 NO CONTENT
477

478
            Shall be returned when the operation has completed successfully.
479 480 481
            The response body shall be empty.
          headers:
            WWW-Authenticate:
482
              type: string
483 484
              description: >
                Challenge if the corresponding HTTP request has not provided
485 486
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
487 488
              maximum: 1
              minimum: 0
489 490 491 492 493
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
494
              minimum: 1
495
        400:
496
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
497
        401:
498
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
499
        403:
500
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
501
        404:
502
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
503
        405:
504
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
505
        406:
506
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
507
        409:
508 509 510 511 512 513 514 515 516 517 518 519 520
#          description: >
#            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.
521
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
522
        500:
523
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
524
        503:
525
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
526 527
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
528 529

  ###############################################################################
530
  # NSD Archive Content                                                                 #
531
  ###############################################################################
532
  '/ns_descriptors/{nsdInfoId}/nsd_content':
533 534
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
535 536
      - name: nsdInfoId
        in: path
537
        required: true
538
        type: string
539 540 541 542 543 544 545 546 547 548 549 550 551 552
      - 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

553
    get:
554
      summary: Fetch the content of a NSD.
555
      description: >
556 557 558 559 560 561 562 563 564 565 566 567 568 569
        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.
570
      parameters:
571 572 573 574 575 576 577 578 579 580 581 582 583 584
        - 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: >
585 586 587 588 589 590 591
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the NSD archive.
            This can be used to continue an aborted transmission.

            If the Range header is present in the request and the NFVO does
            not support responding to range requests with a 206 response,
            it shall return a 200 OK response instead as defined below.
592 593
      responses:
        200:
594
          description: >
595
            200 OK
596

597 598 599
            Shall be returned when the content of the NSD has been read successfully.
            The payload body shall contain a copy of the ZIP file that contains the NSD file structure.
            The "Content-Type" HTTP header shall be set to "application/zip".
600 601
          headers:
            Content-Type:
602 603 604 605
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
606
            WWW-Authenticate:
607
              type: string
608 609
              description: >
                Challenge if the corresponding HTTP request has not provided
610 611
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
612 613
              maximum: 1
              minimum: 0
614 615 616 617 618
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
619
              minimum: 1
620
        206:
621 622 623 624 625 626 627 628 629 630 631 632
#          description: >
#            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.
633
          $ref: "../responses/SOL005_resp.yaml#/responses/206"
634
        400:
635
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
636
        401:
637
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
638
        403:
639
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
640
        404:
641
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
642
        405:
643
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
644
        406:
645 646 647 648 649 650 651 652 653 654
#          description: >
#            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.
655
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
656
        409:
657 658 659 660 661 662 663 664 665 666 667 668
#          description: >
#            409 CONFLICT
#
#            Shall be returned upon the following error: The
#            operation cannot be executed currently, due to a
#            conflict with the state of the resource.
#            Typically, this is due to the fact
#            "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.
669
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
670
        416:
671 672 673 674 675 676 677 678
#          description: >
#            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.
679
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
680
        500:
681
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
682
        503:
683
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
684 685
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
686

687
    put:
688
      summary: Upload the content of a NSD.
689
      description: >
690 691 692 693 694
        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.
695
      parameters:
696
        - name: Content-Type
697
          description: >
698 699
            The payload body contains a ZIP file that represents the NSD archive, as specified above.
            The request shall set the "Content-Type" HTTP header to "application/zip".
700 701 702 703 704
          in: header
          required: true
          type: string
          enum:
            - application/zip
705 706
      responses:
        202:
707
          description: >
708
            202 ACCEPTED
709

710 711 712
            Shall be returned when the NSD archive has been accepted for uploading,
            but the processing has not been completed. It is expected to take some
            time for processing (asynchronous mode).
713
            The response body shall be empty.
714 715 716
            The API consumer can track the uploading progress by receiving the
            "NsdOnBoardingNotification" and "NsdOnBoardingFailureNotification"
            from the NFVO or by reading the status of the individual NS descriptor
717
            resource using the GET method.
718 719 720 721 722 723 724
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
725
              type: string
726 727
              description: >
                Challenge if the corresponding HTTP request has not provided
728 729
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
730 731
              maximum: 1
              minimum: 0
732 733 734 735 736
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
737
              minimum: 1
738
        204:
739
          description: >
740
            204 NO CONTENT
741

742 743
            The NSD content successfully uploaded and
            validated (synchronous mode).
744
            The response body shall be empty.
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
          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
760
        400:
761
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
762
        401:
763
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
764
        403:
765
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
766
        404:
767
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
768
        405:
769
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
770
        406:
771
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
772
        409:
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 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
          #          description: >
          #            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.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # NSD                                                                         #
  ###############################################################################
  '/ns_descriptors/{nsdInfoId}/nsd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a
    parameters:
      - name: nsdInfoId
        in: path
        required: true
        type: string
      - 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

    get:
      description: >
        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.
        The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 007
        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
        (if requested) further security information are included. This means that the content
        of the ZIP archive shall contain the following files from the NSD archive:
        •	TOSCA.meta (if available in the NSD archive);
        •	the main service template (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 NSD referenced (recursively) from the main service template;
        •	the related security information, if the "include_signatures" URI parameter is provided, as follows:
        -	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:
        - name: include_signatures
          in: query
          required: false
          type: string
          description: >
            If this parameter is provided, the NFVO shall include in the ZIP
            file the security information as specified above.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
        - name: Accept
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
          description: >
            The request shall contain the appropriate entries in the "Accept"
            HTTP header as defined above.
      responses:
        200:
          description: >
            200 OK

            Shall be returned when the content of the NSD has been read successfully.
            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. It shall be set to "text/plain" for a YAML file.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # NSD Archive Manifest                                                        #
  ###############################################################################
  '/ns_descriptors/{nsdInfoId}/manifest':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b
    parameters:
      - name: nsdInfoId
        description: >
          Identifier of the individual NS descriptor.
          This identifier can be retrieved from the resource referenced by
          the "Location" HTTP header in the response to a POST request creating
          a new NS descriptor resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        required: true
        type: string
      - 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

    get:
      summary: Fetch the content of the manifest in an NSD archive.
      description: >
        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:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: include_signatures
          in: query
          required: false
          type: string
971
          description: >
972 973 974 975 976 977 978 979 980 981 982 983 984 985
            If this parameter is provided, the NFVO shall return the manifest and
            related security information (signature and certificate) either in a
            single text file if the signature and certificate are included in the
            manifest file, or in a zip file containing the manifest and the certificate
            file, if this is provided as a separate file in the NSD archive.
            If this parameter is not given, the NFVO shall provide only a copy of the
            manifest file, as onboarded. If the security information is included in the
            onboarded manifest, it shall also be included in the returned copy.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
      responses:
        200:
          description: >
            200 OK
986

987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
            Shall be returned when the content of the manifest file has been read successfully.

            If the "include_signatures" URI query parameter was absent in the request, or if the
            manifest file has all security-related information embedded (i.e. there is no separate
            certificate file), the payload body shall contain a copy of the manifest file of the
            NSD archive, and the "Content-Type" HTTP header shall be set to "text/plain".
            If the "include_signatures" URI query parameter was present in the related request and
            the manifest file does not have all the security-related information embedded (i.e. there
            is a separate certificate file), the "Content-Type" HTTP header shall be set to "application/zip"
            and the payload body shall contain a ZIP archive which includes:
            -	a copy of the manifest file of the NSD archive;
            -	a copy of the related individual certificate file.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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"
        409:
#          description: >
#            409 CONFLICT
#
#            Shall be returned upon the following error: The
#            operation cannot be executed currently, due to a
#            conflict with the state of the resource.
#            Typically, this is due to the fact
#            "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.
1042
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
1043
        500:
1044
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
1045
        503:
1046
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
1047 1048
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
1049 1050 1051 1052

  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
1053
  '/pnf_descriptors':
1054
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
    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

1101 1102 1103 1104 1105 1106 1107
            Shall be returned when a new "Individual PNF descriptor"
            resource and the associated PNF descriptor identifier
            has been created successfully.
            The response body shall contain a representation of the
             created 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 created PNF descriptor resource.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
          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"
1147 1148
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
1149

1150
    get:
1151
      summary: Query information about multiple PNF descriptor resources.
1152
      description: >
1153 1154
        "The GET method queries information about multiple PNF descriptor
        resources."
1155
      parameters:
1156 1157 1158 1159 1160
        - name: filter
          in: query
          required: false
          type: string
          description: >
1161 1162
            Attribute-based filtering expression according to clause 5.2
            of ETSI GS NFV-SOL 013.
1163 1164 1165
            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
1166
            referenced from it shall be supported by the NFVO in the filter expression.
1167 1168 1169 1170 1171
        - name: all_fields
          in: query
          required: false
          type: string
          description: >
1172 1173
            Include all complex attributes in the response. See clause 5.3
            of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
1174 1175 1176 1177 1178
        - name: fields
          in: query
          required: false
          type: string
          description: >
1179 1180 1181
            Complex attributes to be included into the response. See clause 5.3 of
            ETSI GS NFV-SOL 013 for details.
            The NFVO should support this parameter.
1182 1183 1184 1185 1186
        - name: exclude_fields
          in: query
          required: false
          type: string
          description: >
1187 1188 1189
            Complex attributes to be excluded from the response. See clause 5.3
            of ETSI GS NFV-SOL 013 for details.
            The NFVO should support this parameter.
1190 1191 1192 1193 1194
        - name: exclude_default
          in: query
          required: false
          type: string
          description: >
1195 1196 1197 1198 1199
            Indicates to exclude the following complex attributes from the response.
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support
            this parameter.
            The following attributes shall be excluded from the PnfdInfo structure in
            the response body if this parameter is provided, or none of the parameters
1200
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
1201 1202
            -	userDefinedData
            -	onboardingFailureDetails
1203 1204 1205 1206 1207
        - name: nextpage_opaque_marker
          in: query
          type: string
          required: false
          description: >
1208 1209 1210
            Marker to obtain the next page of a paged response. Shall be supported by
            the NFVO if the NFVO supports alternative 2 (paging) according to clause
            5.4.2.1 of ETSI GS NFV SOL 013 for this resource.
1211 1212
      responses:
        200:
1213
          description: >
1214
            200 OK
1215

1216 1217 1218 1219 1220 1221 1222
            Shall be returned when information about zero or more PNF descriptors has
            been queried successfully.
            The response body shall contain in an array the representations of zero or
            more PNF descriptors, as defined in 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.
1223 1224
          headers:
            Content-Type:
1225 1226 1227 1228
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
1229
            WWW-Authenticate:
1230
              type: string
1231 1232
              description: >
                Challenge if the corresponding HTTP request has not provided
1233 1234
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1235 1236
              maximum: 1
              minimum: 0
1237 1238 1239 1240 1241
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1242
              minimum: 1
1243 1244 1245 1246 1247 1248
            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
1249
          schema:
1250 1251
            description: >
              Information about zero or more PNF descriptors.
1252
              The response body shall contain a representation in an array the representations
1253 1254 1255
              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.
1256
            type: array
1257
            items:
1258
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
1259
        400:
1260
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
1261
        401:
1262
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
1263
        403:
1264
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
1265
        404:
1266
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
1267
        405:
1268
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
1269
        406:
1270
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
1271
        500:
1272
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
1273
        503:
1274
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
1275 1276
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
1277

1278 1279 1280
  ###############################################################################
  # Individual PNF Descriptor                                                   #
  ###############################################################################
1281
  '/pnf_descriptors/{pnfdInfoId}':
1282 1283
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
    parameters:
1284
      - name: pnfdInfoId
1285 1286
        description: >
          Identifier of the individual PNF descriptor resource.
1287
        in: path
1288
        required: true
1289
        type: string
1290

1291
    get:
1292
      summary: Read an individual PNFD resource.
1293
      description: >
1294 1295
        The GET method reads information about an individual PNF descriptor.
      parameters:
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
        - name: Accept
          in: header
          required: true
          type: string
          description: >
            Content-Types that are acceptable for the response. This header
            field shall be present if the response is expected to have a non-empty
            message body.
        - name: Authorization
          in: header
          required: false
          type: string
          description: >
            The authorization token for the request. Details are specified
            in clause 4.5.3 of GS NFV-SOL 005.
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1317 1318
      responses:
        200:
1319
          description: >
1320
            200 OK
1321

1322 1323 1324 1325
            Shall be returned when information about the individual PNFD
            descriptor has been read successfully.
            The response body shall contain a representation of the
            individual PNF descriptor, as defined in clause 5.5.2.5.
1326 1327
          headers:
            Content-Type:
1328 1329 1330 1331
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
1332
            WWW-Authenticate:
1333
              type: string
1334 1335
              description: >
                Challenge if the corresponding HTTP request has not provided
1336 1337
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1338 1339
              maximum: 1
              minimum: 0
1340 1341 1342 1343 1344
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1345
              minimum: 1
1346
          schema:
1347
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
1348
        400:
1349
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
1350
        401:
1351
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
1352
        403:
1353
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
1354
        404:
1355
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
1356
        405:
1357
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
1358
        406:
1359
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
1360
        500:
1361
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
1362
        503:
1363
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
1364 1365
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
1366 1367 1368

    patch:
      summary: Modify the user defined data of an individual PNF descriptor resource.
1369
      description: >
1370 1371 1372 1373 1374 1375
        The PATCH method modifies the user defined data of an individual PNF descriptor resource.
      parameters:
        - name: Accept
          in: header
          required: true
          type: string
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
          description: >
            Content-Types that are acceptable for the response. This header
            field shall be present if the response is expected to have a non-empty
            message body.
        - name: Content-Type
          in: header
          required: true
          type: string
          description: >
            The MIME type of the body of the request. This header field
            shall be present if the request has a non-empty message body.
1387
        - name: PnfdInfoModifications
1388 1389 1390
          in: body
          required: true
          schema:
1391
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
1392
            description: >
1393 1394 1395 1396
              Parameters for the modification of an individual
              PNF descriptor resource, as defined in clause 5.5.2.4.
              The Content-Type header shall be set to "application/merge-patch+json"
              according to IETF RFC 7396.
1397 1398
      responses:
        200:
1399
          description: >
1400
            200 OK
1401

1402 1403 1404 1405
            Shall be returned when the operation has been accepted
            and completed successfully.
            The response body shall contain attribute modifications
            for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4).
1406
          schema:
1407
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
1408 1409
          headers:
            Content-Type:
1410
              type: string
1411 1412 1413 1414
              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.
1415
            WWW-Authenticate:
1416
              type: string
1417 1418
              description: >
                Challenge if the corresponding HTTP request has not provided
1419
                authorization, or error details if the corresponding HTTP request
1420 1421
                has provided an invalid authorization token.
              maximum: 1
1422 1423 1424 1425 1426 1427 1428
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1