Struct ApiErrorBody 

pub struct ApiErrorBody {
    pub error: String,
    pub resource: Option<String>,
}

Wire representation of an API error body, serialised as JSON.

All REST endpoints that can fail return this structure as their error payload. The resource field is omitted from the JSON output when it is not applicable (null would be misleading for non-resource errors).

Fields

error: String

Short, machine-friendly slug describing the error category.

resource: Option<String>

Resource name when the error is scoped to a single resource.

Absent from the serialised output when None (controlled by #[serde(skip_serializing_if)]).

Trait Implementations

impl Debug for ApiErrorBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for ApiErrorBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.