Skip to content

warnings.md

Latest commit

 

History

History
25 lines (19 loc) · 3.07 KB

warnings.md

File metadata and controls

25 lines (19 loc) · 3.07 KB
Raw

Warnings

Advisory warning emitted when an optional workflow step fails non-fatally. The overall request still succeeds (HTTP 200); inspect this to detect partial or degraded data.

Example Usage

import { Warnings } from "@apideck/unify/models/components";

let value: Warnings = {
  type: "downstream_request_failed",
  statusCode: 429,
  operation: "getManager",
};

Fields

Field Type Required Description Example
type string ➖ Discriminator for the warning kind. downstream_request_failed
statusCode number ➖ HTTP status code returned by the failed downstream request, when available. 429
error string ➖ Short error description from the downstream provider, when available.
operation string ➖ Identifier of the workflow step that failed. getManager
message string ➖ Detailed message from the downstream provider, when available.