Class ErrorDetail

Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.

Constructors

constructor

Properties

_in? code? context? message subCategory? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optional_in

_in?: string

The name of the field or parameter in which the error was found.

Optionalcode

code?: string

The status code associated with the error detail

Optionalcontext

context?: {
    [key: string]: string[];
}

Context about the error condition

message

message: string

A human readable message describing the error along with remediation steps where appropriate

OptionalsubCategory

subCategory?: string

A specific category that contains more specific detail about the error

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods