Commit 0fd22956 authored by Francesca Moscatelli's avatar Francesca Moscatelli
Browse files

Notification interfaces migrated to OpenAPI 3.0.2

parent cdcd73ae
Loading
Loading
Loading
Loading
+5 −5
Original line number Diff line number Diff line
@@ -20,12 +20,12 @@ externalDocs:

paths:
  /vnfconfig/api_versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
  /vnffm/api_versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
  /vnfind/api_versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
  /vnflcm/api_versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
  /vnfpm/api_versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
 No newline at end of file
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
 No newline at end of file
+231 −362

File changed.

Preview size limit exceeded, changes collapsed.

+117 −116
Original line number Diff line number Diff line
swagger: "2.0"
openapi: 3.0.2

info:
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL002 - VNF Indicator Notification Endpoint interface
  description: >
    SOL002 - VNF Indicator Notification Endpoint interface
    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
  description: |
    SOL002 - VNF Indicator Notification Endpoint interface 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
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    name: NFV-SOL WG
  version: 1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 002 V2.7.1
  description: ETSI GS NFV-SOL 002 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf

schemes:
  - http
  - https

consumes:
  - application/json

produces:
  - application/json
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1

paths:
  ###############################################################################
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
  ###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      summary: Test notification endpoint.
      description: |
        Service Unavailable
        The GET method allows the server to test the notification endpoint that is provided by the client,
        e.g. during subscription.
      responses:
        "204":
          $ref: '#/components/responses/VNFInNotification.Get'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

    post:
      summary: Notification endpoint
      description: >
        The API producer can use this resource to send notifications related to VNF indicator
        value changes to a subscribed API consumer, which has provided the URI of this resource
        during the subscription process.
        The POST method delivers a notification from API producer to an API consumer. The API 
        consumer shall have previously created an "Individual subscription" resource with a 
        matching filter.
      description: |
        The API producer can use this resource to send notifications related to VNF indicator value changes to a
        subscribed API consumer, which has provided the URI of this resource during the subscription process.
        The POST method delivers a notification from API producer to an API consumer. The API  consumer shall have
        previously created an "Individual subscription" resource with a  matching filter.
      parameters:
        - name: vnfIndicatorValueChangeNotification
          in: body
          description: >
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfIndicatorValueChangeNotification'
      responses:
        "204":
          $ref: '#/components/responses/VNFInNotification.Post'
        "400":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        "401":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        "403":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        "405":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        "406":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        "500":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        "503":
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

components:
  requestBodies:
    VnfIndicatorValueChangeNotification:
      description: |
        A notification about VNF indicator value changes.
          required: true
      content:
        application/json:
          schema:
            $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'
      responses:
        204:
          description: >
            204 NO CONTENT
            $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification
      required: true

            Shall be returned when the notification has been delivered successfully. 
            The response body shall be empty.
  responses:
    VNFInNotification.Get:
      description: |
        201 NO CONTENT
        Shall be returned to indicate the notification endpoint has been  tested successfully. The response body
        shall be empty.
      headers:
        Version:
              description: The used API version.
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
    get:
      summary: Test notification endpoint.
      description: >
        Service Unavailable
        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
      content: {}

        The GET method allows the server to test the notification endpoint that is provided
        by the client, e.g. during subscription.
      responses:
        204:
          description: >
    VNFInNotification.Post:
      description: |
        204 NO CONTENT

            Shall be returned when the notification endpoint has been tested successfully. 
            The response body shall be empty.
        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.
              type: string
              maximum: 1
              minimum: 0
        Version:
              description: The used API version.
          description: |
            Version of the API used in the response.
          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
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
 No newline at end of file
      content: {}
 No newline at end of file
+215 −403

File changed.

Preview size limit exceeded, changes collapsed.

+1 −1

File changed and moved.

Contains only whitespace changes.

Loading