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

3
info:
4
  version: "1.0.0"
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 14
  license:
    name: "ETSI Forge copyright notice"
15 16 17
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact: 
    name: "NFV-SOL WG"
18
externalDocs:
19
  description: ETSI GS NFV-SOL 005 V2.4.1
20 21 22
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nsd/v1"
schemes:
23
  - https  
24
consumes:
25
- "application/json"
26
produces:
27
- "application/json"
28
paths:
29 30 31 32
###############################################################################
# NS Descriptors                                                              #
###############################################################################
  '/ns_descriptors':
33
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
34
    get:
35
      summary: Query information about multiple NS descriptor resources.
36 37 38 39 40
      description: > 
        "The GET method queries information about multiple NS descriptor resources.
        This method shall follow the provisions specified in the 
        Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters,
        request and response data structures, and response codes."
41
      parameters:
42 43 44 45 46 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 93 94 95 96 97
        - name: "filter"
          in: "query"
          required: false
          type: "string"
          description: >  
            "Attribute-based filtering parameters according to clause 4.3.2.
            The NFVO shall support receiving filtering parameters as part of the URI query
            string. The OSS/BSS may supply filtering parameters.
            All attribute names that appear in the NsdInfo and in data types referenced from
            it shall be supported in attribute-based filtering parameters."
        - name: "all_fields"
          in: "query"
          required: false
          type: "string"
          description: >  
            "Include all complex attributes in the response. See clause 4.3.3 for details.
             The NFVO shall support this parameter."
        - name: "fields"
          in: "query"
          required: false
          type: "string"
          description: >  
            "Complex attributes to be included into the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."          
        - name: "exclude_fields"
          in: "query"
          required: false
          type: "string"
          description: >  
            "Complex attributes to be excluded from the response. See clause 4.3.3 for
            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
            clause 4.3.3 for details. 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."
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string           
98 99
      responses:
        200:
100
          description: >
101
            200 OK
102 103
            
            Information about zero or more NS descriptors.
104 105
            The response body shall contain a representation of
            zero or more NS descriptors, as defined in
106
            clause 5.5.2.2
107 108
          headers:
            Content-Type:
109
              description: The MIME type of the body of the response.
110 111 112
              type: string
              maximum: 1
              minimum: 1
113
            WWW-Authenticate:
114
              type: "string"
115 116
              description: >
                Challenge if the corresponding HTTP request has not provided
117 118 119 120
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0              
121 122 123 124 125 126
          schema:
            type: array
            items:
              properties:
                NsdInfo:
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"                   
127
        400:
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
          $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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"           
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"    
149
    post:
150
      summary: Create a new NS descriptor resource.
151
      description: >  
152 153
        The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor.
      parameters:    
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Content-Type
        description: >
          The MIME type of the body of the request.
          Reference: IETF RFC 7231
        in: header
        required: true
174 175 176 177 178 179 180 181 182 183 184 185
        type: string
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "CreateNsdInfoRequest"
          properties:
            CreateNsdInfoRequest:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
          description: >
186
            Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3
187 188
      responses:
        201:
189 190 191 192 193 194 195 196 197
          description: >
            Status 201
            
            An NS descriptor resource was created successfully, as a new NS descriptor resource. 
            The response body shall contain a representation
            of the new NS descriptor resource, as defined in clause 5.5.2.3 of GS NFV-SOL 005.
            The HTTP response shall include a "Location"
            HTTP header that contains the resource URI of the
            new NS descriptor resource.            
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
          schema:
            type: "object"
            properties:
              NsdInfo:
                $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
215 216 217
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0                
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"          
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
239 240
          $ref: "responses/SOL005_resp.yaml#/responses/503"  
          
241 242 243 244
###############################################################################
# Individual NS Descriptor                                                    #
###############################################################################                
  '/ns_descriptors/{nsdInfoId}':
245 246 247 248 249 250 251 252
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
      - name: "nsdInfoId"
        description: >
          Identifier of the individual NS descriptor resource.
        in: "path"
        required: true
        type: "string"    
253
    get:
254
      summary: Read information about an individual NS descriptor resource.
255 256 257 258 259
      description: >  
        "The GET method reads information about an individual NS descriptor.
        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,
        request and response data structures, and response codes."
260
      parameters:
261 262 263 264 265 266 267 268 269 270 271 272 273 274
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string      
275 276
      responses:
        200:
277 278 279 280 281 282
          description: >
            200 OK
            
            Information about the individual NS descriptor.
            The response body shall contain a representation of
            the individual NS descriptor.            
283
          schema:
284
            type: "object"            
285 286 287
            properties:
              NsdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
288
          headers:
289 290 291 292 293
            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.
294
            WWW-Authenticate:
295
              type: "string"
296 297
              description: >
                Challenge if the corresponding HTTP request has not provided
298 299
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
300 301
              maximum: 1
              minimum: 0
302 303 304 305 306 307 308 309 310 311 312 313
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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"
314
        409:
315 316
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
317
          $ref: "responses/SOL005_resp.yaml#/responses/412"        
318 319 320 321 322
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
323
          $ref: "responses/SOL005_resp.yaml#/responses/503"
324
    patch:
325
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
326
      description: >  
327
        The PATCH method modifies the operational state and/or user defined
328 329 330 331 332 333 334 335
        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.
336
      parameters:
337
      - name: "body"
338 339 340 341 342 343 344 345
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "NsdInfoModifications"
          properties:
            NsdInfoModifications:
346 347
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
          description: >  
348
            Parameters for the modification of an individual NS descriptor resource.
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        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                    
      responses:      
364
        200:
365
          description: >
366 367
            200 OK
            
368 369 370 371
            The operation was completed successfully.
            The response body shall contain attribute
            modifications for an 'Individual NS Descriptor'
            resource.
372 373
          headers:
            Content-Type:
374 375 376 377
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
378
            WWW-Authenticate:
379
              type: "string"
380 381
              description: >
                Challenge if the corresponding HTTP request has not provided
382 383
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
384 385
              maximum: 1
              minimum: 0
386
          schema:
387 388
            type: array
            items:
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
              properties:
                NsdInfoModifications:            
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
          
    delete:
416
      summary: Delete an individual NS descriptor resource.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
      description: >  
        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.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string          
      responses:
        204:
          description: >  
            204 No Content
            
            The operation has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
439
              type: "string"
440 441
              description: >
                Challenge if the corresponding HTTP request has not provided
442 443
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
444 445
              maximum: 1
              minimum: 0
446 447 448 449 450 451 452 453 454 455 456 457 458 459
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
460
        412:
461 462 463 464 465 466 467 468
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"  
          
469
      
470 471 472 473
###############################################################################
# NSD Content                                                                 #
###############################################################################         
  '/ns_descriptors/{nsdInfoId}/nsd_content':
474 475 476 477 478 479
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
      - name: "nsdInfoId"
        in: "path"
        required: true
        type: "string"    
480
    get:
481
      summary: Fetch the content of a NSD.
482
      description: >  
483 484 485
        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
486 487 488 489 490 491 492 493 494 495 496
        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
497
        of the NSD zip file is outside the scope of the present document.
498
      parameters:
499 500 501 502
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
        in: header
503
        required: true
504 505 506 507 508 509 510 511 512
        type: string
        enum: 
          - text/plain
          - application/zip
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
513
        required: false
514 515
        type: string
      - name: "Range"
516 517 518
        in: "header"
        required: false
        type: "string"
519 520 521 522 523 524 525
        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)."
526 527
      responses:
        200:
528
          description: >  
529 530
            200 OK
            
531 532 533 534 535 536 537 538 539
            On success, the content of the NSD is returned.
            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.
540 541
          headers:
            Content-Type:
542 543 544 545
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
546
            WWW-Authenticate:
547
              type: "string"
548 549
              description: >
                Challenge if the corresponding HTTP request has not provided
550 551
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
552 553
              maximum: 1
              minimum: 0
554
        206:
555 556 557 558 559 560 561 562 563 564 565
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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"
566
        406:
567
          $ref: "responses/SOL005_resp.yaml#/responses/406"
568
        409:
569
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED"
570 571
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
572
        416:
573 574 575 576 577 578
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"           
              
579
    put:
580
      summary: Upload the content of a NSD.
581 582 583
      description: >  
        "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
584 585 586 587 588
        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"
589
        HTTP header in the PUT request shall be set accordingly based on the format
590 591 592 593 594 595
        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
596 597
        of GS-NFV-SOL 005 for URI query parameters, request and response data structures,
        and response codes."
598
      parameters:
599 600 601
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
602 603
          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.
604
        in: header
605
        required: true
606 607 608 609 610 611 612 613 614 615 616
        type: string
        enum: 
          - text/plain
          - application/zip
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
617 618
      responses:
        202:
619
          description: >  
620
            202 Accepted
621 622 623 624 625 626
            
            The NSD content was accepted for uploading, but the
            processing has not been completed. It is expected to
            take some time for processing (asynchronous mode).
            
            The response body shall be empty. 
627 628 629 630 631 632 633
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
634
              type: "string"
635 636
              description: >
                Challenge if the corresponding HTTP request has not provided
637 638
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
639 640
              maximum: 1
              minimum: 0
641
        204:
642
          description: >  
643 644 645 646
            204 No Content
            
            The NSD content was successfully uploaded and validated (synchronous mode). 
            The response body shall be empty.
647 648 649 650 651 652 653 654 655 656 657 658 659 660
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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"
661
        409:
662
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED"
663 664 665 666 667 668 669 670 671
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
          
672
     
673 674 675 676
###############################################################################
# PNF Descriptors                                                             #
###############################################################################      
  '/pnf_descriptors':
677
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
678
    get:
679
      summary: Query information about multiple PNF descriptor resources.
680 681 682
      description: >  
        "The GET method queries information about multiple PNF descriptor
        resources."
683
      parameters:
684
      - name: "filter"
685 686 687
        in: "query"
        required: false
        type: "string"
688 689 690 691 692 693
        description: >  
          Attribute-based filtering parameters according to clause 4.3.2.
          The NFVO shall support receiving filtering parameters as part of the URI
          query string. The OSS/BSS may supply filtering parameters.
          All attribute names that appear in the PnfdInfo and in data types referenced
          from it shall be supported in attribute-based filtering parameters.
694 695 696 697
      - name: "all_fields"
        in: "query"
        required: false
        type: "string"
698 699 700 701 702
        description: >  
          Include all complex attributes in the response. See clause 4.3.3 for details.
          The NFVO shall support this parameter.    
      - name: "fields"
        in: "query"
703 704
        required: false
        type: "string"
705 706 707 708 709 710 711 712 713 714 715 716
        description: >  
          Complex attributes to be included into the response. See clause 4.3.3 for
          details. The NFVO should support this parameter.          
      - name: "exclude_fields"
        in: "query"
        required: false
        type: "string"
        description: >  
          Complex attributes to be excluded from the response. See clause 4.3.3 for
          details. The NFVO should support this parameter.
      - name: "exclude_default"
        in: "query"
717 718
        required: false
        type: "string"
719 720 721 722 723 724 725
        description: >  
          Indicates to exclude the following complex attributes from the response. See
          clause 4.3.3 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
          "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
          userDefinedData.
726 727
      responses:
        200:
728 729 730 731 732 733 734
          description: >  
            200 OK
            
            Information about zero or more PNF descriptors.
            The response body shall contain a representation of
            zero or more PNF descriptors, as defined in
            clause 5.5.2.2
735 736
          headers:
            Content-Type:
737 738 739 740
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
741
            WWW-Authenticate:
742
              type: "string"
743 744
              description: >
                Challenge if the corresponding HTTP request has not provided
745 746
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
747 748 749
              maximum: 1
              minimum: 0
          schema:
750
            type: "array"
751
            items:
752 753 754
              properties:
                PnfdInfo:
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"                
777
    post:
778
      summary: Create a new PNF descriptor resource.
779
      description: >  
780
        The POST method is used to create a new PNF descriptor resource
781
      parameters:
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        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
803 804 805 806 807 808 809 810 811 812 813 814 815
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "CreatePnfdInfoRequest"
          properties:
            CreatePnfdInfoRequest:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
          description: >
            Parameters of creating a PNF descriptor resource.        
      responses:    
816
        201:
817 818 819 820 821 822 823 824 825 826
          description: >
            201 Created
            
            A PNF descriptor resource was created successfully, as a new PNF descriptor resource.
            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.            
827 828 829 830 831
          schema:
            type: "object"
            properties:
              PnfdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
832 833
          headers:
            Content-Type:
834 835 836 837 838
              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.
839
            WWW-Authenticate:
840
              type: "string"
841 842
              description: >
                Challenge if the corresponding HTTP request has not provided
843
                authorization, or error details if the corresponding HTTP request
844 845 846
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0            
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
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"               
###############################################################################
# Individual PNF Descriptor                                                   #
###############################################################################               
  '/pnf_descriptors/{pnfdInfoId}':
875 876 877 878 879 880 881 882
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
    parameters:
      - name: "pnfdInfoId"
        description: >
          Identifier of the individual PNF descriptor resource.
        in: "path"
        required: true
        type: "string"    
883
    get:
884
      summary: Read an individual PNFD resource.
885
      description: >  
886
        The GET method reads information about an individual PNF descriptor.
887 888
        This method shall follow the provisions specified in the Tables 5.4.6.3.2-1
        and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
        response data structures, and response codes.
      parameters:
      - 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.       
906 907
      responses:
        200:
908
          description: >  
909
            200 OK
910
            
911
            Information about the individual PNFD descriptor.
912
            The response body shall contain a representation of
913
            the individual PNF descriptor.
914 915
          headers:
            Content-Type:
916 917 918 919
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
920
            WWW-Authenticate:
921
              type: "string"
922 923
              description: >
                Challenge if the corresponding HTTP request has not provided
924 925
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
926 927 928
              maximum: 1
              minimum: 0
          schema:
929 930 931 932
            type: "object"
            properties:
              PnfdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"            
955
    delete:
956
      summary: Delete an individual PNF descriptor resource.
957
      description: >  
958 959 960 961 962 963
        The DELETE method deletes an individual PNF descriptor resource.
        An individual PNF descriptor resource can only be deleted when there is no NS instance using it or there is NSD
        referencing it.
        To delete all PNFD versions identified by a particular value of the "pnfdInvariantId" attribute, the procedure is to first
        use the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find all versions of the
        PNFD. Then, the client uses the DELETE method described in this clause to delete each PNFD version individually.
964 965
      responses:
        204:
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
          description: >  
            204 No Content
            
            The operation has completed successfully.
            The response body shall be empty.                   
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
995
    patch:
996
      summary: Modify the user defined data of an individual PNF descriptor resource.
997
      description: >  
998
        The PATCH method modifies the user defined data of an individual PNF descriptor resource.
999
      parameters:      
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
      - 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: "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.
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: >
          The authorization token for the request. Details are specified in clause 4.5.3.
1021 1022 1023 1024
      - name: "body"
        in: "body"
        required: true
        schema:
1025 1026 1027 1028 1029 1030 1031
          type: "object"
          required:
          - "PnfdInfoModifications"
          properties:
            PnfdInfoModifications:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
          description: >
1032
            Parameters for the modification of an individual PNF descriptor resource, as defined in clause 5.5.2.4.           
1033 1034
      responses:
        200:
1035
          description: >
1036 1037 1038 1039 1040
            200 OK
            
            The operation was completed successfully.
            The response body shall contain attribute
            modifications for an 'Individual PNF Descriptor' resource.            
1041 1042 1043 1044 1045
          schema:
            type: "object"
            properties:
              PnfdInfoModifications:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"                
1046 1047
          headers:
            Content-Type:
1048 1049 1050 1051 1052
              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.
1053
            WWW-Authenticate:
1054
              type: "string"
1055 1056
              description: >
                Challenge if the corresponding HTTP request has not provided
1057
                authorization, or error details if the corresponding HTTP request
1058 1059 1060
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0            
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
1077
        412:
1078 1079 1080 1081 1082 1083
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1084 1085
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
            
1086

1087 1088 1089 1090
###############################################################################
# PNFD Content                                                                #
###############################################################################       
  '/pnf_descriptors/{pnfdInfoId}/pnfd_content':
1091 1092 1093 1094 1095 1096 1097 1098
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
    parameters:
      - name: "pnfdInfoId"
        description: >
          Identifier of the individual PNF descriptor.
        in: "path"
        required: true
        type: "string"    
1099
    get:
1100
      summary: Fetch the content of a PNFD.
1101
      description: >  
1102
        The GET method fetches the content of the PNFD.
1103 1104 1105
        This method shall follow the provisions specified in the 
        Table 5.4.7.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
1106
      parameters:
1107 1108 1109 1110
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
        in: header
1111
        required: true
1112 1113 1114 1115 1116 1117 1118 1119
        type: string
        enum: 
          - text/plain
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
1120
        required: false
1121
        type: string        
1122 1123
      responses:
        200:
1124
          description: >  
1125
            200 OK
1126 1127 1128 1129
            
            On success, the content of the PNFD is returned. The payload
            body shall contain a copy of the file representing the PNFD. 
            The Content-Type" HTTP header shall be set to "text/plain".
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
          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           
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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:
1159
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-ONBOARDED" 
1160 1161 1162 1163 1164 1165 1166 1167
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"            
1168
    put:
1169
      summary: Upload the content of a PNFD.
1170
      description: >  
1171 1172 1173
        The PUT method is used to upload the content of a PNFD.
        This resource represents the content of the individual PNF descriptor, i.e. PNFD content. 
        The client can use this resource to upload and download the content of the PNFD.        
1174
      parameters:
1175 1176 1177 1178
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
        in: header
1179
        required: true
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
        type: string
        enum: 
          - text/plain
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1190 1191
      responses:
        204:
1192
          description: >  
1193
            204 No Content
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
            
            The PNFD content was successfully uploaded and validated. 
            The response body shall be empty.
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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"
1211
        409:
1212
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-CREATED"
1213 1214 1215 1216 1217 1218 1219 1220
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1221

1222 1223 1224 1225
###############################################################################
# Subscriptions                                                               #
###############################################################################       
  '/subscriptions':
1226
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
1227
    get:
1228
      summary: Query multiple subscriptions.
1229
      description: >  
1230
        The GET method queries the list of active subscriptions of the
1231 1232
        functional block that invokes the method. It can be used e.g. for resynchronization
        after error situations. This method shall support the URI query parameters,
1233 1234 1235 1236 1237
        request and response data structures, and response codes.
        
        This resource represents subscriptions. 
        The client can use this resource to subscribe to notifications related to NSD
        management and to query its subscriptions.
1238
      parameters:
1239 1240 1241 1242 1243
        - name: "filter"
          in: "query"
          required: false
          type: "string"
          description: >  
1244 1245 1246 1247 1248
            Attribute filtering parameters according to clause 4.3.2.
            The NFVO shall support receiving attribute filter parameters as part of the URI query
            string. The OSS/BSS may supply an attribute filter.
            All attribute names that appear in the NsdmSubscription and in data types referenced
            from it shall be supported in attribute filter parameters.
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string            
1263 1264
      responses:
        200:
1265 1266 1267
          description: >  
            200 OK
            
1268 1269 1270 1271
            The list of subscriptions was queried successfully.
            The response body shall contain the representations of
            all active subscriptions of the functional block that
            invokes the method.
1272 1273
          headers:
            Content-Type:
1274 1275 1276 1277
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
1278
            WWW-Authenticate:
1279
              type: "string"
1280 1281
              description: >
                Challenge if the corresponding HTTP request has not provided
1282 1283
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1284
              maximum: 1
1285
              minimum: 0
1286 1287
          schema:
            type: "array"
1288 1289 1290 1291
            items:              
              properties:
                NsdmSubscription:
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"   
1292
        303:
1293
          description: >  
1294
            303 See Other.
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
            A subscription with the same callbackURI and the
            same filter already exits and the policy of the NFVO is
            to not create redundant subscriptions.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the existing
            subscription resource.
            The response body shall be empty.
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
1327
    post:
1328
      summary: Subscribe to NSD and PNFD change notifications.
1329
      description: >  
1330 1331
        The POST method creates a new subscription. 
        This method shall support the URI query parameters, request and response data structures,
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
        and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2
        of GS-NFV SOL 005. Creation of two subscription resources with the same
        callbackURI and the same filter can result in performance degradation and
        will provide duplicates of notifications to the OSS, and might make sense
        only in very rare use cases. Consequently, the NFVO may either allow creating
        a subscription resource if another subscription resource with the same filter
        and callbackUri already exists (in which case it shall return the "201
        Created" response code), or may decide to not create a duplicate subscription
        resource (in which case it shall return a "303 See Other" response code
        referencing the existing subscription resource with the same filter and
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
        callbackUri).
        
        This resource represents subscriptions. 
        The client can use this resource to subscribe to notifications related to NSD
        management and to query its subscriptions.        
      parameters:          
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
          Reference: IETF RFC 7231
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        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
1369 1370 1371 1372
      - name: "body"
        in: "body"
        required: true
        schema:
1373 1374 1375 1376 1377 1378 1379
          type: "object"
          required:
          - "NsdmSubscriptionRequest"
          properties:
            NsdmSubscriptionRequest:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
          description: >
1380
            Details of the subscription to be created, as defined in clause 5.5.2.7.
1381 1382
      responses:
        201:
1383
          description: >
1384
            201 Created
1385 1386 1387 1388 1389
            
            The subscription was created successfully.
            The response body shall contain a representation of the created subscription resource.
            The HTTP response shall include a "Location:"
            HTTP header that points to the created subscription resource.            
1390
          schema:
1391 1392 1393 1394
            type: "object"
            properties:
              NsdmSubscription:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
1395
          headers:
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
            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.
1408 1409
              maximum: 1
              minimum: 0
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"                 
1434
               
1435 1436 1437 1438
###############################################################################
# Individual Subscription                                                     #
###############################################################################                 
  '/subscriptions/{subscriptionId}':
1439 1440 1441 1442 1443 1444 1445
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9    
    parameters:
      - name: "subscriptionId"
        description: Identifier of this subscription.
        in: "path"
        required: true
        type: "string"    
1446
    get:
1447 1448 1449 1450 1451 1452
      summary: Read an individual subscription resource.
      description: >
        This resource represents an individual subscription. 
        It can be used by the client to read and to terminate a subscription to
        notifications related to NSD management.
        
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
        The GET method retrieves information about a subscription by reading
        an individual subscription resource. 
        This resource represents an individual subscription. 
        It can be used by the client to read and to terminate a subscription to
        notifications related to NSD management.
      parameters:
      - 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.
          
1475 1476
      responses:
        200:
1477
          description: >
1478 1479 1480 1481 1482
            200 OK

            The operation has completed successfully.
            The response body shall contain a representation of
            the subscription resource.            
1483
          schema:
1484 1485 1486 1487
            type: "object"
            properties:
              NsdmSubscription:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"            
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
          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
1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"              
1524
    delete:
1525 1526
      summary: Terminate Subscription
      description: >
1527 1528
        This resource represents an individual subscription. 
        It can be used by the client to read and to terminate a subscription to
1529 1530 1531 1532 1533 1534
        notifications related to NSD management.
        
        The DELETE method terminates an individual subscription.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.9.3.3-2.      
1535 1536 1537 1538 1539 1540 1541 1542
      parameters:
      - 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.
1543 1544
      responses:
        204:
1545
          description: >
1546 1547
            204 No Content
            
1548 1549
            The subscription resource was deleted successfully.
            The response body shall be empty.
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"            
1572
      
1573 1574 1575 1576 1577 1578 1579
##################################################################################
# Notification endpoint                                                          #
# Dummy URI is used for testing.                                                 #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10  
1580
    post:
1581
      summary: Notify about NSD and PNFD changes
1582
      description: >
1583 1584
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
1585 1586
        client, which has provided the URI of this resource during the subscription process.
        
1587 1588 1589 1590
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
1591 1592 1593 1594 1595 1596 1597 1598 1599
      parameters:
        - name: NsdOnBoardingNotification
          description: >
            A notification about the successful on-boarding of an NSD.
          in: body
          required: true
          schema:
            properties:
              NsdOnBoardingNotification:
1600
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingNotification"          
1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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          
      responses:
        204:
          description: >
1625 1626
            204 No Content
            
1627 1628 1629
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
1630
              type: "string"
1631 1632
              description: >
                Challenge if the corresponding HTTP request has not provided
1633 1634
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
              maximum: 1
              minimum: 0        
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1656 1657 1658 1659 1660 1661
          $ref: "responses/SOL005_resp.yaml#/responses/503"  
          
  '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingFailureNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10           
    post:
      summary: Notify about NSD and PNFD changes
1662
      description: >
1663 1664 1665 1666 1667 1668 1669 1670
        This resource represents a notification endpoint. The server can use 
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.
        
        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
1671
      parameters:
1672 1673 1674 1675 1676 1677 1678 1679 1680
        - name: NsdOnBoardingFailureNotification
          description: >
            A notification about the failure of on-boarding an NSD.
          in: body
          required: true
          schema:
            properties:
              NsdOnBoardingFailureNotification:          
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingFailureNotification"         
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1695 1696 1697 1698 1699 1700 1701
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string          
1702 1703 1704
      responses:
        204:
          description: >
1705 1706 1707
            204 No Content
            
            The notification was delivered successfully.
1708 1709
          headers:
            WWW-Authenticate:
1710
              type: "string"
1711 1712
              description: >
                Challenge if the corresponding HTTP request has not provided
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900