Moduleopenapi3-3.2.5Haskell2010

Data.OpenApi.Internal.AesonUtils

Contents

Generic functions
Options

Synopsis

class AesonDefaultValue
value sopSwaggerGenericToJSON
value sopSwaggerGenericToEncoding
value sopSwaggerGenericToJSONWithOpts
value sopSwaggerGenericParseJSON
class HasSwaggerAesonOptions
data SwaggerAesonOptions
value mkSwaggerAesonOptions
value saoPrefix
value saoAdditionalPairs
value saoSubObject

Packageopenapi3-3.2.5
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAesonUtils.hs

Generic functions

classclass AesonDefaultValue a where

Methods

defaultValue :: Maybe a

Instances23AesonDefaultValue, …

AesonDefaultValue VersionDefined in openapi3-3.2.5 · Data.OpenApi.Internal · orphan
AesonDefaultValue ComponentsDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue InfoDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue LinkDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue MimeListDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue OAuth2AuthorizationCodeFlowDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue OAuth2ClientCredentialsFlowDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue OAuth2ImplicitFlowDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue OAuth2PasswordFlowDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue OpenApiSpecVersionDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue OpenApiTypeDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue ParamLocationDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue ResponsesDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue SecurityDefinitionsDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue SecuritySchemeTypeDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue ServerDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue TextDefined in openapi3-3.2.5 · Data.OpenApi.Internal.AesonUtils
AesonDefaultValue (Set a)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.AesonUtils
AesonDefaultValue (Maybe a)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.AesonUtils
AesonDefaultValue (InsOrdHashSet k)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.AesonUtils
AesonDefaultValue [a]Defined in openapi3-3.2.5 · Data.OpenApi.Internal.AesonUtils
AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)Defined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue (InsOrdHashMap k v)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.AesonUtils

valuesopSwaggerGenericToJSON

:: (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

valuesopSwaggerGenericToEncoding

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

valuesopSwaggerGenericToJSONWithOpts

:: (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

valuesopSwaggerGenericParseJSON

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

Options

classclass (Generic a, All2 AesonDefaultValue (Code a)) => HasSwaggerAesonOptions a where

Methods

swaggerAesonOptions :: Proxy a -> SwaggerAesonOptions
aesonDefaults :: Proxy a -> POP Maybe (Code a)

Instances19HasSwaggerAesonOptions, …

HasSwaggerAesonOptions ComponentsDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions EncodingDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions ExampleDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions HeaderDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions LinkDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions MediaTypeObjectDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions OAuth2FlowsDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions OpenApiDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions OpenApiSpecVersionDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions OperationDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions ParamDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions PathItemDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions RequestBodyDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions ResponseDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions ResponsesDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions SchemaDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions SecuritySchemeDefined in openapi3-3.2.5 · Data.OpenApi.Internal
HasSwaggerAesonOptions ServerDefined in openapi3-3.2.5 · Data.OpenApi.Internal
AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p)Defined in openapi3-3.2.5 · Data.OpenApi.Internal

datadata SwaggerAesonOptions

valuemkSwaggerAesonOptions

:: String
prefix
-> SwaggerAesonOptions

valuesaoPrefix :: Lens' SwaggerAesonOptions String

valuesaoAdditionalPairs :: Lens' SwaggerAesonOptions [Pair]

valuesaoSubObject :: Lens' SwaggerAesonOptions (Maybe String)