Struct ErrorResponse

pub struct ErrorResponse {
    pub error: ErrorResponseError,
}

An error response from the API. More info here

JSON schema

{
 "description": "An error response from the API. More info [here]('/docs/api-reference/errors')",
 "type": "object",
 "required": [
   "error"
 ],
 "properties": {
   "error": {
     "type": "object",
     "required": [
       "message"
     ],
     "properties": {
       "message": {
         "description": "A human-readable message providing more details about the error.",
         "examples": [
           "Parameter error."
         ],
         "type": "string"
       },
       "params": {
         "description": "The specific request parameters associated with the error. May be omitted if the error message is generic enough to apply to multiple parameters.",
         "type": "array",
         "items": {
           "type": "object",
           "properties": {
             "message": {
               "description": "A human-readable message providing more details about the error.",
               "examples": [
                 "Name is required."
               ],
               "type": "string"
             },
             "param": {
               "description": "The parameter related to the error.",
               "examples": [
                 "name"
               ],
               "type": "string"
             }
           }
         }
       },
       "type": {
         "description": "The type of error returned.",
         "default": "invalid_request_error",
         "type": "string",
         "enum": [
           "invalid_request_error",
           "not_found_error",
           "creation_error",
           "update_error",
           "deletion_error",
           "forbidden_error",
           "authentication_error",
           "conflict_error"
         ]
       }
     }
   }
 }
}

Fields

error: ErrorResponseError

Implementations

impl ErrorResponse

pub fn builder() -> ErrorResponse

Trait Implementations

impl Clone for ErrorResponse

fn clone(&self) -> ErrorResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ErrorResponse> for ErrorResponse

fn from(value: &ErrorResponse) -> Self

Converts to this type from the input type.

impl From<ErrorResponse> for ErrorResponse

fn from(value: ErrorResponse) -> Self

Converts to this type from the input type.

impl JsonSchema for ErrorResponse

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ErrorResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ErrorResponse> for ErrorResponse

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: ErrorResponse) -> Result<Self, ConversionError>

Performs the conversion.