Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 15.1 KB

deleteconnectionapiproblem.md

File metadata and controls

43 lines (35 loc) · 15.1 KB

DeleteConnectionAPIProblem

A Problem Details object (RFC 9457).

Additional properties specific to the problem type may be present.

Example Usage

import { DeleteConnectionAPIProblem } from "@amp-labs/sdk-node/models/operations";

let value: DeleteConnectionAPIProblem = {
  href:
    "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  title: "Description of the type of problem that occurred",
  status: 400,
  detail: "Description of specific occurrence of the problem",
  instance: "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
};

Fields

Field Type Required Description Example
type string ➖ An absolute URI that identifies the problem type
href string ➖ An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).
title string ➖ A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized). Service Unavailable
status number ➖ The HTTP status code generated by the origin server for this occurrence of the problem. 503
detail string ➖ A human-readable explanation specific to this occurrence of the problem
instance string ➖ An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
subsystem string ➖ The subsystem that generated the problem api
time Date ➖ The time the problem occurred, formatted as RFC-3339 2024-04-22T18:55:28.456076Z
requestId string ➖ A unique identifier for the request, useful for debugging 89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715
causes string[] ➖ A list of problems that caused this problem. This can be used to represent multiple
root causes. There is no guaranteed ordering of the causes.
 [
"database connection failed",
"database query failed",
"unable to fetch user"
]
remedy string ➖ A brief description of how to resolve the problem Shorten your input to be under 100 characters
supportEmail string ➖ An email address to contact for support [email protected]
supportPhone string ➖ A phone number to contact for support +1-555-555-5555
supportUrl string ➖ A URL to contact for support https://withampersand.com/support
retryable boolean ➖ Whether the request can be retried false
retryAfter Date ➖ A timestamp after which the request can be retried, formatted as RFC-3339 2024-04-22T18:55:28.456076Z
context Record<string, any> ➖ Additional context for the problem {
"name": "Rick Sanchez"
}