Commit 1a59b664 authored by moscatelli's avatar moscatelli
Browse files

SOL002: Fix in notification interfaces and errors referenced schemas

parent 734f5afb

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+2 −2
Original line number Diff line number Diff line
@@ -97,7 +97,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -153,7 +153,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        412:

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+8 −8
Original line number Diff line number Diff line
@@ -166,7 +166,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -268,7 +268,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -345,7 +345,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        409:
@@ -436,7 +436,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -549,7 +549,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -672,7 +672,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -774,7 +774,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -822,7 +822,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+226 −7
Original line number Diff line number Diff line
@@ -34,9 +34,9 @@ produces: 


paths:

  ###############################################################################

  # Notification endpoint                                                       #

  # Notification endpoint AlarmNotification                                     #

  ###############################################################################

  '/URI-is-provided-by-the-client-when-creating-the-subscription':

  '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmNotification':

    parameters:

      - name: Version

        description: >
@@ -55,7 +55,6 @@ paths: 
      description: >

        Notify





        The POST method notifies a VNF alarm or that the alarm list has been

        rebuilt.

      parameters:
@@ -63,21 +62,241 @@ paths: 
          description: >

            Information of a VNF alarm.

          in: body

          required: false

          required: true

          schema:

            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"

        - name: Content-Type

          description: >

            The Content-Type header shall be set to

            "application/merge-patch+json" according to

            IETF RFC 7396.

          in: header

          required: true

          type: string

      responses:

        204:

          description: >

            204 NO CONTENT



            The notification was 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: >

                Version of the API used in the response.

              type: string

              maximum: 1

              minimum: 1

        400:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"

        401:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"

        403:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        500:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

        503:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

    get:

      description: >

        The GET method allows the server to test the notification endpoint

        that is provided by the client, e.g. during subscription.

      responses:

        204:

          description: >

            201 NO CONTENT



            The notification endpoint was 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.

              type: string

              maximum: 1

              minimum: 0

            Version:

              description: >

                Version of the API used in the response.

              type: string

              maximum: 1

              minimum: 1

        400:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"

        401:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"

        403:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        500:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

        503:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"



  ###############################################################################

  # Notification endpoint AlarmClearedNotification                              #

  ###############################################################################

  '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmClearedNotification':

    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

    post:

      description: >

        Notify



        The POST method notifies a VNF alarm or that the alarm list has been

        rebuilt.

      parameters:

        - name: AlarmClearedNotification

          description: >

            Information of the clearance of a VNF alarm

          in: body

          required: false

          required: true

          schema:

            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"

        - name: Content-Type

          description: >

            The Content-Type header shall be set to

            "application/merge-patch+json" according to

            IETF RFC 7396.

          in: header

          required: true

          type: string

      responses:

        204:

          description: >

            204 NO CONTENT



            The notification was 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: >

                Version of the API used in the response.

              type: string

              maximum: 1

              minimum: 1

        400:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"

        401:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"

        403:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        500:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

        503:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

    get:

      description: >

        The GET method allows the server to test the notification endpoint

        that is provided by the client, e.g. during subscription.

      responses:

        204:

          description: >

            201 NO CONTENT



            The notification endpoint was 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.

              type: string

              maximum: 1

              minimum: 0

            Version:

              description: >

                Version of the API used in the response.

              type: string

              maximum: 1

              minimum: 1

        400:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"

        401:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"

        403:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        500:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"

        503:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"



  ###############################################################################

  # Notification endpoint AlarmListRebuiltNotification                          #

  ###############################################################################

  '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmListRebuiltNotification':

    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

    post:

      description: >

        Notify



        The POST method notifies a VNF alarm or that the alarm list has been

        rebuilt.

      parameters:

        - name: AlarmListRebuiltNotification

          description: >

            Information that the alarm list has been rebuilt by the VNFM

          in: body

          required: false

          required: true

          schema:

            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"

        - name: Content-Type
@@ -131,7 +350,7 @@ paths: 
      responses:

        204:

          description: >

            201 NO CONTENT

            204 NO CONTENT



            The notification endpoint was tested successfully.

            The response body shall be empty.

src/SOL002/VNFIndicator/VNFIndicator.yaml

+8 −8
Original line number Diff line number Diff line
@@ -143,7 +143,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -277,7 +277,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -365,7 +365,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -435,7 +435,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -523,7 +523,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -630,7 +630,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -711,7 +711,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:
@@ -764,7 +764,7 @@ paths: 
        404:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

        405:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"

        406:

          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"

        416:

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+3 −3
Original line number Diff line number Diff line
@@ -32,9 +32,9 @@ produces: 


paths:

  ###############################################################################

  # Notification endpoint                                                       #

  # Notification endpoint VnfIndicatorValueChangeNotification                   #

  ###############################################################################

  '/URI-is-provided-by-the-client-when-creating-the-subscription':

  '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':

    parameters:

      - name: Version

        description: >
@@ -67,7 +67,7 @@ paths: 
      responses:

        204:

          description: >

            No Content

            204 NO CONTENT



            The notification was delivered successfully. The response body shall be empty.

          headers: