MEC029_FAI.yaml 78.1 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
Elian Kraja's avatar
Elian Kraja committed
  responses:
    "204":
Elian Kraja's avatar
Elian Kraja committed
      description: No Content
    "206":
      description: Partial content
    "400":
      description: "Bad Request : used to indicate that incorrect parameters were passed to the request."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "401":
      description: "Unauthorized :  used when the client did not submit credentials."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "403":
      description: "Forbidden :  operation is not allowed given the current status of the resource."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "404":
      description: "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "406":
      description: "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "409":
      description: "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource"
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "412":
      description: "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT"
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "415":
      description: "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "422":
      description: "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
    "429":
      description: "Too Many Requests : used when a rate limiter has triggered."
Elian Kraja's avatar
Elian Kraja committed
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ProblemDetails"