Composite.Swagger.TH

Documentation

makeToSchema :: String -> Name -> Q [Dec]

TH splice which makes it more convenient to define ToSchema instance for Record types.

For example:

  type MyRecord = '[FFoo, FBar]
  newtype MyRecordWrapper = MyRecordWrapper { unMyRecordWrapper :: Record MyRecord }
  makeToSchema MyRecordWrapper ''MyRecordWrapper

is equivalent to:

  instance ToSchema MyRecordWrapper where
    declareNamedSchema = wrappedSchema (Proxy :: Proxy MyRecordWrapper) MyRecordWrapper

makeToSchemaWrapper :: String -> Name -> Q [Dec]

TH splice which makes it more convenient to define ToSchema instance for Record types.

For example:

  type MyRecord = '[FFoo, FBar]
  makeToSchemaWrapper MyRecordWrapper ''MyRecord

is equivalent to:

  newtype MyRecordWrapper = MyRecordWrapper { unMyRecordWrapper :: Record MyRecord }
  instance ToSchema MyRecordWrapper where
    declareNamedSchema = wrappedSchema (Proxy :: Proxy MyRecordWrapper) MyRecordWrapper