Jordan.OpenAPI

Documenting FromJSON Schemas

getFromNamed :: forall a. FromJSON a => Proxy a -> Declare (Definitions Schema) NamedSchema

Get documentation for a type that implements FromJSON, in the Declare environment.

This will be inline documention, IE, it will be named but not stored in the schema definitions.

getToNamed :: forall a. ToJSON a => Proxy a -> Declare (Definitions Schema) NamedSchema

Get documentation for a type that implements ToJSON.

This will be inline documentation, IE, it will be named but not stored in the schema definitions.

Documenting ToJSON schemas

getFromRef :: forall a. FromJSON a => Proxy a -> Declare (Definitions Schema) (Referenced Schema)

Get documention for a type that implements FromJSON.

This will store the type in the schemas key of the schema definitions, and give back a reference to it.

getToRef :: forall a. ToJSON a => Proxy a -> Declare (Definitions Schema) (Referenced Schema)

Get documentation for a type that implements ToJSON.

This will store the type in the schemas key of the schemas definitions, then give back a reference to it.

Newtype wrappers for DerivingVia

newtype JordanFromJSONSchema a

Newtype for use with DerivingVia.

Allows deriving ToSchema via DerivingVia, using the Jordan defintion of ToJSON.

Constructors

JordanFromJSONSchema

Fields

• getJordanFromJSONSchema :: a

Instances

FromJSON a => FromJSON (JordanFromJSONSchema a)

Defined in Jordan.OpenAPI

Methods

fromJSON :: JSONParser f => f (JordanFromJSONSchema a)

(Typeable a, FromJSON a) => ToSchema (JordanFromJSONSchema a)

Defined in Jordan.OpenAPI

Methods

declareNamedSchema :: Proxy (JordanFromJSONSchema a) -> Declare (Definitions Schema) NamedSchema

newtype JordanToJSONSchema a

Newtype for use with DerivingVia.

Allows deriving ToSchema via DerivingVia, using the Jordan defintion of ToJSON.

Constructors

JordanToJSONSchema

Fields

• getJordanToJSONSchema :: a

Instances

ToJSON a => ToJSON (JordanToJSONSchema a)

Defined in Jordan.OpenAPI

Methods

toJSON :: JSONSerializer f => f (JordanToJSONSchema a)

(Typeable a, ToJSON a) => ToSchema (JordanToJSONSchema a)

Defined in Jordan.OpenAPI

Methods

declareNamedSchema :: Proxy (JordanToJSONSchema a) -> Declare (Definitions Schema) NamedSchema