SOL005NSDescriptorManagement_resp.yaml 5.66 KB
Newer Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses:
  206:
    description: >
      Partial Content.

      On success, if the NFVO supports range requests, a
      single consecutive byte range from the content of the
      NSD file is returned.
      The response body shall contain the requested part of
      the NSD file.
      The "Content-Range" HTTP header shall be provided
      according to IETF RFC 7233 [23].
      The "Content-Type" HTTP header shall be set as
      defined above for the "200 OK" response.
    headers:
      Content-Type:
        description: >
          The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      Content-Range:
        description: >
          The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
        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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  303:
    description: >
      A subscription with the same callbackURI and the same filter already exits and the policy
      of the NFVO is to not create redundant subscriptions.
      The HTTP response shall include a "Location" HTTP header that contains the resource URI of
      the existing subscription resource.
      The response body shall be empty.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1

  409:
    description: >
      Conflict

      Error: The operation cannot be executed currently,
      due to a conflict with the state of the resource.
      Typically, this is due to the fact the NS descriptor
      resource is in the enabled operational state (i.e.
      operationalState = ENABLED) or there are running
      NS instances using the concerned individual NS
      descriptor resource (i.e. usageState = IN_USE).
      The response body shall contain a ProblemDetails
      structure, in which the "detail" attribute shall 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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  412:
    description: >
      Precondition Failed.
      A precondition given in an HTTP request header is not fulfilled.

      Typically, this is due to an ETag mismatch, indicating that the
      resource was modified by another entity.

      The response body should
      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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

  416:
    description: >
      The byte range passed in the "Range" header did not
      match any available byte range in the NSD file (e.g. access after end of file).
      The response body may contain a ProblemDetails structure.
    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
      Version:
        description: >
          Version of the API used in the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"