Safe Haskell	None
Language	Haskell2010

Data.OpenApi.Internal.AesonUtils

Contents

Generic functions
Options

Synopsis

class AesonDefaultValue a where
- defaultValue :: Maybe a
sopSwaggerGenericToJSON :: forall a xs. (HasDatatypeInfo a, HasSwaggerAesonOptions a, All2 ToJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => a -> Value
sopSwaggerGenericToEncoding :: forall a xs. (HasDatatypeInfo a, HasSwaggerAesonOptions a, All2 ToJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => a -> Encoding
sopSwaggerGenericToJSONWithOpts :: forall a xs. (Generic a, All2 AesonDefaultValue (Code a), HasDatatypeInfo a, All2 ToJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => SwaggerAesonOptions -> a -> Value
sopSwaggerGenericParseJSON :: forall a xs. (HasDatatypeInfo a, HasSwaggerAesonOptions a, All2 FromJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => Value -> Parser a
class (Generic a, All2 AesonDefaultValue (Code a)) => HasSwaggerAesonOptions a where
- swaggerAesonOptions :: Proxy a -> SwaggerAesonOptions
- aesonDefaults :: Proxy a -> POP Maybe (Code a)
data SwaggerAesonOptions
mkSwaggerAesonOptions :: String -> SwaggerAesonOptions
saoPrefix :: Lens' SwaggerAesonOptions String
saoAdditionalPairs :: Lens' SwaggerAesonOptions [Pair]
saoSubObject :: Lens' SwaggerAesonOptions (Maybe String)

Generic functions

class AesonDefaultValue a where Source #

Minimal complete definition

Nothing

Methods

defaultValue :: Maybe a Source #

Instances

Instances details

AesonDefaultValue Text Source #
Instance details Defined in Data.OpenApi.Internal.AesonUtils Methods defaultValue :: Maybe Text Source #
AesonDefaultValue SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe SecurityDefinitions Source #
AesonDefaultValue SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe SecuritySchemeType Source #
AesonDefaultValue OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2AuthorizationCodeFlow Source #
AesonDefaultValue OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2ClientCredentialsFlow Source #
AesonDefaultValue OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2PasswordFlow Source #
AesonDefaultValue OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2ImplicitFlow Source #
AesonDefaultValue Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Responses Source #
AesonDefaultValue ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe ParamLocation Source #
AesonDefaultValue OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OpenApiType Source #
AesonDefaultValue Link Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Link Source #
AesonDefaultValue MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe MimeList Source #
AesonDefaultValue Components Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Components Source #
AesonDefaultValue Server Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Server Source #
AesonDefaultValue Info Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Info Source #
AesonDefaultValue [a] Source #
Instance details Defined in Data.OpenApi.Internal.AesonUtils Methods defaultValue :: Maybe [a] Source #
AesonDefaultValue (Maybe a) Source #
Instance details Defined in Data.OpenApi.Internal.AesonUtils Methods defaultValue :: Maybe (Maybe a) Source #
AesonDefaultValue (Set a) Source #
Instance details Defined in Data.OpenApi.Internal.AesonUtils Methods defaultValue :: Maybe (Set a) Source #
AesonDefaultValue (InsOrdHashSet k) Source #
Instance details Defined in Data.OpenApi.Internal.AesonUtils Methods defaultValue :: Maybe (InsOrdHashSet k) Source #
AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe (OAuth2Flow p) Source #
AesonDefaultValue (InsOrdHashMap k v) Source #
Instance details Defined in Data.OpenApi.Internal.AesonUtils Methods defaultValue :: Maybe (InsOrdHashMap k v) Source #

sopSwaggerGenericToJSON :: forall a xs. (HasDatatypeInfo a, HasSwaggerAesonOptions a, All2 ToJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => a -> Value Source #

Generic serialisation for swagger records.

Features

omits nulls, empty objects and empty arrays (configurable)
possible to add fields
possible to merge sub-object

sopSwaggerGenericToEncoding :: forall a xs. (HasDatatypeInfo a, HasSwaggerAesonOptions a, All2 ToJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => a -> Encoding Source #

sopSwaggerGenericToJSONWithOpts :: forall a xs. (Generic a, All2 AesonDefaultValue (Code a), HasDatatypeInfo a, All2 ToJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => SwaggerAesonOptions -> a -> Value Source #

TODO:* This is only used by ToJSON (ParamSchema SwaggerKindSchema)

Also uses default aesonDefaults

sopSwaggerGenericParseJSON :: forall a xs. (HasDatatypeInfo a, HasSwaggerAesonOptions a, All2 FromJSON (Code a), All2 Eq (Code a), Code a ~ '[xs]) => Value -> Parser a Source #

Options

class (Generic a, All2 AesonDefaultValue (Code a)) => HasSwaggerAesonOptions a where Source #

Minimal complete definition

swaggerAesonOptions

Methods

swaggerAesonOptions :: Proxy a -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy a -> POP Maybe (Code a) Source #

Instances

Instances details

HasSwaggerAesonOptions SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy SecurityScheme -> SwaggerAesonOptions Source # aesonDefaults :: Proxy SecurityScheme -> POP Maybe (Code SecurityScheme) Source #
HasSwaggerAesonOptions OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy OAuth2Flows -> SwaggerAesonOptions Source # aesonDefaults :: Proxy OAuth2Flows -> POP Maybe (Code OAuth2Flows) Source #
HasSwaggerAesonOptions Header Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Header -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Header -> POP Maybe (Code Header) Source #
HasSwaggerAesonOptions Response Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Response -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Response -> POP Maybe (Code Response) Source #
HasSwaggerAesonOptions Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Responses -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Responses -> POP Maybe (Code Responses) Source #
HasSwaggerAesonOptions Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Schema -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Schema -> POP Maybe (Code Schema) Source #
HasSwaggerAesonOptions Link Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Link -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Link -> POP Maybe (Code Link) Source #
HasSwaggerAesonOptions Example Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Example -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Example -> POP Maybe (Code Example) Source #
HasSwaggerAesonOptions Param Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Param -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Param -> POP Maybe (Code Param) Source #
HasSwaggerAesonOptions Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Encoding -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Encoding -> POP Maybe (Code Encoding) Source #
HasSwaggerAesonOptions MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy MediaTypeObject -> SwaggerAesonOptions Source # aesonDefaults :: Proxy MediaTypeObject -> POP Maybe (Code MediaTypeObject) Source #
HasSwaggerAesonOptions RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy RequestBody -> SwaggerAesonOptions Source # aesonDefaults :: Proxy RequestBody -> POP Maybe (Code RequestBody) Source #
HasSwaggerAesonOptions Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Operation -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Operation -> POP Maybe (Code Operation) Source #
HasSwaggerAesonOptions PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy PathItem -> SwaggerAesonOptions Source # aesonDefaults :: Proxy PathItem -> POP Maybe (Code PathItem) Source #
HasSwaggerAesonOptions Components Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Components -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Components -> POP Maybe (Code Components) Source #
HasSwaggerAesonOptions Server Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Server -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Server -> POP Maybe (Code Server) Source #
HasSwaggerAesonOptions OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy OpenApi -> SwaggerAesonOptions Source # aesonDefaults :: Proxy OpenApi -> POP Maybe (Code OpenApi) Source #
AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy (OAuth2Flow p) -> SwaggerAesonOptions Source # aesonDefaults :: Proxy (OAuth2Flow p) -> POP Maybe (Code (OAuth2Flow p)) Source #

data SwaggerAesonOptions Source #

mkSwaggerAesonOptions Source #

Arguments

:: String	prefix
-> SwaggerAesonOptions

saoPrefix :: Lens' SwaggerAesonOptions String Source #

saoAdditionalPairs :: Lens' SwaggerAesonOptions [Pair] Source #

saoSubObject :: Lens' SwaggerAesonOptions (Maybe String) Source #