NSDManagement.yaml

openapi: 3.0.2

info:
  title: SOL005 - NSD Management Interface 
  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
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 005 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf

servers:
  - url: http://127.0.0.1/nsd/v2
  - url: https://127.0.0.1/nsd/v2

paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  /api_versions:
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  ###############################################################################
  # NS Descriptors                                                              #
  ###############################################################################
  /ns_descriptors:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept

    post:
      summary: Create a new NS descriptor resource.
      description: |
        The POST method is used to create a new NS descriptor resource.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreateNsdInfoRequest'
      responses:
        201:
          $ref: '#/components/responses/NSDescriptors.Post.201'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    get:
      summary: Query information about multiple NS descriptor resources.
      description: |
        The GET method queries information about multiple NS descriptor resources.
      parameters:      
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/NSDescriptors.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

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

    get:
      summary: Read information about an individual NS descriptor resource.
      description: |
        The GET method reads information about an individual NS descriptor.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualNSDescriptor.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    patch:
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
      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:
        1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new
        network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as a
        result.
        2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of
        new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change
        as a result.
        3) Modify the user defined data of an individual NS descriptor resource.
      requestBody:
        $ref: '#/components/requestBodies/NsdInfoModifications'
      responses:
        200:
          $ref: '#/components/responses/IndividualNSDescriptor.Patch.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          #  description: |
          #    409 CONFLICT

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

    delete:
      summary: Delete an individual NS descriptor resource.