OpenApiSpex.JsonErrorResponse (open_api_spex v3.10.0) View Source

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.JsonApiErrorResponse}
     }

Link to this section Summary

Types

t()

Functions

response()

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

schema()

Callback implementation for OpenApiSpex.Schema.schema/0.

Link to this section Types

t()

Specs

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

Link to this section Functions

response()

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

Examples

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

schema()

Callback implementation for OpenApiSpex.Schema.schema/0.