NSDManagement.yaml

swagger: "2.0"

info:
  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"
  version: "2.4.1"
  title: "DRAFT - SOL005 - NSD Management Interface"
  contact:
    name: "NFV-SOL WG"
  license:
    name: "ETSI Forge copyright notice"
    url: "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
externalDocs:
  description: "ETSI GS NFV-SOL 005 V2.4.1"
  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:
  - https
  
consumes:
- "application/json"
produces:
- "application/json"

paths:
###############################################################################
# NS Descriptors                                                              #
###############################################################################
  '/ns_descriptors':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2.3.2
    get:
      summary: "Query information about multiple NS descriptor resources."
      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."
      parameters:
        - 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           
      responses:
        200:
          description: >
            "Information about zero or more NS descriptors.
            The response body shall contain a representation of
            zero or more NS descriptors, as defined in
            clause 5.5.2.2"
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"            
          headers:
            Content-Type:
              type: string            
              description: The MIME type of the body of the response.
            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.            
        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:
          $ref: "responses/SOL005_resp.yaml#/responses/503"    
    post:
      summary: "Create a new NS descriptor resource."
      description: >  
        "The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor
        resource. This method shall follow the provisions specified in the 
        Tables 5.4.2.3.1-1 and 5.4.2.3.1-2 for URI query parameters,
        request and response data structures, and response codes."
      parameters:
      - name: "createNsdInfoRequest"
        description: >
          "The CreateNsdInfoRequest contains parameters for creating
          an NS descriptor resource, as defined in clause 5.5.2.4 of GS NFV-SOL 005."
        in: "body"
        required: true
        schema:
          $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"            
      - 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:
        201:
          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.2.
            The HTTP response shall include a "Location"
            HTTP header that contains the resource URI of the
            new NS descriptor resource.
        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"