openapi: 3.0.2

info:
  title: SOL005 - NS Performance Management Interface 
  description: |
    SOL005 - NS Performance Management Interface

    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues

  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 005 V3.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.06.01_60/gs_nfv-sol005v030601p.pdf

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

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

  ###############################################################################
  # PM Jobs                                                                     #
  ###############################################################################
  /pm_jobs:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.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
      - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType

    post:
      description: |
        The POST method creates a PM job. See clause 7.4.2.3.1.
      requestBody:
        $ref: '#/components/requestBodies/CreatePmJobRequest'
      responses:
        201:
          $ref: '#/components/responses/PmJobs.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"
        422:
          $ref: '#/components/responses/PmJobs.Post.422'
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"

    get:
      description: |
        The API consumer can use this method to retrieve information about PM jobs. See clause 7.4.2.3.2.
      parameters:
        - in: query
          name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the PmJob and in data types referenced from it shall 
            be supported by the NFVO in the filter expression.
          schema:
            type: string
        - $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
        - in: query
          name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response. See clause 5.3 of 
            ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the PmJob structure in the response body if 
            this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", 
            "exclude_default" are provided:
            -	Reports
          schema:
            type: string
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/PmJobs.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"

  ###############################################################################
  # Individual PM job                                                           #
  ###############################################################################
  /pm_jobs/{pmJobId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.3
    parameters:
      - $ref: '#/components/parameters/PmJobId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      description: |
        The API consumer can use this method for reading an individual PM job. See clause 7.4.3.3.2.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualPmJob.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"

    patch:
      description: |
        This method allows to modify an "individual PM job" resource. See clause 7.4.3.3.4.
      parameters:
        - $ref: '#/components/parameters/ContentTypeMergePatchJSON'
      requestBody:
        $ref: '#/components/requestBodies/PmJobModifications'
      responses:
        200:
          $ref: '#/components/responses/IndividualPmJob.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"
        412:
          $ref: '#/components/responses/IndividualPmJob.Patch.412'
        422:
          $ref: '#/components/responses/IndividualPmJob.Patch.422'
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"

    delete:
      description: |
        This method terminates an individual PM job. See clause 7.4.3.3.5.
      responses:
        204:
          $ref: '#/components/responses/IndividualPmJob.Delete.204'
        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"

  ###############################################################################
  # Individual performance report                                               #
  ###############################################################################
  /pm_jobs/{pmJobId}/reports/{reportId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.4
    parameters:
      - $ref: '#/components/parameters/PmJobId'
      - $ref: '#/components/parameters/ReportId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      description: |
        The API consumer can use this method for reading an individual performance
        report. See clause 7.4.4.3.2.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualPerformanceReport.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"

  ###############################################################################
  # Thresholds                                                                  #
  ###############################################################################
  /thresholds:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5
    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:
      description: |
        The POST method can be used by the API consumer to create
        a threshold. See clause 7.4.5.3.1.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreateThresholdRequest'
      responses:
        201:
          $ref: '#/components/responses/Thresholds.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"
        422:
          $ref: '#/components/responses/Thresholds.Post.422'
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"

    get:
      description: |
        The API consumer can use this method to query information about thresholds. See clause 7.4.5.3.2.
      parameters:
        - in: query
          name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the Thresholds data type and in data types referenced 
            from it shall be supported by the NFVO in the filter expression.
          schema:
            type: string
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/Thresholds.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"

  ###############################################################################
  # Individual threshold                                                        #
  ###############################################################################
  /thresholds/{thresholdId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.6
    parameters:
      - $ref: '#/components/parameters/ThresholdId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      description: |
        The API consumer can use this method for reading an individual
        threshold. See clause 7.4.6.3.2.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualThreshold.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"

    patch:

      description: |
        This method allows to modify an "Individual threshold" resource. See clause 7.4.6.3.4.
      parameters:
        - $ref: '#/components/parameters/ContentTypeMergePatchJSON'
      requestBody:
        $ref: '#/components/requestBodies/ThresholdModifications'
      responses:
        200:
          $ref: '#/components/responses/IndividualThreshold.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"
        412:
          $ref: '#/components/responses/IndividualThreshold.Patch.412'
        422:
          $ref: '#/components/responses/IndividualThreshold.Patch.422'
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"

    delete:
      description: |
        This method allows to delete a threshold. See clause 7.4.6.3.5.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        204:
          $ref: '#/components/responses/IndividualThreshold.Delete.204'
        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"

  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
#  '/subscriptions':
#    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.7
#    parameters:
#      - name: Authorization
#        description: |
#          The authorization token for the request.
#          Reference: IETF RFC 7235.
#        in: header
#        required: false
#        type: string
#      - name: Version
#        description: |
#          Version of the API requested to use when responding to this request.
#        in: header
#        required: true
#        type: string
#
#    post:
#      summary: Subscribe to PM notifications.
#      description: |
#        The POST method creates a new subscription.
#        This method shall follow the provisions specified in the Tables 7.4.7.3.1-1 and 7.4.7.3.1-2 for URI query parameters,
#        request and response data structures, and response codes.
#        As the result of successfully executing this method, a new "Individual subscription" resource shall exist as defined
#        in clause 7.4.8. This method shall not trigger any notification.
#        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)
#      parameters:
#        - name: Accept
#          description: |
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231.
#          in: header
#          required: true
#          type: string
#        - name: Content-Type
#          description: |
#            The MIME type of the body of the request.
#            Reference: IETF RFC 7231.
#          in: header
#          required: true
#          type: string
#        - name: body
#          in: body
#          required: true
#          schema:
#            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
#            description: |
#              Details of the subscription to be created.
#      responses:
#        201:
#          description: |
#            201 CREATED
#
#            Shall be returned when the subscription has been created successfully.
#            A representation of the created subscription resource
#            shall be returned in the response body, as defined in clause 7.5.2.3.
#            The HTTP response shall include a "Location" HTTP
#            header that contains the resource URI of the created subscription resource.
#          schema:
#            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
#          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.
#              maximum: 1
#              minimum: 1
#            WWW-Authenticate:
#              type: string
#              description: |
#                Challenge if the corresponding HTTP request has not provided
#                authorization, or error details if the corresponding HTTP request
#                has provided an invalid authorization token.
#              maximum: 1
#              minimum: 0
#            Version:
#              description: |
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#        303:
#          $ref: "../responses/SOL005_resp.yaml#/components/responses/303"
#        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"
#
#    get:
#      summary: Query PM related subscriptions.
#      description: |
#        The client can use this method to query the list of active subscriptions to Performance management notifications
#        subscribed by the client.
#        This method shall follow the provisions specified in the Tables 7.4.7.3.2-1 and 7.4.7.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 expression according to clause 5.2 of ETSI GS NFV-SOL 013.
#            The NFVO shall support receiving this parameter as part of the URI query string.
#            The OSS/BSS may supply this parameter.
#            All attribute names that appear in the PmSubscription and in data types referenced from it
#            shall be supported by the NFVO in the filter expression.
#        - name: nextpage_opaque_marker
#          in: query
#          required: false
#          type: string
#          description: |
#            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
#            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
#            ETSI GS NFV-SOL 013 for this resource.
#        - name: Accept
#          description: |
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231.
#          in: header
#          required: true
#          type: string
#      responses:
#        200:
#          description: |
#            200 OK
#
#            Shall be returned when the list of subscriptions has
#            been queried successfully.
#            The response body shall contain the representations of
#            all active subscriptions of the functional block that
#            invokes the method, as defined in clause 7.5.2.3.
#            If the "filter" URI parameter was supplied in the request,
#            the data in the response body shall have been transformed
#            according to the rules specified in clause 5.2.2 of
#            ETSI GS NFV-SOL 013.
#            If the NFVO supports alternative 2 (paging) according to
#            clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource,
#            inclusion of the Link HTTP header in this response shall
#            follow the provisions in clause 5.4.2.3 of
#            ETSI GS NFV SOL 013.
#
#          headers:
#            Content-Type:
#              description: The MIME type of the body of the response.
#              type: string
#              maximum: 1
#              minimum: 1
#            WWW-Authenticate:
#              type: string
#              description: |
#                Challenge if the corresponding HTTP request has not provided
#                authorization, or error details if the corresponding HTTP request
#                has provided an invalid authorization token.
#              maximum: 1
#              minimum: 0
#            Version:
#              description: |
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#            Link:
#              description: |
#                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
#              type: string
#              maximum: 1
#              minimum: 0
#          schema:
#            type: array
#            items:
#              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
#        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"

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
#  '/subscriptions/{subscriptionId}':
#    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.8
#    parameters:
#      - name: subscriptionId
#        description: |
#          Identifier of the subscription.
#          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
#          to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the
#          payload body of that response.
#        in: path
#        type: string
#        required: true
#      - name: Authorization
#        description: |
#          The authorization token for the request.
#          Reference: IETF RFC 7235
#        in: header
#        required: true
#        type: string
#      - name: Version
#        description: |
#          Version of the API requested to use when responding to this request.
#        in: header
#        required: true
#        type: string
#
#    get:
#      summary: Query a single PM related subscription.
#      description: |
#        The client can use this method for reading an individual subscription about Performance management notifications
#        subscribed by the client.
#        This method shall follow the provisions specified in the Tables 7.4.8.3.2-1 and 7.4.8.3.2-2 for URI query parameters,
#        request and response data structures, and response codes.
#      parameters:
#        - name: Accept
#          description: |
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231
#          in: header
#          required: true
#          type: string
#      responses:
#        200:
#          description: |
#            200 OK
#
#            Shall be returned when the subscription has been read successfully.
#            The response body shall contain a representation of
#            the subscription resource, as defined in clause 7.5.2.3.
#          schema:
#            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
#          headers:
#            Content-Type:
#              type: string
#              description: |
#                The MIME type of the body of the response.This header
#                field shall be present if the response has a non-empty message
#                body.
#            WWW-Authenticate:
#              type: string
#              description: |
#                Challenge if the corresponding HTTP request has not provided
#                authorization, or error details if the corresponding HTTP request
#                has provided an invalid authorization token.
#              maximum: 1
#              minimum: 0
#            Version:
#              description: |
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#        400:
#          $ref: "../responses/SOL005_resp.yaml#/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"
#
#    delete:
#      summary: Terminate a subscription.
#      description: |
#        This method terminates an individual subscription.
#        This method shall follow the provisions specified in the
#        Tables 7.4.8.3.5-1 and 7.4.8.3.5-2 for URI query parameters,
#        request and response data structures, and response codes.
#        As the result of successfully executing this method, the
#        "Individual subscription" resource shall not exist any longer.
#        This means that no notifications for that subscription shall
#        be sent to the formerly-subscribed API consumer.
#        NOTE: Due to race conditions, some notifications might still be
#        received by the formerly-subscribed API consumer for a
#        certain time period after the deletion.
#      parameters:
#        - name: Accept
#          description: |
#            Content-Types that are acceptable for the response.
#            Reference: IETF RFC 7231.
#          in: header
#          required: true
#          type: string
#      responses:
#        204:
#          description: |
#            204 NO CONTENT
#
#            Shall be returned when the subscription resource has been
#            deleted successfully.
#            The response body shall be empty.
#          headers:
#            WWW-Authenticate:
#              type: string
#              description: |
#                Challenge if the corresponding HTTP request has not provided
#                authorization, or error details if the corresponding HTTP request
#                has provided an invalid authorization token.
#              maximum: 1
#              minimum: 0
#            Version:
#              description: |
#                Version of the API used in the response.
#              type: string
#              maximum: 1
#              minimum: 1
#        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"

components:
  parameters:
    ContentTypeMergePatchJSON:
      name: Content-Type
      in: header
      description: |
        The MIME type of the body of the request. Reference: IETF RFC 7231
      required: true
      schema:
        type: string
        enum:
          - application/merge-patch+json
    
    PmJobId:
      name: pmJobId
      in: path
      description: |
        Identifier of the PM job.
        This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
        to a POST request creating a new PM job resource. It can also be retrieved from the "id" attribute in the
        payload body of that response.          
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ReportId:
      name: reportId
      in: path
      description: |
        Identifier of the performance report.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ThresholdId:
      name: thresholdId
      in: path
      description: |
        Identifier of the threshold.
        This identifier can be retrieved from the resource referenced by the
        "Location" HTTP header in the response to a POST request creating a
        new threshold resource. It can also be retrieved from the "id"
        attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

  requestBodies:
    CreatePmJobRequest:
      description: |
        The VNF creation parameters.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
      required: true

    PmJobModifications:
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJobModifications"
      required: true

    CreateThresholdRequest:
      description: |
        Request parameters to create a new "Individual threshold" resource.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
      required: true

    ThresholdModifications:
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/ThresholdModifications"
      required: true

  responses:

    PmJobs.Post.201:
      description: |
        201 CREATED

        Shall be returned when the "Individual PM job" has been created successfully.
        The response body shall contain a representation of
        the created PM job resource, as defined in clause 7.5.2.7.
        The HTTP response shall include a "Location" HTTP
        header that points to the created "Individual PM job" resource.
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"

    PmJobs.Post.422:
      description: |
        422 Unprocessable Entity

        content type of the payload body is supported and the payload body of a request contains syntactically correct
        data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 7.4.9.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about
        the error
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    PmJobs.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more PM jobs has been queried successfully.
        The response body shall contain in an array the representations of
        zero or more PM jobs, as defined in clause 7.5.2.7.

        If the "filter" URI parameter or one of the "all_fields", "fields", "include_fields",
        "exclude_fields" or "exclude_default" URI parameters was supplied in the request and is
        supported, the data in the response body shall have been transformed according to the 
        rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV SOL 013, respectively.
        
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of 
        ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header 
        in this response shall follow the provisions in clause 5.4.2.3 of 
        ETSI GS NFV SOL 013.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"

    IndividualPmJob.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual 
        PM job has been queried successfully.
        The response body shall contain a representation of
        the "Individual PM job resource", as defined in clause 7.5.2.7.
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"

    IndividualPmJob.Patch.200:
      description: |
        200 OK

        Shall be returned when the request has been processed successfully.
        The response body shall contain a data structure of type "PmJobModifications".
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJobModifications"

    IndividualPmJob.Patch.412:
      description: |
        412 Precondition Failed

        A precondition given in an HTTP request header is not fulfilled.
        Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
        The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey
        more information about the error.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPmJob.Patch.422:
      description: |
        422 Unprocessable entity

        Shall be returned upon the following error: The content type of the payload body is supported and the payload
        body of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 7.4.9.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about
        the error.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualPmJob.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the PM job has been deleted successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPerformanceReport.Get.200:
      description: |
        200 OK

        Shall be returned when information of an individual performance 
        report has been read successfully.
        The response body shall contain a representation of the "Individual performance
        report" resource, as defined in clause 7.5.2.10.
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PerformanceReport"

    Thresholds.Post.201:
      description: |
        201 CREATED

        Shall be returned when a threshold has been created successfully.
        The response body shall contain a representation of
        the created "Individual threshold" resource, as defined in clause 7.5.2.9.
        The HTTP response shall include a "Location" HTTP
        header that contains the resource URI of the created
        threshold resource.            
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"

    Thresholds.Post.422:
      description: |
        422 Unprocessable entity

        Shall be returned upon the following error: The content type of the payload body is supported and the payload
        body of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 7.4.9.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error.
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    Thresholds.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more thresholds was queried 
        successfully.
        If the "filter" URI parameter was supplied in the request, the data in the 
        response body shall have been transformed according to the rules specified 
        in clause 5.2.2 of ETSI GS NFV-SOL 013.
        The response body shall contain representations of zero or more thresholds,
        as defined in clause 7.5.2.9.
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of 
        ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header 
        in this response shall follow the provisions in clause 5.4.2.3 of 
        ETSI GS NFV SOL 013.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"

    IndividualThreshold.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual threshold 
        has been queried successfully.
        The response body shall contain a representation of
        the threshold, as defined in clause 7.5.2.9.            
      headers:
        Content-Type:
          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.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"

    IndividualThreshold.Patch.200:
      description: |
        200 OK

        Shall be returned when the request has been processed successfully.
        The response body shall contain a data structure of type "ThresholdModifications".
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/ThresholdModifications"

    IndividualThreshold.Patch.412:
      description: |
        412 Precondition Failed

        Shall be returned upon the following error: A precondition given in an HTTP request header is not fulfilled.
        Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
        The response body should contain a ProblemDetails structure, in which the "detail" attribute should
        convey more information about the error.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualThreshold.Patch.422:
      description: |
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type of the payload body is supported and the payload
        body of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 7.4.9.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about
        the error.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualThreshold.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the threshold has been deleted successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string