OpenApiSpex.JsonErrorResponse (open_api_spex v3.21.3)

Schema for the default error renderer used by OpenApiSpex.Plug.CastAndValidate.

Examples

@doc responses: %{
       201 => {"User", "application/json", UserResponse}
       422 => {"Unprocessable Entity", "application/json", OpenApiSpex.JsonErrorResponse}
     }

Summary

Types

t()

Functions

response()

Convenience function to return that wraps JsonErrorResponse in an Operation response.

schema()

Callback implementation for OpenApiSpex.Schema.schema/0.

Types

t()

@type t() :: %OpenApiSpex.JsonErrorResponse{errors: term()}

Functions

response()

Convenience function to return that wraps JsonErrorResponse in an Operation response.

Examples

@doc responses: %{
       201 => {"User", "application/json", UserResponse}
       422 => OpenApiSpex.JsonErrorResponse.response()
     }

schema()

Callback implementation for OpenApiSpex.Schema.schema/0.