NFVManoLogManagementNotification.yaml

openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  title: SOL009 - NFV-MANO Log Management Notification interface
  description: >
    SOL009 - NFV-MANO Log Management Notification 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/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
  description: ETSI GS NFV-SOL 009 V0.8.0
  url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL009ed331_MANO_mgmt_stage_3/NFV-SOL009ed331v080.zip

security:
  - OauthSecurity:
      - all

servers:
  - url: http://127.0.0.1//callback/v1
  - url: https://127.0.0.1//callback/v1

paths:
  /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification:
    description: >-
      This resource represents a notification endpoint for NFV-MANO log management.
      The API producer can use this resource to send notifications related to log management events to a
      subscribed API consumer, which has provided the URI of this resource during the subscription process.

    post:
      description: >-
        The POST method delivers a notification regarding a log management event from the API producer to the API
        consumer. The API consumer shall have previously created an "Individual subscription" resource with a
        matching filter.
        This method shall follow the provisions specified in the tables 8.5.9.3.1-1 and 8.5.9.3.1-2 for URI query
        parameters, request and response data structures, and response codes.
      parameters:
        - $ref: "#/components/parameters/Version"
        - $ref: "#/components/parameters/Accept"
        - $ref: "#/components/parameters/Authorization"
      requestBody:
        $ref: "#/components/requestBodies/LogReportAvailableNotification"
      responses:
        "204":
          $ref: '#/components/responses/LogReportAvailableNotification'
        "400":
          $ref: '../responses/SOL009_resp.yaml#/responses/400'
        "401":
          $ref: '../responses/SOL009_resp.yaml#/responses/401'
        "403":
          $ref: '../responses/SOL009_resp.yaml#/responses/403'
        "404":
          $ref: '../responses/SOL009_resp.yaml#/responses/404'
        "405":
          $ref: '../responses/SOL009_resp.yaml#/responses/405'
        "406":
          $ref: '../responses/SOL009_resp.yaml#/responses/406'
        "422":
          $ref: '../responses/SOL009_resp.yaml#/responses/422'
        "500":
          $ref: '../responses/SOL009_resp.yaml#/responses/500'
        "503":
          $ref: '../responses/SOL009_resp.yaml#/responses/503'
        "504":
          $ref: '../responses/SOL009_resp.yaml#/responses/504'

    get:
      description: >-
        The GET method allows the API producer to test the notification endpoint that is provided by the API
        consumer, e.g. during subscription.
        This method shall follow the provisions specified in the tables 8.5.9.3.2-1 and 8.5.9.3.2-2 for URI
        query parameters, request and response data structures, and response codes.
      parameters:
        - $ref: "#/components/parameters/Version"
        - $ref: "#/components/parameters/Accept"
        - $ref: "#/components/parameters/Authorization"
      responses:
        "204":
          $ref: '#/components/responses/LogReportNotification.Get'
        "400":
          $ref: '../responses/SOL009_resp.yaml#/responses/400'
        "401":
          $ref: '../responses/SOL009_resp.yaml#/responses/401'
        "403":
          $ref: '../responses/SOL009_resp.yaml#/responses/403'
        "404":
          $ref: '../responses/SOL009_resp.yaml#/responses/404'
        "405":
          $ref: '../responses/SOL009_resp.yaml#/responses/405'
        "406":
          $ref: '../responses/SOL009_resp.yaml#/responses/406'
        "422":
          $ref: '../responses/SOL009_resp.yaml#/responses/422'
        "500":
          $ref: '../responses/SOL009_resp.yaml#/responses/500'
        "503":
          $ref: '../responses/SOL009_resp.yaml#/responses/503'
        "504":
          $ref: '../responses/SOL009_resp.yaml#/responses/504'

components:
  parameters:
    Version:
      name: Version
      description: >-
        Version of the API requested to use when responding to this request
      in: header
      required: true
      schema:
        type: string
    Accept:
      name: Accept
      description: >-
        Content-Types that are acceptable for the response. Reference: IETF RFC 7231
      in: header
      required: true
      schema:
        type: string
    Authorization:
      name: Authorization
      description: >-
        The authorization token for the request. Reference: IETF RFC 7235
      in: header
      required: false
      schema:
        type: string

  requestBodies:
    LogReportAvailableNotification:
      description: >-
        Notification about the availability of a log report.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/LogReportAvailableNotification"

  responses:
    LogReportAvailableNotification:
      description: >-
        Shall be returned when the notification has been delivered successfully.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

    LogReportNotification.Get:
      description: >-
        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

  schemas:
    LogReportAvailableNotification:
      description: >-
        This notification informs the receiver that the log report of the NFV-MANO functional entity is available.
        It shall comply with the provisions defined in table 8.6.2.4-1.
        The notification shall be triggered by the NFV-MANO functional entity when log information has been collected
        by the logging job and the log report is available.
      type: object
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - objectInstanceId
        - _links
      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: '../definitions/SOL009_def.yaml#/definitions/Identifier'
        notificationType:
          description: >-
            Discriminator for the different notification types.
            Shall be set to "LogReportAvailableNotification" for this notification type.
          type: string
        subscriptionId:
          description: >-
            Identifier of the subscription that this notification relates to.
          $ref: '../definitions/SOL009_def.yaml#/definitions/Identifier'
        timeStamp:
          description: >-
            Date and time of the generation of the notification.
          $ref: '../definitions/SOL009_def.yaml#/definitions/DateTime'
        objectInstanceId:
          description: >-
            Identifier that identifies the object instance for which the log report is available.
            This attribute shall contain the identifier of the logged object according to their type.
          $ref: "../NFVManoLogManagement/NFVManoLogManagement.yaml#/components/schemas/ManoManagedObjectReference"
        _links:
          description: >-
            Links to resources related to this notification.
          type: object
          required:
            - subscription
            - logReports
          properties:
            subscription:
              description: >-
                Link to the related subscription.
              $ref: '../definitions/SOL009_def.yaml#/definitions/NotificationLink'
            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: '../definitions/SOL009_def.yaml#/definitions/NotificationLink'
            LoggingJob:
              description: >-
                Link to the resource that represents the logging job for which the log report is available.
              $ref: '../definitions/SOL009_def.yaml#/definitions/NotificationLink'
            logReports:
              description: >-
                Link from which the available log report can be obtained. Due to the relationship of the logging
                job compilation and the logging information availability reporting, more than one logReport
                notification link can be provided.
              type: array
              items:
                $ref: '../definitions/SOL009_def.yaml#/definitions/NotificationLink'