VNFFaultManagementNotification.yaml 14.3 KB
Newer Older
  title: SOL003 - VNF Fault Management Notification interface
    SOL003 - VNF Fault 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/rep/nfv/SOL002-SOL003/issues
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  description: ETSI GS NFV-SOL 003 V3.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.06.01_60/gs_NFV-SOL003v030601p.pdf
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
  ###############################################################################
  # Notification endpoint AlarmNotification                                     #
  ###############################################################################
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification:
    #SOL003 location: 7.4.6
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
        The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have
        previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1.
      parameters:
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmNotification'
      responses:
        204:
          $ref: '#/components/responses/AlarmNotification.Post.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        The GET method allows the API producer to test the notification endpoint that is provided by the
        API consumer, e.g. during subscription. See clause 7.4.6.3.2.
      responses:
        204:
          $ref: '#/components/responses/AlarmNotification.Get.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
  ###############################################################################
  # Notification endpoint AlarmClearedNotification                              #
  ###############################################################################
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification:
    #SOL003 location: 7.4.6
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
        The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have
        previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1.
      parameters:
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmClearedNotification'
      responses:
        204:
          $ref: '#/components/responses/AlarmClearedNotification.Post.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        The GET method allows the API producer to test the notification endpoint that is provided by the
        API consumer, e.g. during subscription. See clause 7.4.6.3.2.
      responses:
        204:
          $ref: '#/components/responses/AlarmClearedNotification.Get.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
  ###############################################################################
  # Notification endpoint AlarmListRebuiltNotification                          #
  ###############################################################################
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification:
    #SOL003 location: 7.4.6
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
        The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have
        previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1.
      parameters:
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmListRebuiltNotification'
      responses:
        204:
          $ref: '#/components/responses/AlarmListRebuiltNotification.Post.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
        The GET method allows the API producer to test the notification endpoint that is provided by the
        API consumer, e.g. during subscription. See clause 7.4.6.3.2.
      responses:
        204:
          $ref: '#/components/responses/AlarmListRebuiltNotification.Get.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"

components:
  requestBodies:
    AlarmNotification:
      description: Information of a VNF alarm.
      content:
        application/json:
          schema:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
            $ref: "../VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
      required: true

    AlarmClearedNotification:
      description: Information of the clearance of a VNF alarm
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
      required: true

    AlarmListRebuiltNotification:
      description: Information that the alarm list has been rebuilt by the VNFM
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
      required: true

  responses:
    AlarmNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification has been delivered 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

    AlarmNotification.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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    AlarmClearedNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification has been delivered 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

    AlarmClearedNotification.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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    AlarmListRebuiltNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification has been delivered 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

    AlarmListRebuiltNotification.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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string