NFVManoPerformanceManagementNotification.yaml

openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  title: SOL009 - NFV-MANO Performance Management Notification Operation
  description: >
    SOL009 - NFV-MANO Performance Management Notification Operation

    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
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    name: NFV-SOL WG
externalDocs:
  description: ETSI GS NFV-SOL 009 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf

servers:
  - url: http://0.0.0.0/callback/v1
    description: >
      API HTTP Server
  - url: https://0.0.0.0/callback/v1
    description: >
      API HTTPS Server

paths:
  /URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationNotification:
    description: >
      This resource represents a notification endpoint for NFV-MANO performance management. 
      The API producer can use this resource to send notifications related to performance 
      management events to an API consumer, which has provided the URI of this
      resource during the PM jobor threshold creation process.
    post:
      description: >
        The POST method delivers a notification regarding a performance management event
        from the API producer to an API consumer. The API consumer shall have previously 
        created an " Individual PM job resource" or "Individual threshold resource".
      parameters:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      requestBody:
        $ref: "#/components/requestBodies/PerfomanceInfoNotification"
      responses:
        "204": 
          $ref: "#/components/responses/notification.post.204"
        "400":
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
        "401":
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
        "403":
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
        "404":
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
        "405":
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
        "406":
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
        "422":
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
        "500":
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
        "503":
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
        "504":
          $ref: ../components/SOL009_resp.yaml#/components/responses/504

    get:
      description: >
        The GET method allows the server to test the notification endpoint that is 
        provided by the client, e.g. during creation of the PM job or threshold.
      parameters:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      responses:
        "204": 
          $ref: "#/components/responses/notification.get.204"
        "400":
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
        "401":
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
        "403":
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
        "404":
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
        "405":
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
        "406":
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
        "422":
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
        "500":
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
        "503":
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
        "504":
          $ref: ../components/SOL009_resp.yaml#/components/responses/504

components:
  responses:
    notification.post.204:
      description: >
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully.
      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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

    notification.get.204:
      description: >
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been 
        tested 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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

  requestBodies:
    PerfomanceInfoNotification:
      description: >
        Notification about the avaialbility of a performance information or a threshold
        crossing.
      content:
        application/json:
          schema: 
            oneOf:
              - $ref: "#/components/schemas/PerformanceInformationAvailableNotification"
              - $ref: "#/components/schemas/ThresholdCrossedNotification"
      required: true

  schemas:
    ThresholdCrossedNotification:
      description: >
        This type represents a notification that is sent when a threshold has been crossed.

        NOTE:	The timing of sending this notification is determined by the capability of
        the producing entity to evaluate the threshold crossing condition.

        The notification shall be triggered by the NFV-MANO functional entity when
        a threshold has been crossed.
      type: object
      properties:
        id:
          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.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        notificationType:
          description: >
            Discriminator for the different notification types. Shall be set to
            "ThresholdCrossedNotification" for this notification type.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
        timeStamp:
          description: >
            Date and time of the generation of the notification.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
        thresholdId:
          description: >
            Identifier of the threshold which has been crossed.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        crossingDirection:
          description: >
            An indication of whether the threshold was crossed in upward or downward direction.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/CrossingDirectionType"
        objectType:
          description: >
            Type of measured object.The applicable measured object type for a measurement
            is defined in clause 8.2 of ETSI GS NFV-IFA 031.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
        objectInstanceId:
          description: >
            Identifier of the measured object instance. This attribute shall contain the
            identifier of the instance of the measure object according to their type.
            See also definitions in clause 8.2 of ETSI GS NFV-IFA 031
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        subObjectInstanceId:
          description: >
            Identifier of the sub-object of the measured object to which the measurement
            applies. Shall be present if this is required in clause 8.2 of ETSI GS NFV-IFA 031
            for the related measured object type. Shall be absent otherwise.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
        performanceMetric:
          description: >
            Performance metric associated with the threshold.
            This attribute shall contain the related "Measurement Name" value as defined
            in clause 8.4 of ETSI GS NFV-IFA 031
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
        performanceValue:
          description: >
            Value of the metric that resulted in threshold crossing.
            The type of this attribute shall correspond to the related "Measurement Unit"
            as defined in clause 8.4 of ETSI GS NFV-IFA 031.
        context:
          description: >-
            Measurement context information related to the measured value. The set of applicable keys is defined per
            measurement in clause 8.4 of ETSI GS NFV-IFA 031.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            objectInstance:
              description: >
                Link to the resource representing the measured object instance to which
                the notified change applies. Shall be present if the measured object
                instance information is accessible as a resource.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
            threshold:
              description: >
                Link to the resource that represents the threshold that was crossed.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
          required:
            - objectInstance
      required:
        - id
        - notificationType
        - timeStamp
        - thresholdId
        - crossingDirection
        - objectType
        - objectInstanceId
        - performanceMetric
        - performanceValue
        - _links

    PerformanceInformationAvailableNotification:
      description: >
        This notification informs the receiver that performance information is available.
      type: object
      properties:
        id:
          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.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        notificationType:
          description: >
            Discriminator for the different notification types.
            Shall be set to "PerformanceInformationAvailableNotification" for this
            notification type.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
        timeStamp:
          description: >
            Date and time of the generation of the notification.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
        pmJobId:
          description: >
            Identifier of the PM job for which performance information is available.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        objectType:
          description: >
            Type of measured object.
            The applicable measured object type for a measurement is defined in clause 8.2
            of ETSI GS NFV-IFA 031.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
        objectInstanceId:
          description: >
            Type of measured object.
            The applicable measured object type for a measurement is defined in clause 8.2
            of ETSI GS NFV-IFA 031
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        subObjectInstanceId:
          description: >
            Identifier of the sub-object of the measured object instance for which the
            measurements have been taken. Shall be present if the related PM job has been
            set up to measure a sub-object instance of the measured object instance and a
            sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the related
            measured object type. Shall be absent otherwise.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            objectInstance:
              description: >
                Link to the resource representing the measured object instance to which the
                notification applies. Shall be present if the measured object instance
                information is accessible as a resource.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
            pmJob:
              description: >
                Link to the resource that represents the PM job for which performance
                information is available.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
            PerformanceReport:
              description: >
                Link from which the available performance information of data type
                "PerformanceReport" can be obtained.
                This link should point to an "Individual performance report" resource.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
          required:
            - pmJob
            - performanceReport
      required:
        - id
        - notificationType
        - pmJobId
        - timeStamp
        - objectType
        - objectInstanceId
        - _links