openapi3-3.2.4: OpenAPI 3.0 data model
Safe HaskellSafe-Inferred
LanguageHaskell2010

Data.OpenApi.Internal.AesonUtils

Synopsis

Generic functions

class AesonDefaultValue a where Source #

Minimal complete definition

Nothing

Methods

defaultValue :: Maybe a Source #

Instances

Instances details
AesonDefaultValue Version Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Version Source #

AesonDefaultValue Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Components Source #

AesonDefaultValue Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Info 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 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 OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OAuth2ImplicitFlow Source #

AesonDefaultValue OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OAuth2PasswordFlow Source #

AesonDefaultValue OpenApiSpecVersion Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OpenApiSpecVersion Source #

AesonDefaultValue OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OpenApiType Source #

AesonDefaultValue ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe ParamLocation Source #

AesonDefaultValue Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Responses 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 Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Server Source #

AesonDefaultValue Text Source # 
Instance details

Defined in Data.OpenApi.Internal.AesonUtils

Methods

defaultValue :: Maybe Text 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 (Maybe a) Source # 
Instance details

Defined in Data.OpenApi.Internal.AesonUtils

Methods

defaultValue :: Maybe (Maybe a) Source #

AesonDefaultValue [a] Source # 
Instance details

Defined in Data.OpenApi.Internal.AesonUtils

Methods

defaultValue :: Maybe [a] 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 Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Components -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy Components -> POP Maybe (Code Components) 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 Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Example -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy Example -> POP Maybe (Code Example) 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 Link Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Link -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy Link -> POP Maybe (Code Link) 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 OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy OAuth2Flows -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy OAuth2Flows -> POP Maybe (Code OAuth2Flows) 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 #

HasSwaggerAesonOptions OpenApiSpecVersion Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy OpenApiSpecVersion -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy OpenApiSpecVersion -> POP Maybe (Code OpenApiSpecVersion) 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 Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Param -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy Param -> POP Maybe (Code Param) 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 RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy RequestBody -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy RequestBody -> POP Maybe (Code RequestBody) 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 SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy SecurityScheme -> SwaggerAesonOptions Source #

aesonDefaults :: Proxy SecurityScheme -> POP Maybe (Code SecurityScheme) 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 #

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 #