NSDManagement.yaml 76.1 KB
Newer Older
1
---
2 3
swagger: "2.0"
info:
4 5 6 7 8
  description: "DRAFT - 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\n"
9
  version: "2.4.1"
10 11 12
  title: "DRAFT - SOL005 - NSD Management Interface"
  contact:
    name: "NFV-SOL WG"
13 14
  license:
    name: "ETSI Forge copyright notice"
15
    url: "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
16
consumes:
17
- "application/json"
18
produces:
19
- "application/json"
20
paths:
21 22 23 24 25 26 27
  /ns_descriptors:
    get:
      summary: "Query NSD Info"
      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 of GS NFV-SOL 005 for URI query parameters,\
        \ request and response data structures, and response codes."
28 29 30 31 32 33 34 35 36 37 38 39 40
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "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.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
41 42 43 44 45 46 47
      responses:
        200:
          description: "Information about zero or more NS descriptors.\nThe response\
            \ body shall contain a representation of zero or more NS descriptors,\
            \ as defined in clause 5.5.2.2 of GS NFV-SOL 005."
          schema:
            $ref: "#/definitions/NsdInfo"
48 49 50 51 52 53 54 55 56 57 58
          headers:
            Content-Type:
              type: "string"
              description: "The MIME type of the body of the response.\nThis header\
                \ field shall be present if the\nresponse 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."
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
        400:
          description: "There are two possible scenarios listed below.\n\nError: Invalid\
            \ attribute-based filtering parameters. \n\nThe response body shall contain\
            \ a ProblemDetails structure, in which the \"detail\" attribute should\
            \ convey more information about the error.\n\nError: Invalid attribute\
            \ selector. The response body shall contain a ProblemDetails structure,\
            \ in which the \"detail\" attribute should convey more information about\
            \ the error."
    post:
      summary: "Create NSD Info"
      description: "The POST method is used to create a new NS descriptor resource.\
        \ This method shall follow the provisions specified in the Tables 5.4.2.3.1-1\
        \ and 5.4.2.3.1-2 of GS NFV-SOL 005 for URI query parameters, request and\
        \ response data structures, and response codes."
      consumes: []
      parameters:
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
      - name: "Accept"
        in: "header"
        required: false
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. This header\
          \ field shall be present if the\nresponse is expected to have a non-empty\n\
          message body."
      - name: "Content-Type"
        in: "header"
        required: false
        type: "string"
        description: "The MIME type of the body of the request.\nThis header field\
          \ shall be present if the\nrequest has a non-empty message body."
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: "The authorization token for the request.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005"
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "CreateNsdInfoRequest"
          properties:
            CreateNsdInfoRequest:
              $ref: "#/definitions/CreateNsdInfoRequest"
          description: "The CreateNsdInfoRequest contains parameters for creating\
            \ an NS descriptor resource, as defined in\nclause 5.5.2.4 of GS NFV-SOL\
            \ 005."
      responses:
        201:
          description: "Status 201"
          schema:
            type: "object"
            description: "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.2 of\
              \ GS NFV-SOL 005."
            properties:
              NsdInfo:
                $ref: "#/definitions/NsdInfo"
          headers:
            Location:
              type: "string"
              description: "The HTTP response shall include a \"Location\" HTTP header\
                \ that contains the resource URI of the new NS descriptor resource."
124 125 126 127 128 129 130 131 132 133
            Content-Type:
              type: "string"
              description: "The MIME type of the body of the response.\nThis header\
                \ field shall be present if the\nresponse 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."
134 135 136 137 138 139 140
  /ns_descriptors/{nsdInfoId}:
    get:
      summary: "Query NSD Info"
      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."
141 142 143 144 145 146 147 148 149 150 151 152 153 154
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. This header\
          \ field shall be present \nif 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.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
155 156 157 158 159 160 161
      responses:
        200:
          description: "Information about the individual NS descriptor. The response\
            \ body shall contain a representation of the individual NS descriptor,\
            \ as defined in clause 5.5.2.2 of GS NFV-SOL 005."
          schema:
            $ref: "#/definitions/NsdInfo"
162 163 164 165 166 167 168 169 170 171
          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."
172 173 174 175 176 177 178 179 180
    delete:
      summary: "Delete NSD"
      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. This method shall follow the provisions specified in the Tables\
        \ 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters,\
        \ request and response data structures, and response codes."
181 182 183 184 185 186 187
      parameters:
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: "The authorization token for the request.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
188 189 190 191 192 193 194 195
      responses:
        204:
          description: "The operation has completed successfully. The response body\
            \ shall be empty."
          schema:
            type: "object"
            description: "The operation has completed successfully. The response body\
              \ shall be empty."
196 197 198 199 200 201
          headers:
            WWW-Authenticate:
              type: "string"
              description: "Challenge if the corresponding HTTP request\nhas not provided\
                \ authorization, or error details if the corresponding HTTP request\
                \ has provided an invalid authorization token."
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
        409:
          description: "Status 409"
          schema:
            required:
            - "ProblemDetails"
            type: "object"
            description: "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."
            properties:
              ProblemDetails:
                $ref: "#/definitions/ProblemDetails"
    patch:
      summary: "Update NSD Info"
      description: "The PATCH method modifies the operational state and/or user defined\
        \ data of an individual NS descriptor resource.  This method can be used to:\n\
        1) Enable a previously disabled individual NS descriptor resource, allowing\
        \ again its use for instantiation of new\nnetwork service with this descriptor.\
        \ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change as a\nresult.\n\
        2) Disable a previously enabled individual NS descriptor resource, preventing\
        \ any further use for instantiation of\nnew network service(s) with this descriptor.\
        \ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change\nas a result.\n\
        3) Modify the user defined data of an individual NS descriptor resource.\n\
        This method shall follow the provisions specified in the Tables 5.4.3.3.4-1\
        \ and 5.4.3.3.4-2 for URI query parameters,\nrequest and response data structures,\
        \ and response codes."
      consumes: []
      parameters:
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nThis header field\
          \ shall be present if the\nrequest has a non-empty message body."
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: "The authorization token for the request.\nDetails are specified\
          \ in clause 4.5.3."
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "NsdInfoModifications"
          properties:
            NsdInfoModifications:
              $ref: "#/definitions/NsdInfoModifications"
          description: "The operation was completed successfully. The response body\
            \ shall contain attribute modifications for an 'Individual NS Descriptor'\
            \ resource (see clause 5.5.2.6 of GS NFV SOL-005)."
      responses:
        200:
          description: "Status 200"
          schema:
            $ref: "#/definitions/NsdInfoModifications"
272 273 274 275 276 277 278 279 280 281
          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."
282 283 284 285 286 287 288 289 290 291 292 293 294 295
        409:
          description: "Status 409"
          schema:
            $ref: "#/definitions/ProblemDetails"
        412:
          description: "Status 412"
          schema:
            $ref: "#/definitions/ProblemDetails"
    parameters:
    - name: "nsdInfoId"
      in: "path"
      required: true
      type: "string"
  /ns_descriptors/{nsdInfoId}/nsd_content:
296
    get:
297 298 299 300 301 302 303
      summary: "Get NSD Content"
      description: "The GET method fetches the content of the NSD.\n\nThe 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.\n\n\
        The selection of the format is controlled by the \"Accept\" HTTP header passed\
304 305
        \ in the GET request.\n\nNOTE: The structure of the NSD zip file is outside\
        \ the scope of the present document."
306 307 308 309 310
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
311 312 313 314 315 316 317 318
        description: "String Required\nIf 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.\n\nIf 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.\n\nIf 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."
319 320 321 322 323 324 325 326 327 328
      - name: "Range"
        in: "header"
        required: false
        type: "string"
        description: "The request may contain a \"Range\" HTTP header to obtain single\
          \ range of bytes from the NSD file. This can be used to continue an aborted\
          \ transmission.\n\nIf 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)."
329 330 331 332 333 334
      - 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."
335 336
      responses:
        200:
337 338 339 340 341 342 343 344 345 346 347
          description: "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."
          schema:
            type: "object"
          headers:
            Content-Type:
              type: "string"
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
              description: "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."
            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."
            Content-Range:
              type: "string"
              description: "Signals the byte range that is contained in the response,\
                \ and the total length of the file."
            Accept-Ranges:
              type: "string"
              description: "Used by the server to signal whether or ot it supports\
                \ ranges for certain resources."
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
        206:
          description: "On success, if the NFVO supports range requests, a single\
            \ consecutive byte range from the content of the NSD file is returned.\n\
            \nThe response body shall contain the requested part of the NSD file.\n\
            \nThe \"Content-Range\" HTTP header shall be provided according to IETF\
            \ RFC 7233 [23].\n\nThe \"Content-Type\" HTTP header shall be set as defined\
            \ above for the \"200 OK\" response."
          headers:
            Content-Range:
              type: "string"
            Content-Type:
              type: "string"
        406:
          description: "Status 406"
          schema:
            type: "object"
            description: "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."
        409:
          description: "Status 409"
          schema:
            type: "object"
            description: "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."
        416:
          description: "Status 416"
          schema:
            type: "object"
            description: "The byte range passed in the \"Range\" header did not match\
              \ any available byte range in the NSD file (e.g.\n\"access after end\
              \ of file\"). The response body may contain a ProblemDetails structure."
    put:
      summary: "Upload NSD"
      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\
        \ 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\"\
        \ HTTP header in the PUT request shall be set accordingly based on the format\
        \ 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\
        \ of GS-NFV-SOL 005 for URI query parameters, request and response data structures,\
        \ and response codes."
      consumes: []
      parameters:
      - name: "Content-Type"
        in: "header"
        required: false
        type: "string"
        description: "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, as specified above. The request shall set the \"Content-Type\"\
          \ HTTP header as defined\nabove."
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
      responses:
        202:
          description: "Status 202"
          schema:
            type: "object"
            description: "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. See note."
        204:
          description: "The NSD content was successfully uploaded and validated (synchronous\
            \ mode). The response body shall be empty."
        409:
          description: "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."
          schema:
            $ref: "#/definitions/ProblemDetails"
    parameters:
    - name: "nsdInfoId"
      in: "path"
      required: true
      type: "string"
  /pnf_descriptors:
    get:
      summary: "Query PFND Info"
      description: "The GET method queries information about multiple PNF descriptor\
        \ resources."
      parameters:
      - name: "exclude_default"
        in: "query"
        required: false
        type: "string"
        description: "Indicates to exclude the following \n \ncomplex attributes from\
          \ the response. \nSee clause 4.3.3 for details.\n\nThe NFVO shall support\
          \ this parameter.\n\nThe following attributes shall be excluded from the\
          \ PnfdInfo structure in the response body if this parameter is provided,\
          \ or none of the parameters \"all_fields,\" \"fields\", \"exclude_fields\"\
          , \"exclude_default\" are provided: userDefinedData."
      - name: "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."
477 478 479 480 481 482 483 484 485 486 487 488 489
      - name: "Accept"
        in: "header"
        required: false
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
490 491 492 493 494 495 496 497
      responses:
        200:
          description: "Status 200"
          schema:
            type: "object"
            description: "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."
498 499 500 501 502 503 504 505 506 507
          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\nhas not provided\
                \ authorization, or error details if the corresponding HTTP request\
                \ has provided an invalid authorization token."
508 509 510 511 512
    post:
      summary: "Create PNFD Info"
      description: "The POST method is used to create a new PNF descriptor resource."
      consumes: []
      parameters:
513 514 515 516 517 518 519 520 521 522 523 524 525
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nDetails are specified\
          \ in clause 4.5.3 of GS-NFV-SOL 005."
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          description: "Parameters of creating a PNF descriptor resource, as defined\
            \ in\nclause 5.5.2.6 of GS NFV-SOL 005."
      responses:
        201:
          description: "Status 201"
          schema:
            type: "object"
            description: "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."
543 544 545 546 547 548 549 550 551 552 553
          headers:
            Content-Type:
              type: "string"
              description: "The MIME type of the body of the response.\nThis header\
                \ field shall be present if the\nresponse has a non-empty message\
                \ body."
            WWW-Authenticate:
              type: "string"
              description: "Challenge if the corresponding HTTP request\nhas not provided\
                \ authorization, or error details if the corresponding HTTP request\
                \ has provided an invalid authorization token."
554 555 556 557 558 559 560
  /pnf_descriptors/{pnfdInfoId}:
    get:
      summary: "Query PNFD Info"
      description: "The GET method reads information about an individual PNF descriptor.\
        \ 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\
        \ response data structures, and response codes."
561 562 563 564 565 566 567 568 569 570 571 572 573 574
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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."
575 576 577 578 579
      responses:
        200:
          description: "Information about the individual PNFD descriptor. The response\
            \ body shall contain a representation of the individual PNF descriptor,\
            \ as defined in clause 5.5.2.5 of GS NFV-SOL 005."
580 581 582 583 584 585 586 587 588 589 590
          headers:
            Content-Type:
              type: "string"
              description: "The MIME type of the body of the response.\nThis header\
                \ field shall be present if the\nresponse 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."
591 592 593 594 595 596 597 598 599 600 601 602
    delete:
      summary: "Delete PNFD"
      description: "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. This method shall follow the provisions specified\
        \ in the Tables 5.4.6.3.5-1 and 5.4.6.3.5-2 of GS NFV-SOL 005 for URI query\
        \ parameters, request and response data structures, and response codes."
603 604 605 606 607 608 609
      parameters:
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: "The authorization token for the request. Details are specified\
          \ in clause 4.5.3."
610 611 612 613
      responses:
        204:
          description: "The operation has completed successfully. The response body\
            \ shall be empty."
614 615 616 617 618 619
          headers:
            WWW-Authenticate:
              type: "string"
              description: "Challenge if the corresponding HTTP request\nhas not provided\
                \ authorization, or error details if the corresponding HTTP request\
                \ has provided an invalid authorization token."
620 621 622 623 624 625 626 627
    patch:
      summary: "Update PNFD Info"
      description: "The PATCH method modifies the user defined data of an individual\
        \ PNF descriptor resource. This method shall follow the provisions specified\
        \ in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters, request\
        \ and response data structures, and response codes."
      consumes: []
      parameters:
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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."
647 648 649 650 651 652 653 654 655 656
      - name: "body"
        in: "body"
        required: true
        schema:
          $ref: "#/definitions/PnfdInfoModifications"
      responses:
        200:
          description: "Status 200"
          schema:
            $ref: "#/definitions/PnfdInfoModifications"
657 658 659 660 661 662 663 664 665 666 667
          headers:
            Content-Type:
              type: "string"
              description: "The MIME type of the body of the response.\nThis header\
                \ field shall be present if the\nresponse 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."
668 669 670 671 672 673 674 675 676 677 678 679 680
        412:
          description: "Status 412"
          schema:
            $ref: "#/definitions/ProblemDetails"
    parameters:
    - name: "pnfdInfoId"
      in: "path"
      required: true
      type: "string"
  /pnf_descriptors/{pnfdInfoId}/pnfd_content:
    get:
      summary: "Get PNFD Content"
      description: "The GET method fetches the content of the PNFD."
681 682 683 684 685 686 687 688 689 690 691 692 693 694
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
695 696 697 698 699
      responses:
        200:
          description: "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\"."
700 701 702 703 704 705 706 707 708 709
          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."
            Content-Type:
              type: "string"
              description: "The \"Content-Type\" HTTP header shall be set to \"text/plain\"\
                ."
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
    put:
      summary: "Upload PNFD"
      description: "The PUT method is used to upload the content of a PNFD. This method\
        \ shall follow the provisions specified in the Tables 5.4.7.3.3-1 and 5.4.7.3.3-2\
        \ of GS NFV-SOL 005for URI query parameters, request and response data structures,\
        \ and response codes."
      consumes: []
      parameters:
      - name: "Content-Type"
        in: "header"
        required: false
        type: "string"
        description: "The request shall set the \"Content-Type\" HTTP header to \"\
          text/plain\"."
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          description: "The payload body contains a copy of the file representing\
            \ the PNFD."
      responses:
        204:
          description: "The PNFD content was successfully uploaded and validated.\
            \ The response body shall be empty."
        409:
          description: "Status 409"
          schema:
            $ref: "#/definitions/ProblemDetails"
    parameters:
    - name: "pnfdInfoId"
      in: "path"
      required: true
      type: "string"
  /subscriptions:
    get:
      summary: "Query Subscription Information"
      description: "The GET method queries the list of active subscriptions of the\
        \ functional block that invokes the method. It can be used e.g. for resynchronization\
        \ after error situations. This method shall support the URI query parameters,\
        \ request and response data structures, and response codes, as specified in\
        \ the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS NFV-SOL 005."
752 753 754 755 756 757 758 759 760 761 762 763 764 765
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
766 767 768 769 770 771 772 773 774 775
      responses:
        200:
          description: "Status 200"
          schema:
            type: "array"
            description: "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."
            items:
              $ref: "#/definitions/NsdmSubscription"
776 777 778 779 780 781 782 783 784 785
          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."
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
        303:
          description: "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 response body shall be empty."
          headers:
            Location:
              type: "string"
              description: "The HTTP response shall include a \"Location\" HTTP header\
                \ that contains the resource URI of the existing subscription resource."
    post:
      summary: "Subscribe"
      description: "The POST method creates a new subscription. This method shall\
        \ support the URI query parameters, request and response data structures,\
        \ 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\
        \ callbackUri)."
      consumes: []
      parameters:
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nThis header field\
          \ shall be present if the\nrequest has a non-empty message body."
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: "The authorization token for the request.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
      - name: "body"
        in: "body"
        required: true
        schema:
          $ref: "#/definitions/NsdmSubscriptionRequest"
      responses:
        201:
          description: "Status 201"
          schema:
            $ref: "#/definitions/NsdmSubscription"
          headers:
            Location:
              type: "string"
              description: "The HTTP response shall include a \"Location:\"\nHTTP\
                \ header that points to the created subscription resource."
846 847 848 849 850 851 852 853 854
            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."
855 856 857 858 859 860 861
  /subscriptions/{subscriptionId}:
    get:
      summary: "Query Subscription Information"
      description: "The GET method retrieves information about a subscription by reading\
        \ an individual subscription resource. This method shall support the URI query\
        \ parameters, request and response data structures, and response codes, as\
        \ specified in the Tables 5.4.9.3.2-1 and 5.4.9.3.2-2."
862 863 864 865 866 867 868 869 870 871 872 873 874 875
      parameters:
      - name: "Accept"
        in: "header"
        required: true
        type: "string"
        description: "Content-Types that are acceptable for the\nresponse. 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.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
876 877 878 879 880
      responses:
        200:
          description: "Status 200"
          schema:
            $ref: "#/definitions/NsdmSubscription"
881 882 883 884 885 886 887 888 889 890 891
          headers:
            Content-Type:
              type: "string"
              description: "The MIME type of the body of the response.\nThis header\
                \ field shall be present if the\nresponse has a non-empty message\
                \ body."
            WWW-Authenticate:
              type: "string"
              description: "Challenge if the corresponding HTTP request\nhas not provided\
                \ authorization, or error details if the corresponding HTTP request\
                \ has provided an invalid authorization token."
892 893 894 895 896 897
    delete:
      summary: "Terminate Subscription"
      description: "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 Tables 5.4.9.3.5-1 and\
        \ 5.4.9.3.3-2 of GS NFV-SOL 005."
898 899 900 901 902 903 904
      parameters:
      - name: "Authorization"
        in: "header"
        required: false
        type: "string"
        description: "The authorization token for the request.\nDetails are specified\
          \ in clause 4.5.3 of GS NFV-SOL 005."
905 906 907 908
      responses:
        204:
          description: "The subscription resource was deleted successfully. The response\
            \ body shall be empty."
909 910 911 912 913 914
          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."
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
    parameters:
    - name: "subscriptionId"
      in: "path"
      required: true
      type: "string"
definitions:
  NsdInfoModifications:
    type: "object"
    properties:
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      userDefinedData:
        type: "object"
        description: "Modifications of the \"userDefinedData\" attribute in \"NsdInfo\"\
          \ data type. See note. If present, these modifications shall be applied\
930 931
          \ according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]). NOTE:\
          \ At least one of the attributes - nsdOperationalState and userDefinedData\
932 933 934 935 936 937 938 939 940 941 942 943 944 945
          \ - shall be present."
    description: "This type represents attribute modifications for an individual NS\
      \ descriptor resource based on the \"NsdInfo\" data type. The attributes of\
      \ \"NsdInfo\" that can be modified are included in the \"NsdInfoModifications\"\
      \ data type.\n\nNOTE: At least one of the attributes - nsdOperationalState and\
      \ userDefinedData - shall be present."
  NsdmSubscription:
    type: "object"
    required:
    - "_links"
    - "callbackUri"
    - "id"
    properties:
      id:
946 947
        type: "string"
        description: "Identifier of this subscription resource"
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
      filter:
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
        $ref: "#/definitions/Uri"
      _links:
        type: "object"
        description: "Links to resources related to this resource."
        properties:
          self:
            $ref: "#/definitions/Link"
    description: "This type represents a subscription related to notifications about\
      \ NSD management."
  NsdmSubscriptionRequest:
    type: "object"
    required:
    - "callbackUri"
    properties:
      filter:
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
        type: "string"
        description: "The URI of the endpoint to send the notification to."
      authentication:
        $ref: "#/definitions/SubscriptionAuthentication"
    description: "This type represents a subscription request related to notifications\
      \ about NSD management."
  NsdmNotificationsFilter:
    type: "object"
    properties:
      notificationTypes:
978
        type: "array"
979 980 981
        description: "Match particular notification types. Permitted values: NsdOnBoardingNotification,\
          \ NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification\n\
          PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.\n\
982
          \nThe permitted values of the \"notificationTypes\" \nattribute are spelled\
983 984
          \ exactly as the names of the notification types to facilitate automated\
          \ code generation systems."
985 986 987 988 989 990 991 992 993 994
        items:
          type: "string"
          enum:
          - "NsdOnBoardingNotification"
          - "NsdOnboardingFailureNotification"
          - "NsdChangeNotification"
          - "NsdDeletionNotification"
          - "PnfdOnBoardingNotification"
          - "PnfdOnBoardingFailureNotification"
          - "PnfdDeletionNotification"
995
      nsdInfoId:
996 997 998 999 1000 1001 1002
        type: "array"
        description: "Match the NsdInfo identifier which is allocated by the NFVO.\
          \ Note: The attributes \"nsdId\" and \"nsdInfoId\" are alternatives to reference\
          \ to a particular NSD in a filter. They should not be used both in the same\
          \ filter instance, but one alternative should be chosen."
        items:
          type: "string"
1003
      nsdId:
1004 1005 1006 1007 1008 1009 1010
        type: "array"
        description: "Match the NSD identifier, which is allocated by the NSD designer.\
          \ The attributes \"nsdId\" and \"nsdInfoId\" are alternatives to reference\
          \ to a particular NSD in a filter. They should not be used both in the same\
          \ filter instance, but one alternative should be chosen."
        items:
          type: "string"
1011
      nsdName:
1012
        type: "array"
1013
        description: "Match the name of the onboarded NSD."
1014 1015
        items:
          type: "string"
1016
      nsdVersion:
1017 1018 1019 1020 1021
        type: "array"
        description: "Match the NSD version listed as part of this attribute. The\
          \ NSD version is a string of variable length."
        items:
          type: "string"
1022
      nsdDesigner:
1023
        type: "array"
1024
        description: "Match the NSD designer of the on-boarded NSD."
1025 1026
        items:
          type: "string"
1027
      nsdInvariantId:
1028 1029 1030 1031 1032
        type: "array"
        description: "Match the NSD invariant identifier which is allocated by the\
          \ NSD designer and identifies an NSD in a version independent manner."
        items:
          type: "string"
1033
      vnfPkgIds:
1034 1035 1036 1037
        type: "array"
        description: "Match VNF packages with a package identifier listed in the attribute."
        items:
          type: "string"
1038
      pnfdInfoIds:
1039 1040 1041 1042 1043 1044 1045
        type: "array"
        description: "Match the PnfdInfo identifier for the PNFD\nreferenced by the\
          \ on-boarded NSD. The attributes \"pnfdId\" and \"pnfdInfoId\" are alternatives\
          \ to reference to a particular PNFD in a filter. They should not be used\
          \ both in the same filter instance, but one alternative should be chosen."
        items:
          type: "string"
1046
      nestedNsdInfoIds:
1047 1048 1049 1050 1051
        type: "array"
        description: "Match the NsdInfo identifier for the nested NSD\nreferenced\
          \ by the on-boarded NSD."
        items:
          type: "string"
1052
      nsdOnboardingState:
1053 1054 1055
        type: "array"
        items:
          $ref: "#/definitions/NsdOnboardingStateType"
1056
      nsdOperationalState:
1057 1058 1059
        type: "array"
        items:
          $ref: "#/definitions/NsdOperationalStateType"
1060
      nsdUsageState:
1061 1062 1063
        type: "array"
        items:
          $ref: "#/definitions/NsdUsageStateType"
1064
      pnfdId:
1065 1066 1067 1068 1069 1070 1071
        type: "array"
        description: "Match the PNFD identifier which is copied from the PNFD content.\
          \ The attributes \"pnfdId\" and \"pnfdInfoId\" are alternatives to reference\
          \ to a particular PNFD in a filter. They should not be used both in the\
          \ same filter instance, but one alternative should be chosen."
        items:
          type: "string"
1072
      pnfdName:
1073
        type: "array"
1074
        description: "Match the name of the on-boarded PNFD."
1075 1076
        items:
          type: "string"
1077
      pnfdVersion:
1078 1079 1080 1081 1082
        type: "array"
        description: "Match the PNFD designer of the on-boarded PNFD. The PNFD version\
          \ is a string of variable length."
        items:
          type: "string"
1083
      pnfdProvider:
1084
        type: "array"
1085
        description: "Match the provider of the on-boarded PNFD."
1086 1087
        items:
          type: "string"
1088
      pnfdInvariantId:
1089 1090 1091 1092
        type: "array"
        description: "Match the PNFD in a version independent manner."
        items:
          type: "string"
1093
      pnfdOnboardingState:
1094 1095 1096
        type: "array"
        items:
          $ref: "#/definitions/PnfdOnboardingStateType"
1097
      pnfdUsageState:
1098 1099 1100
        type: "array"
        items:
          $ref: "#/definitions/PnfdUsageStateType"
1101 1102 1103 1104 1105 1106 1107 1108 1109
    description: "This type represents a subscription filter related to notifications\
      \ about NSD management. It shall comply with the\nprovisions defined in Table\
      \ 5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure,\
      \ the following applies: All attributes shall match in order for the filter\
      \ to match (logical \"and\" between different filter attributes). If an attribute\
      \ is an array, the attribute shall match if at least one of the values in the\
      \ array matches (logical \"or\" between the values of one filter attribute)."
  Uri:
    type: "object"
1110
    description: "String formatted according to IETF RFC 3986 [10]."
1111 1112
  Link:
    type: "object"
1113 1114
    description: "This type represents a link to a resource. It shall comply with\
      \ the provisions defined in Table 4.4.1.3-1 of GS NFV-SOL 005."
1115 1116
  SubscriptionAuthentication:
    type: "object"
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 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
    properties:
      authType:
        type: "string"
        description: "Defines the types of Authentication/ Authorization the API consumer\
          \ is willing to accept when receiving a notification.\n\nPermitted values:\n\
          BASIC: In every HTTP request to the notification endpoint, use HTTP Basic\
          \ authentication with the client credentials.\n\nOAUTH2_CLIENT_CREDENTIALS:\
          \ In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer\
          \ token, obtained using the client credentials grant type.\n\nTLS_CERT:\
          \ Every HTTP request to the notification endpoint is sent over a mutually\
          \ authenticated TLS session. i.e. not only server is authenticated, but\
          \ also the client is authenticated during the TLS tunnel setup."
        enum:
        - "BASIC"
        - "OAUTH2_CLIENT_CREDENTIALS"
        - "TLS_CERT"
      paramsBasic:
        type: "object"
        description: "Parameters for authentication/authorization using BASIC. Shall\
          \ be present if authType is \"BASIC\" and the contained information has\
          \ not been provisioned out of band. Shall be absent otherwise."
        properties:
          userName:
            type: "string"
            description: "Username to be used in HTTP Basic authentication. Shall\
              \ be present if it has not been provisioned out of band."
          password:
            type: "string"
            description: "Password to be used in HTTP Basic authentication. Shall\
              \ be present if it has not been provisioned out of band."
      paramsOauth2ClientCredentials:
        type: "object"
        description: "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.\
          \ Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the\
          \ contained information has not been provisioned out of band. Shall be absent\
          \ otherwise."
        properties:
          clientId:
            type: "string"
            description: "Client identifier to be used in the access token request\
              \ of the OAuth 2.0 client credentials grant type. Shall be present if\
              \ it has not been provisioned out of band."
1159 1160 1161 1162 1163
  NsdOperationalStateType:
    type: "string"
    description: "The enumeration NsdOperationalStateType shall comply with the provisions\
      \ defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational\
      \ state of the resource.\n\nENABLED = The operational state of the resource\
1164
      \ is enabled.\nDISABLED = The operational state of the resource is disabled."
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
    enum:
    - "ENABLED"
    - "DISABLED"
  NsdInfo:
    type: "object"
    required:
    - "_links"
    - "id"
    - "nsdOnboardingState"
    - "nsdOperationalState"
    - "nsdUsageState"
    properties:
      id:
1178 1179 1180
        type: "string"
        description: "Identifier of the onboarded individual NS descriptor resource.\
          \ This identifier is allocated by the NFVO."
1181
      nsdId:
1182 1183 1184 1185
        type: "object"
        description: "This identifier, which is allocated by the NSD designer, identifies\
          \ the NSD in a globally unique way. It is copied from the NSD content and\
          \ shall be present after the NSD content is on-boarded."
1186 1187 1188 1189 1190
      nsdName:
        type: "string"
        description: "Name of the onboarded NSD. This information is copied from the\
          \ NSD content and shall be present after the NSD content is on-boarded."
      nsdVersion:
1191 1192 1193 1194
        type: "string"
        description: "Version of the on-boarded NSD. The NSD version is a string of\
          \ variable length.This information is copied from the NSD content and shall\
          \ be present after the NSD content is on-boarded."
1195 1196 1197 1198 1199
      nsdDesigner:
        type: "string"
        description: "Designer of the on-boarded NSD. This information \nis copied\
          \ from the NSD content and shall be present after the NSD content is on-boarded."
      nsdInvariantId:
1200 1201 1202 1203
        type: "string"
        description: "This identifier, which is allocated by the NSD designer, identifies\
          \ an NSD in a version independent manner. This information is copied from\
          \ the NSD content and shall be present after the NSD content is on-boarded."
1204
      vnfPkgIds:
1205 1206 1207 1208 1209
        type: "array"
        description: "Identifies the VNF package for the VNFD referenced by the on-boarded\
          \ NS descriptor resource."
        items:
          type: "string"
1210
      pnfdInfoIds:
1211 1212 1213 1214 1215
        type: "array"
        description: "Identifies the PnfdInfo element for the PNFD referenced by the\
          \ on-boarded NS descriptor resource."
        items:
          type: "string"
1216
      nestedNsdInfoIds:
1217 1218 1219 1220 1221 1222
        type: "array"
        description: "Identifies the NsdInfo element for the nested NSD referenced\
          \ by the on-boarded NS descriptor resource. At least one of the attributes\
          \  vnfPkgId and nestedNsdInfoId shall be present, after the NSD is on-boarded."
        items:
          type: "string"
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
      nsdOnboardingState:
        $ref: "#/definitions/NsdOnboardingStateType"
      onboardingFailureDetails:
        $ref: "#/definitions/ProblemDetails"
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        $ref: "#/definitions/NsdUsageStateType"
      userDefinedData:
        $ref: "#/definitions/KeyValuePairs"
      _links:
        type: "object"
        description: "Links to resources related to this resource."
        properties:
          self:
            $ref: "#/definitions/Link"
          nsd_content:
            $ref: "#/definitions/Link"
1241 1242 1243
    description: "This type represents a response for the query NSD operation. It\
      \ shall comply with the provisions defined in\nTable 5.5.2.2-1 of GS NFV-SOL\
      \ 005."
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
  NsdOnboardingStateType:
    type: "string"
    description: "The enumeration NsdOnboardingStateType shall comply with the provisions\
      \ defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the onboarding\
      \ state of the NSD.\n\nCREATED = The NSD information object is created. UPLOADING\
      \ = The associated NSD content is being uploaded. PROCESSING = The associated\
      \ NSD content is being processed, e.g. validation. ONBOARDED = The associated\
      \ NSD content is on-boarded."
    enum:
    - "CREATED"
    - "UPLOADING"
    - "PROCESSING"
    - "ONBOARDED"
  ProblemDetails:
    type: "object"
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
    required:
    - "detail"
    - "status"
    properties:
      type:
        $ref: "#/definitions/Uri"
      title:
        type: "string"
        description: "A short, human-readable summary of the problem type. It should\
          \ not change from occurrence to occurrence of the problem, except for purposes\
          \ of localization. If type is given and other than \"about:blank\", this\
          \ attribute shall also be provided."
      status:
        type: "integer"
        description: "The HTTP status code for this occurrence of the problem."
      detail:
        type: "string"
        description: "A human-readable explanation specific to this occurrence of\
          \ the problem."
      instance:
        $ref: "#/definitions/Uri"
    description: "The definition of the general \"ProblemDetails\" data structure\
      \ from IETF RFC 7807 [27] is reproduced in\nTable 4.3.5.3-1 of GS NFV-SOL 005.\
      \ Compared to the general framework defined in IETF RFC 7807 [27], the \"status\"\
      \ and \"detail\" attributes are mandated to be included by the present document,\
      \ to ensure that the response contains additional textual information about\
      \ an error. IETF RFC 7807 [27] foresees extensibility of the \"ProblemDetails\"\
      \ type. It is possible that particular APIs in the present document, or particular\
      \ implementations, define extensions to define additional attributes that provide\
      \ more information about the error.\n\nThe description column only provides\
      \ some explanation of the meaning to facilitate understanding of the design.\
      \ For a\nfull description, see IETF RFC 7807 [27]."
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
  NsdUsageStateType:
    type: "string"
    description: "The enumeration NsdUsageStateType shall comply with the provisions\
      \ defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state\
      \ of the resource.\n\nIN_USE = The resource is in use.\nNOT_IN_USE = The resource\
      \ is not-in-use."
    enum:
    - "IN_USE"
    - "NOT_IN_USE"
  KeyValuePairs:
    type: "object"
1302 1303 1304 1305
    description: "This type represents a list of key-value pairs. The order of the\
      \ pairs in the list is not significant. In JSON, a set of keyvalue\npairs is\
      \ represented as an object. It shall comply with the provisions defined in clause\
      \ 4 of IETF RFC 7159 [20]."
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
  CreateNsdInfoRequest:
    type: "object"
    properties:
      userDefinedData:
        $ref: "#/definitions/KeyValuePairs"
    description: "This type creates a completely new NS descriptor resource."
  PnfdInfoModifications:
    type: "object"
    required:
    - "userDefinedData"
    properties:
      userDefinedData:
        $ref: "#/definitions/KeyValuePairs"
    description: "This type represents attribute modifications for an individual PNF\
      \ descriptor resource based on the \"PnfdInfo\" data type. The attributes of\
      \ \"PnfdInfo\" that can be modified are included in the \"PnfdInfoModifications\"\
      \ data type."
  PnfdInfo:
    type: "object"
    required:
    - "_links"
    - "id"
    - "pnfdOnboardingState"
    - "pnfdUsageState"
    properties:
      id:
1332 1333 1334
        type: "string"
        description: "Identifier of the onboarded individual PNF descriptor resource.\
          \ This identifier is allocated by the NFVO."
1335
      pnfdId:
1336 1337 1338 1339
        type: "string"
        description: "This identifier, which is managed by the PNFD\ndesigner, identifies\
          \ the PNFD in a globally unique way. It is copied from the PNFD content\
          \ and shall be present after the PNFD content is on-boarded."
1340 1341 1342 1343 1344
      pnfdName:
        type: "string"
        description: "Name of the onboarded PNFD. This information is copied from\
          \ the PNFD content and shall be present after the PNFD content is on-boarded."
      pnfdVersion:
1345 1346 1347 1348
        type: "string"
        description: "Version of the onboarded PNFD. The PNFD version is a string\
          \ of variable length.This information is copied from the PNFD content and\
          \ shall be present after the PNFD content is on-boarded."
1349 1350 1351 1352 1353
      pnfdProvider:
        type: "string"
        description: "Provider of the onboarded PNFD. This information is copied from\
          \ the PNFD content and shall be present after the PNFD content is onboarded."
      pnfdInvariantId:
1354 1355 1356
        type: "string"
        description: "Identifies a PNFD in a version independent manner. This attribute\
          \ is invariant across versions of PNFD."
1357 1358 1359 1360 1361 1362 1363
      pnfdOnboardingState:
        $ref: "#/definitions/PnfdOnboardingStateType"
      onboardingFailureDetails:
        $ref: "#/definitions/ProblemDetails"
      pnfdUsageState:
        $ref: "#/definitions/PnfdUsageStateType"
      userDefinedData:
1364
        type: "array"
1365 1366
        description: "User defined data for the individual PNF descriptor resource.\
          \ This attribute can be modified with the PATCH method."
1367 1368
        items:
          type: "object"
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
      _links:
        required:
        - "pnfd_content"
        - "self"
        type: "object"
        description: "Links to resources related to this resource."
        properties:
          self:
            $ref: "#/definitions/Link"
          pnfd_content:
            $ref: "#/definitions/Link"
    description: "This type represents a response for the query PNFD operation."
  PnfdOnboardingStateType:
    type: "string"
    description: "The enumeration PnfdOnboardingStateType shall comply with the provisions\
      \ defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the onboarding state\
      \ of the individual PNF descriptor resource.\n\nCREATED = The PNF descriptor\
      \ resource is created. UPLOADING = The associated PNFD content is being uploaded.\
      \ PROCESSING = The associated PNFD content is being processed, e.g. validation.\
      \ ONBOARDED = The associated PNFD content is on-boarded."
    enum:
    - "CREATED"
    - "UPLOADING"
    - "PROCESSING"
    - "ONBOARDING"
  PnfdUsageStateType:
    type: "string"
    description: "The enumeration PnfdUsageStateType shall comply with the provisions\
      \ defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state\
      \ of the resource.\n\nIN-USE = The resource is in use.\nNOT_IN_USE = The resource\
      \ is not-in-use."
    enum:
    - "IN_USE"
    - "NOT_IN_USE"
  CreatePnfdInfoRequest:
    type: "object"
    properties:
      userDefinedData:
        $ref: "#/definitions/KeyValuePairs"
    description: "This type creates a new PNF descriptor resource."
  NsdmLinks:
    type: "object"
    required:
    - "nsdInfo"
    - "subscription"
    properties:
      nsdInfo:
        $ref: "#/definitions/Link"
      subscription:
        $ref: "#/definitions/Link"
    description: "This type represents the links to resources that an NSD management\
      \ notification can contain."
  NsdOnboardingNotification:
    type: "object"
    required:
    - "_links"
    - "id"
    - "notificationType"
    - "nsdId"
    - "nsdInfoId"
1429
    - "subscriptionId"
1430 1431 1432
    - "timeStamp"
    properties:
      id:
1433 1434 1435 1436
        type: "string"
        description: "Identifier of this notification. If a notification is sent multiple\
          \ times due to multiple subscriptions, the \"id\" attribute of all these\
          \ notifications shall have the same value."
1437 1438 1439 1440 1441
      notificationType:
        type: "string"
        description: "Discriminator for the different notification types. Shall be\
          \ set to \"NsdOnboardingNotification\" for this notification type."
      subscriptionId:
1442 1443 1444
        type: "string"
        description: "Identifier of the subscription that this notification relates\
          \ to."
1445 1446 1447 1448 1449
      timeStamp:
        type: "string"
        format: "date-time"
        description: "Date-time of the generation of the notification."
      nsdInfoId:
1450 1451 1452
        type: "string"
        description: "Identifier of the NSD information object. This identifier is\
          \ allocated by the NFVO."
1453
      nsdId:
1454 1455 1456 1457
        type: "string"
        description: "This identifier, which is managed by the service\nprovider,\
          \ identifies the NSD in a globally unique way. It is copied from the on-boarded\
          \ NSD."
1458 1459 1460 1461
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: "This type represents an NSD management notification, which informs\
      \ the receiver of the successful on-boarding of an NSD. It shall comply with\
1462 1463 1464 1465
      \ the provisions defined in Table 5.5.2.9-1 of GS NFV-SOL 005. The support of\
      \ this notification is mandatory. The notification shall be triggered by the\
      \ NFVO when the \"nsdOnboardingState\" attribute of a new NSD has changed to\
      \ \"ONBOARDED\"."
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
  NsdOnboardingFailureNotification:
    type: "object"
    required:
    - "_links"
    - "id"
    - "notificationType"
    - "nsdInfoId"
    - "onboardingFailureDetails"
    - "timeStamp"
    properties:
      id:
1477 1478 1479 1480
        type: "string"
        description: "Identifier of this notification. If a notification is sent multiple\
          \ times due to multiple subscriptions, the \"id\" attribute of all these\
          \ notifications shall have the same value."
1481 1482 1483 1484 1485
      notificationType:
        type: "string"
        description: "Discriminator for the different notification types. Shall be\
          \ set to \"NsdOnboardingFailureNotification\" for this notification type."
      subscriptionId:
1486 1487 1488
        type: "string"
        description: "Identifier of the subscription that this notification relates\
          \ to."
1489 1490 1491 1492 1493
      timeStamp:
        type: "string"
        format: "date-time"
        description: "Date-time of the generation of the notification."
      nsdInfoId:
1494 1495 1496
        type: "string"
        description: "Identifier of the NSD information object. This identifier is\
          \ allocated by the NFVO."
1497
      nsdId:
1498 1499 1500
        type: "string"
        description: "This identifier, which is managed by the service provider, identifies\
          \ the NSD in a globally unique way."
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
      onboardingFailureDetails:
        $ref: "#/definitions/ProblemDetails"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: "This type represents an NSD management notification, which informs\
      \ the receiver of the failure of on-boarding an NSD. It shall comply with the\
      \ provisions defined in Table 5.5.2.10-1. The support of this notification is\
      \ mandatory. The notification shall be triggered by the NFVO when the on-boarding\
      \ of an NSD has failed."
  NsdChangeNotification:
    type: "object"
    required:
    - "_links"
    - "id"
    - "notificationType"
    - "nsdId"
    - "nsdInfoId"
    - "nsdOperationalState"
1519
    - "subscriptionId"
1520 1521 1522
    - "timeStamp"
    properties:
      id:
1523 1524 1525 1526
        type: "string"
        description: "Identifier of this notification. If a notification is sent multiple\
          \ times due to multiple subscriptions, the \"id\" attribute of all these\
          \ notifications shall have the same value."
1527 1528 1529 1530 1531
      notificationType:
        type: "string"
        description: "Discriminator for the different notification types. Shall be\
          \ set to \"NsdChangeNotification\" for this notification type."
      subscriptionId:
1532 1533 1534
        type: "string"
        description: "Identifier of the subscription that this notification relates\
          \ to."
1535 1536 1537 1538 1539
      timeStamp:
        type: "string"
        format: "date-time"
        description: "Date-time of the generation of the notification."
      nsdInfoId:
1540 1541 1542
        type: "string"
        description: "Identifier of the NSD information object. This identifier is\
          \ allocated by the NFVO."
1543
      nsdId:
1544 1545 1546
        type: "string"
        description: "This identifier, which is managed by the service provider, identifies\
          \ the NSD in a globally unique way. It is copied from the on-boarded NSD."
1547 1548 1549 1550 1551 1552 1553 1554
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: "This type represents an NSD management notification, which informs\
      \ the receiver of a change of the \"nsdOperationalState\" attribute of an on-boarded\
      \ NSD. Changes in the value of the \"nsdUsageState\" and \"nsdOnboardingState\"\
      \ attributes are not reported. The notification shall comply with the provisions\
1555 1556 1557 1558
      \ defined in Table 5.5.2.11-1 of GS NFV-SOL 005. The support of this notification\
      \ is mandatory. The notification shall be triggered by the NFVO when the value\
      \ of the \"nsdOperationalState\" attribute has changed, and the \"nsdOperationalState\"\
      \ attribute has the value \"ONBOARDED\"."
1559 1560 1561 1562 1563 1564 1565 1566
  NsdDeletionNotification:
    type: "object"
    required:
    - "_links"
    - "id"
    - "notificationType"
    - "nsdId"
    - "nsdInfoId"
1567
    - "subscriptionId"
1568 1569 1570
    - "timeStamp"
    properties:
      id:
1571 1572 1573 1574
        type: "string"
        description: "Identifier of this notification. If a notification is sent multiple\
          \ times due to multiple subscriptions, the \"id\" attribute of all these\
          \ notifications shall have the same value."
1575 1576 1577 1578 1579
      notificationType:
        type: "string"
        description: "Discriminator for the different notification types. Shall be\
          \ set to \"NsdDeletionNotification \" for this notification type."
      subscriptionId:
1580 1581 1582
        type: "string"
        description: "Identifier of the subscription that this notification relates\
          \ to."
1583 1584 1585 1586 1587
      timeStamp:
        type: "string"
        format: "date-time"
        description: "Date-time of the generation of the notification."
      nsdInfoId:
1588 1589 1590
        type: "string"
        description: "Identifier of the NSD information object. This identifier is\
          \ allocated by the NFVO."
1591
      nsdId:
1592 1593 1594
        type: "string"
        description: "This identifier, which is managed by the service provider, identifies\
          \ the NSD in a globally unique way. It is copied from the on-boarded NSD."
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: "This type represents an NSD management notification, which informs\
      \ the receiver of the deletion of an on-boarded NSD. The notification shall\
      \ comply with the provi