VNFIndicatorNotification.yaml 5.91 KB
Newer Older
Gergely Csatari's avatar
Gergely Csatari committed

info:
  title: SOL003 - VNF Indicator Notification interface
    SOL003 - VNF Indicator 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
Gergely Csatari's avatar
Gergely Csatari committed
  license:
    name: ETSI Forge copyright notice
Gergely Csatari's avatar
Gergely Csatari committed
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  description: ETSI GS NFV-SOL 003 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
Gergely Csatari's avatar
Gergely Csatari committed

paths:
  ###############################################################################
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
  ###############################################################################
  /URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification:
Gergely Csatari's avatar
Gergely Csatari committed
    #SOL003 location: 8.4.7
    post:
        Notify.
        The POST method delivers a notification from the API producer to an 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.4.7.3.1-1 and 8.4.7.3.1-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      requestBody:
        $ref: '#/components/requestBodies/AlarmListRebuiltNotification'
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        204:
          $ref: '#/components/responses/VNFINDNotification.Post.204'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
Gergely Csatari's avatar
Gergely Csatari committed
    get:
        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.4.7.3.2-1 and 8.4.7.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        204:
          $ref: '#/components/responses/VNFINDNotification.Get.204'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

components:

  requestBodies:
    AlarmListRebuiltNotification: 
      description: Information that the alarm list has been rebuilt by the VNFM.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification
              - $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/SupportedIndicatorsChangeNotification
      required: true
  
  responses:
    VNFINDNotification.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: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    VNFINDNotification.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: The used API version.
          style: simple
          explode: false
          schema:
            type: string