Commit be689414 authored by moscatelli's avatar moscatelli
Browse files

SOL003_158/SOL003_160/SOl003_161: Individual subscription methods updated

parent 7c33978d
Loading
Loading
Loading
Loading
Loading
+44 −33
Original line number Diff line number Diff line
@@ -131,7 +131,7 @@ paths:
              maximum: 1
              minimum: 0
          schema:
            $ref: "#/definitions/Alarm"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
@@ -212,7 +212,7 @@ paths:
              maximum: 1
              minimum: 1
          schema:
            $ref: "#/definitions/Alarm"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
@@ -246,7 +246,7 @@ paths:
          in: body
          required: true
          schema:
            $ref: "#/definitions/AlarmModifications"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
@@ -301,7 +301,7 @@ paths:
              maximum: 1
              minimum: 0
          schema:
            $ref: "#/definitions/AlarmModifications"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
@@ -359,7 +359,7 @@ paths:
          in: body
          required: true
          schema:
            $ref: "#/definitions/FmSubscriptionRequest"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
@@ -420,7 +420,7 @@ paths:
              maximum: 1
              minimum: 0
          schema:
            $ref: "#/definitions/FmSubscription"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        303:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
        400:
@@ -543,23 +543,28 @@ paths:
              maximum: 1
              minimum: 0
          schema:
            $ref: "#/definitions/FmSubscription"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
@@ -571,18 +576,18 @@ paths:
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new subscription resource. It can also be retrieved from the "id"
          new "Individual subscription" resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      description: >
        Query Subscription Information


        The client can use this method for reading an individual subscription
        for VNF alarms subscribed by the client.
        Query Subscription Information.
        The client can use this method for reading an individual subscription for VNF alarms
        subscribed by the client.
        This method shall follow the provisions specified in the tables 7.4.5.3.2-1 and 7.4.5.3.2-2
        for URI query parameters, request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
@@ -642,27 +647,40 @@ paths:
              maximum: 1
              minimum: 1
          schema:
            $ref: "#/definitions/FmSubscription"
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

    delete:
      description: >
        Terminate Subscription


        Terminate Subscription.
        This method terminates an individual subscription.
        This method shall follow the provisions specified in the tables 7.4.5.3.5-1 and 7.4.5.3.5-2
        for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, the "Individual subscription" resource
        shall not exist any longer. This means that no notifications for that subscription shall be
        sent to the formerly-subscribed API consumer.

          NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
                API consumer for a certain time period after the deletion.
      parameters:
        - name: Authorization
          description: >
@@ -682,7 +700,7 @@ paths:
          description: >
            204 NO CONTENT

            The subscription resource was deleted successfully.
            Shall be returned when the "Individual subscription" resource has been deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
@@ -705,24 +723,17 @@ paths:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

###############################################################################
# Definitions                                                                 #
###############################################################################
definitions: 
  Alarm:
    $ref: "../definitions/SOL003_def.yaml#/definitions/Alarm"
  AlarmModifications:
    $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
  FmSubscription:
    $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
  FmSubscriptionRequest:
    $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
 No newline at end of file
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
 No newline at end of file
+0 −28
Original line number Diff line number Diff line
responses:
  409-alarm-state-conflict:
    description: >
      Conflict

      The operation cannot be executed currently, due to a conflict with the
      state of the "Individual alarm" resource.
      Typically, this is due to the fact that the alarm is already in the
      state that is requested to be set (such as trying to acknowledge an
      already-acknowledged alarm).
      The response body shall contain a ProblemDetails structure, in which the
      "detail" attribute should convey more information about the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      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
    schema:
      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"