OpenApiSpex.Cast.Error (open_api_spex v3.21.3)

View Source

OpenApiSpex Cast Error

Summary

Types

all_of_error()

@type all_of_error() :: {:all_of, [String.t()]}

any_of_error()

@type any_of_error() :: {:any_of, [String.t()]}

args()

custom_error()

@type custom_error() :: {:custom, String.t()}

exclusive_max_error()

@type exclusive_max_error() :: {:exclusive_max, non_neg_integer(), non_neg_integer()}

exclusive_min_error()

@type exclusive_min_error() :: {:exclusive_min, non_neg_integer(), non_neg_integer()}

invalid_discriminator_value_error()

@type invalid_discriminator_value_error() ::
  {:invalid_discriminator_value, String.t() | atom()}

invalid_enum_error()

@type invalid_enum_error() :: {:invalid_enum}

invalid_format_error()

@type invalid_format_error() :: {:invalid_format, any()}

invalid_header_error()

@type invalid_header_error() :: {:invalid_header, String.t() | atom()}

invalid_schema_error()

@type invalid_schema_error() :: {:invalid_schema_type}

invalid_type_error()

@type invalid_type_error() :: {:invalid_type, String.t() | atom()}

max_items_error()

@type max_items_error() :: {:max_items, non_neg_integer(), non_neg_integer()}

max_length_error()

@type max_length_error() :: {:max_length, non_neg_integer()}

max_properties_error()

@type max_properties_error() ::
  {:max_properties, non_neg_integer(), non_neg_integer()}

maximum_error()

@type maximum_error() :: {:maximum, integer() | float(), integer() | float()}

min_items_error()

@type min_items_error() :: {:min_items, non_neg_integer(), non_neg_integer()}

min_length_error()

@type min_length_error() :: {:min_length, non_neg_integer()}

min_properties_error()

@type min_properties_error() ::
  {:min_properties, non_neg_integer(), non_neg_integer()}

minimum_error()

@type minimum_error() :: {:minimum, integer() | float(), integer() | float()}

missing_field_error()

@type missing_field_error() :: {:missing_field, String.t() | atom()}

missing_header_error()

@type missing_header_error() :: {:missing_header, String.t() | atom()}

multiple_of_error()

@type multiple_of_error() :: {:multiple_of, non_neg_integer(), non_neg_integer()}

no_value_for_discriminator_error()

@type no_value_for_discriminator_error() ::
  {:no_value_for_discriminator, String.t() | atom()}

null_value_error()

@type null_value_error() :: {:null_value}

one_of_error()

@type one_of_error() :: {:one_of, [String.t()]}

reason()

@type reason() ::
  :all_of
  | :any_of
  | :invalid_schema_type
  | :exclusive_max
  | :exclusive_min
  | :invalid_discriminator_value
  | :invalid_enum
  | :invalid_format
  | :invalid_type
  | :max_items
  | :max_length
  | :max_properties
  | :maximum
  | :min_items
  | :min_length
  | :minimum
  | :missing_field
  | :missing_header
  | :invalid_header
  | :multiple_of
  | :no_value_for_discriminator
  | :null_value
  | :one_of
  | :unexpected_field
  | :unique_items
  | :custom

t()

@type t() :: %OpenApiSpex.Cast.Error{
  format: String.t(),
  length: non_neg_integer(),
  meta: map(),
  name: String.t(),
  path: [String.t()],
  reason: reason(),
  type: term(),
  value: any()
}

unexpected_field_error()

@type unexpected_field_error() :: {:unexpected_field, String.t() | atom()}

unique_items_error()

@type unique_items_error() :: {:unique_items}

Functions

message(error)

@spec message(t()) :: String.t()

message_with_path(error)

new(ctx, arg)

@spec new(map(), args()) :: %OpenApiSpex.Cast.Error{
  format: term(),
  length: term(),
  meta: term(),
  name: term(),
  path: term(),
  reason: term(),
  type: term(),
  value: term()
}

path_to_string(error)