NSLifecycleManagement.yaml 87.3 KB
Newer Older
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
  '/subscriptions/{subscriptionId}':
    #ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.17
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      description: >
        The GET method retrieves information about a subscription by reading an individual subscription resource.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.17.3.2-1 and 6.4.17.3.2-2
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
          description: >
            200 OK
            Shall be returned when information about an individual
            subscription has been read successfully.
            The response body shall contain a representation of
            the "Individual subscription" resource.           
rameshnaraya's avatar
rameshnaraya committed
          schema:
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
              type: string
rameshnaraya's avatar
rameshnaraya committed
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
    delete:
      description: >
        The DELETE method terminates an individual subscription.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2.
        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.
            Shall be returned when the "Individual subscription"
            resource has been deleted successfully.
rameshnaraya's avatar
rameshnaraya committed
            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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"