Safe Haskell	None
Language	Haskell2010

Jordan.OpenAPI.Internal

Synopsis

newtype ConstDeclare env r a = ConstDeclare {
- runConstDeclare :: Declare env r
}
newtype ObjectSchema a = ObjectSchema {
- getObjectSchema :: Declare (Definitions Schema) Schema
}
newtype TupleSchema a = TupleSchema {
- getTupleSchema :: Declare (Definitions Schema) [Referenced Schema]
}
newtype JSONSchema a = JSONSchema {
- getJSONSchema :: Declare (Definitions Schema) NamedSchema
}
combineSchemas :: Referenced Schema -> Referenced Schema -> Schema
getJSONRef :: forall a. FromJSON a => Proxy a -> Declare (Definitions Schema) (Referenced Schema)
getRefDef :: Declare (Definitions Schema) NamedSchema -> Declare (Definitions Schema) (Referenced Schema)
onlyUnnamed :: Schema -> JSONSchema a
getFromNamed :: forall a. FromJSON a => Proxy a -> Declare (Definitions Schema) NamedSchema
getToNamed :: forall a. ToJSON a => Proxy a -> Declare (Definitions Schema) NamedSchema

Documentation

newtype ConstDeclare env r a Source #

Constructors

ConstDeclare
Fields runConstDeclare :: Declare env r

Instances

Instances details

Functor (ConstDeclare env r) Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods fmap :: (a -> b) -> ConstDeclare env r a -> ConstDeclare env r b # (<$) :: a -> ConstDeclare env r b -> ConstDeclare env r a #
(Monoid r, Monoid env) => Applicative (ConstDeclare env r) Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods pure :: a -> ConstDeclare env r a # (<>) :: ConstDeclare env r (a -> b) -> ConstDeclare env r a -> ConstDeclare env r b # liftA2 :: (a -> b -> c) -> ConstDeclare env r a -> ConstDeclare env r b -> ConstDeclare env r c # (>) :: ConstDeclare env r a -> ConstDeclare env r b -> ConstDeclare env r b # (<*) :: ConstDeclare env r a -> ConstDeclare env r b -> ConstDeclare env r a #
Contravariant (ConstDeclare env r) Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods contramap :: (a -> b) -> ConstDeclare env r b -> ConstDeclare env r a # (>$) :: b -> ConstDeclare env r b -> ConstDeclare env r a #
(Monoid r, Monoid env) => Divisible (ConstDeclare env r) Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods divide :: (a -> (b, c)) -> ConstDeclare env r b -> ConstDeclare env r c -> ConstDeclare env r a # conquer :: ConstDeclare env r a #

newtype ObjectSchema a Source #

Constructors

ObjectSchema
Fields getObjectSchema :: Declare (Definitions Schema) Schema

Instances

Instances details

Functor ObjectSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods fmap :: (a -> b) -> ObjectSchema a -> ObjectSchema b # (<$) :: a -> ObjectSchema b -> ObjectSchema a #
Applicative ObjectSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods pure :: a -> ObjectSchema a # (<>) :: ObjectSchema (a -> b) -> ObjectSchema a -> ObjectSchema b # liftA2 :: (a -> b -> c) -> ObjectSchema a -> ObjectSchema b -> ObjectSchema c # (>) :: ObjectSchema a -> ObjectSchema b -> ObjectSchema b # (<*) :: ObjectSchema a -> ObjectSchema b -> ObjectSchema a #
Contravariant ObjectSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods contramap :: (a -> b) -> ObjectSchema b -> ObjectSchema a # (>$) :: b -> ObjectSchema b -> ObjectSchema a #
Divisible ObjectSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods divide :: (a -> (b, c)) -> ObjectSchema b -> ObjectSchema c -> ObjectSchema a # conquer :: ObjectSchema a #
JSONObjectParser ObjectSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods parseFieldWith :: Text -> (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> ObjectSchema a parseField :: FromJSON v => Text -> ObjectSchema v
JSONObjectSerializer ObjectSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods writeField :: Text -> (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> ObjectSchema a

newtype TupleSchema a Source #

Constructors

TupleSchema
Fields getTupleSchema :: Declare (Definitions Schema) [Referenced Schema]

Instances

Instances details

Functor TupleSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods fmap :: (a -> b) -> TupleSchema a -> TupleSchema b # (<$) :: a -> TupleSchema b -> TupleSchema a #
Applicative TupleSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods pure :: a -> TupleSchema a # (<>) :: TupleSchema (a -> b) -> TupleSchema a -> TupleSchema b # liftA2 :: (a -> b -> c) -> TupleSchema a -> TupleSchema b -> TupleSchema c # (>) :: TupleSchema a -> TupleSchema b -> TupleSchema b # (<*) :: TupleSchema a -> TupleSchema b -> TupleSchema a #
Contravariant TupleSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods contramap :: (a -> b) -> TupleSchema b -> TupleSchema a # (>$) :: b -> TupleSchema b -> TupleSchema a #
Divisible TupleSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods divide :: (a -> (b, c)) -> TupleSchema b -> TupleSchema c -> TupleSchema a # conquer :: TupleSchema a #
JSONTupleParser TupleSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods consumeItemWith :: (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> TupleSchema a consumeItem :: FromJSON v => TupleSchema v
JSONTupleSerializer TupleSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods writeItem :: (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> TupleSchema a

newtype JSONSchema a Source #

Constructors

JSONSchema
Fields getJSONSchema :: Declare (Definitions Schema) NamedSchema

Instances

Instances details

Functor JSONSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods fmap :: (a -> b) -> JSONSchema a -> JSONSchema b # (<$) :: a -> JSONSchema b -> JSONSchema a #
Contravariant JSONSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods contramap :: (a -> b) -> JSONSchema b -> JSONSchema a # (>$) :: b -> JSONSchema b -> JSONSchema a #
JSONParser JSONSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods parseObject :: Text -> (forall (objectParser :: Type -> Type). JSONObjectParser objectParser => objectParser a) -> JSONSchema a parseObjectStrict :: Text -> (forall (objectParser :: Type -> Type). JSONObjectParser objectParser => objectParser a) -> JSONSchema a parseDictionary :: (forall (jsonParser :: Type -> Type). JSONParser jsonParser => jsonParser a) -> JSONSchema [(Text, a)] parseText :: JSONSchema Text parseTextConstant :: Text -> JSONSchema () parseTuple :: (forall (arrayParser :: Type -> Type). JSONTupleParser arrayParser => arrayParser o) -> JSONSchema o parseArray :: FromJSON a => JSONSchema [a] parseArrayWith :: (forall (jsonParser :: Type -> Type). JSONParser jsonParser => jsonParser a) -> JSONSchema [a] parseNumber :: JSONSchema Scientific parseNull :: JSONSchema () parseBool :: JSONSchema Bool validateJSON :: JSONSchema (Either Text a) -> JSONSchema a
JSONSerializer JSONSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods serializeObject :: Text -> (forall (objSerializer :: Type -> Type). JSONObjectSerializer objSerializer => objSerializer a) -> JSONSchema a serializeDictionary :: Foldable t => (forall (jsonSerializer :: Type -> Type). JSONSerializer jsonSerializer => jsonSerializer a) -> JSONSchema (t (Text, a)) serializeText :: JSONSchema Text serializeTextConstant :: Text -> JSONSchema a serializeNull :: JSONSchema any serializeNumber :: JSONSchema Scientific serializeBool :: JSONSchema Bool serializeTuple :: (forall (tupleSerializer :: Type -> Type). JSONTupleSerializer tupleSerializer => tupleSerializer a) -> JSONSchema a serializeArray :: ToJSON a => JSONSchema [a]
Selectable JSONSchema Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods giveUp :: (arg -> Void) -> JSONSchema arg select :: (arg -> Either lhs rhs) -> JSONSchema lhs -> JSONSchema rhs -> JSONSchema arg
Semigroup (JSONSchema a) Source #
Instance details Defined in Jordan.OpenAPI.Internal Methods (<>) :: JSONSchema a -> JSONSchema a -> JSONSchema a # sconcat :: NonEmpty (JSONSchema a) -> JSONSchema a # stimes :: Integral b => b -> JSONSchema a -> JSONSchema a #
Monoid (JSONSchema a) Source #	Empty instance: must be both a boolean and a text value, which is not possible (obviously!)
Instance details Defined in Jordan.OpenAPI.Internal Methods mempty :: JSONSchema a # mappend :: JSONSchema a -> JSONSchema a -> JSONSchema a # mconcat :: [JSONSchema a] -> JSONSchema a #

combineSchemas :: Referenced Schema -> Referenced Schema -> Schema Source #

getJSONRef :: forall a. FromJSON a => Proxy a -> Declare (Definitions Schema) (Referenced Schema) Source #

getRefDef :: Declare (Definitions Schema) NamedSchema -> Declare (Definitions Schema) (Referenced Schema) Source #

onlyUnnamed :: Schema -> JSONSchema a Source #

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

Get documentation for a type that implements FromJSON

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

Get documentation for a type that implements ToJSON