swagger2-2.3.0.1: Swagger 2.0 data model

Safe HaskellNone
LanguageHaskell2010

Data.Swagger.Internal.AesonUtils

Contents

Synopsis

Generic functions

class AesonDefaultValue a where Source #

Methods

defaultValue :: Maybe a Source #

Instances
AesonDefaultValue Text Source # 
Instance details

Defined in Data.Swagger.Internal.AesonUtils

Methods

defaultValue :: Maybe Text Source #

AesonDefaultValue SecuritySchemeType Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe SecuritySchemeType Source #

AesonDefaultValue OAuth2Flow Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe OAuth2Flow Source #

AesonDefaultValue Responses Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe Responses Source #

AesonDefaultValue ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe ParamLocation Source #

AesonDefaultValue ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe ParamAnySchema Source #

AesonDefaultValue MimeList Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe MimeList Source #

AesonDefaultValue Info Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe Info Source #

AesonDefaultValue [a] Source # 
Instance details

Defined in Data.Swagger.Internal.AesonUtils

Methods

defaultValue :: Maybe [a] Source #

AesonDefaultValue (Maybe a) Source # 
Instance details

Defined in Data.Swagger.Internal.AesonUtils

Methods

defaultValue :: Maybe (Maybe a) Source #

AesonDefaultValue (Set a) Source # 
Instance details

Defined in Data.Swagger.Internal.AesonUtils

Methods

defaultValue :: Maybe (Set a) Source #

AesonDefaultValue (ParamSchema s) Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe (ParamSchema s) Source #

AesonDefaultValue (SwaggerType a) Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

defaultValue :: Maybe (SwaggerType a) Source #

AesonDefaultValue (InsOrdHashMap k v) Source # 
Instance details

Defined in Data.Swagger.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
HasSwaggerAesonOptions SecurityScheme Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy SecurityScheme -> SwaggerAesonOptions Source #

aesonDefaults :: proxy SecurityScheme -> POP Maybe (Code SecurityScheme) Source #

HasSwaggerAesonOptions OAuth2Params Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy OAuth2Params -> SwaggerAesonOptions Source #

aesonDefaults :: proxy OAuth2Params -> POP Maybe (Code OAuth2Params) Source #

HasSwaggerAesonOptions Header Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Header -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Header -> POP Maybe (Code Header) Source #

HasSwaggerAesonOptions Response Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Response -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Response -> POP Maybe (Code Response) Source #

HasSwaggerAesonOptions Responses Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Responses -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Responses -> POP Maybe (Code Responses) Source #

HasSwaggerAesonOptions Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Schema -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Schema -> POP Maybe (Code Schema) Source #

HasSwaggerAesonOptions ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy ParamOtherSchema -> SwaggerAesonOptions Source #

aesonDefaults :: proxy ParamOtherSchema -> POP Maybe (Code ParamOtherSchema) Source #

HasSwaggerAesonOptions Param Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Param -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Param -> POP Maybe (Code Param) Source #

HasSwaggerAesonOptions Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Operation -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Operation -> POP Maybe (Code Operation) Source #

HasSwaggerAesonOptions PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy PathItem -> SwaggerAesonOptions Source #

aesonDefaults :: proxy PathItem -> POP Maybe (Code PathItem) Source #

HasSwaggerAesonOptions Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy Swagger -> SwaggerAesonOptions Source #

aesonDefaults :: proxy Swagger -> POP Maybe (Code Swagger) Source #

HasSwaggerAesonOptions (ParamSchema (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy (ParamSchema (SwaggerKindNormal t)) -> SwaggerAesonOptions Source #

aesonDefaults :: proxy (ParamSchema (SwaggerKindNormal t)) -> POP Maybe (Code (ParamSchema (SwaggerKindNormal t))) Source #

HasSwaggerAesonOptions (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind *)) Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy (ParamSchema SwaggerKindParamOtherSchema) -> SwaggerAesonOptions Source #

aesonDefaults :: proxy (ParamSchema SwaggerKindParamOtherSchema) -> POP Maybe (Code (ParamSchema SwaggerKindParamOtherSchema)) Source #

HasSwaggerAesonOptions (ParamSchema (SwaggerKindSchema :: SwaggerKind *)) Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

swaggerAesonOptions :: proxy (ParamSchema SwaggerKindSchema) -> SwaggerAesonOptions Source #

aesonDefaults :: proxy (ParamSchema SwaggerKindSchema) -> POP Maybe (Code (ParamSchema SwaggerKindSchema)) Source #

data SwaggerAesonOptions Source #

mkSwaggerAesonOptions Source #

Arguments

:: String

prefix

-> SwaggerAesonOptions 

saoPrefix :: Lens' SwaggerAesonOptions String Source #

saoAdditionalPairs :: Lens' SwaggerAesonOptions [(Text, Value)] Source #

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