SOL005_resp.yaml 7.54 KB
Newer Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
responses:
  303:
    description: >
      See Other

      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
      eader that contains the resource URI of the existing
      subscription resource.
      The response body shall be empty.
  400:
    description: >
      Bad Request

      Error: Invalid attribute-based filtering parameters.
      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/SOL005_def.yaml#/definitions/ProblemDetails"
  400-attr-based-filtering-error:
    description: >
      Bad Request
      Invalid attribute-based filtering parameters or Invalid attribute
      selector.
      It the request is malformed or syntactically incorrect (e.g. if the
      request URI contains incorrect query parameters or a syntactically
      incorrect payload body), the API producer shall respond with this
      response code. The "ProblemDetails" structure shall be provided,
      and should include in the "detail" attribute more information about
      the source of the problem.
      If the request contains a malformed access token, the API producer
      should respond with this response. The details of the error shall
      be returned in the WWW-Authenticate HTTP header, as defined in
      IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be
      provided.
      If there is an application error related to the client's input that
      cannot be easily mapped to any other HTTP response code ("catch all
      error"), the API producer shall respond with this response code.The
      "ProblemDetails" structure shall be provided, and shall include in
      the "detail" attribute more information about the source of the
      problem.
    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
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  401:
    description: >
      Unauthorized.
      If the request contains no access token even though one is
      required, or if the request contains an authorization token that
      is invalid (e.g. expired or revoked), the API producer should
      respond with this response. The details of the error shall be
      returned in the WWW-Authenticate HTTP header, as defined in
      IETF RFC 6750 and IETF RFC 7235. The ProblemDetails
      structure may be provided.
    headers:
      Content-Type:
        type: string
        description: The MIME type of the body of the response.
      WWW-Authenticate:
        type: string
        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.
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  403:
    description: >
      Forbidden
      If the API consumer is not allowed to perform a particular request
      to a particular resource, the API producer shall respond with this
      response code. The "ProblemDetails" structure shall be provided.
      It should include in the "detail" attribute information about the
      source of the problem, and may indicate how to solve it.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  405:
    description: >
      Method Not Allowed
      If a particular HTTP method is not supported for a particular
      resource, the API producer shall respond with this response code.
      The "ProblemDetails" structure may be omitted in that case.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  406:
    description: >
      If the "Accept" header does not contain at least one
      name of a content type for which the NFVO can
      provide a representation of the NSD, the NFVO shall
      respond with this response code.
      The "ProblemDetails" structure may be included with
      the "detail" attribute providing more information about
      the error.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  412:
    description: >
      Precondition Failed.

      Error: 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
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  500:
    description: >
      Internal Server Error
      If there is an application error not related to the client's input
      that cannot be easily mapped to any other HTTP response code
      ("catch all error"), the API producer shall respond withthis
      response code. The ProblemDetails structure shall be provided,
      and shall include in the "detail" attribute more information about
      the source of the problem.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
  503:
    description: >
      Service Unavailable
      If the API producer encounters an internal overload situation of
      itself or of a system it relies on, it should respond with this
      response code, following the provisions in IETF RFC 7231 [13] for
      the use of the Retry-After HTTP header and for the alternative
      to refuse the connection. The "ProblemDetails" structure may be omitted.
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
    schema:
      $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"