openapi3-3.1.0: OpenAPI 3.0 data model
Safe HaskellNone
LanguageHaskell2010

Data.OpenApi.Internal

Synopsis

Documentation

>>> :seti -XDataKinds
>>> import Data.Aeson
>>> import Data.ByteString.Lazy.Char8 as BSL
>>> import Data.OpenApi.Internal.Utils

type Definitions = InsOrdHashMap Text Source #

A list of definitions that can be used in references.

data OpenApi Source #

This is the root document object for the API specification.

Constructors

OpenApi 

Fields

  • _openApiInfo :: Info

    Provides metadata about the API. The metadata can be used by the clients if needed.

  • _openApiServers :: [Server]

    An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server object with a url value of /.

  • _openApiPaths :: InsOrdHashMap FilePath PathItem

    The available paths and operations for the API.

  • _openApiComponents :: Components

    An element to hold various schemas for the specification.

  • _openApiSecurity :: [SecurityRequirement]

    A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement can be included in the array.

  • _openApiTags :: InsOrdHashSet Tag

    A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.

  • _openApiExternalDocs :: Maybe ExternalDocs

    Additional external documentation.

Instances

Instances details
Eq OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: OpenApi -> OpenApi -> Bool #

(/=) :: OpenApi -> OpenApi -> Bool #

Data OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenApi -> c OpenApi #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OpenApi #

toConstr :: OpenApi -> Constr #

dataTypeOf :: OpenApi -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OpenApi) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OpenApi) #

gmapT :: (forall b. Data b => b -> b) -> OpenApi -> OpenApi #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenApi -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenApi -> r #

gmapQ :: (forall d. Data d => d -> u) -> OpenApi -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenApi -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenApi -> m OpenApi #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApi -> m OpenApi #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApi -> m OpenApi #

Show OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OpenApi :: Type -> Type #

Methods

from :: OpenApi -> Rep OpenApi x #

to :: Rep OpenApi x -> OpenApi #

Semigroup OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code OpenApi :: [[Type]] #

HasDatatypeInfo OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf OpenApi :: DatatypeInfo #

HasSwaggerAesonOptions OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

HasInfo OpenApi Info Source # 
Instance details

Defined in Data.OpenApi.Lens

HasComponents OpenApi Components Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Components, b ~ Components) => LabelOptic "components" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Info, b ~ Info) => LabelOptic "info" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ InsOrdHashMap FilePath PathItem, b ~ InsOrdHashMap FilePath PathItem) => LabelOptic "paths" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [SecurityRequirement], b ~ [SecurityRequirement]) => LabelOptic "security" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [Server], b ~ [Server]) => LabelOptic "servers" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ InsOrdHashSet Tag, b ~ InsOrdHashSet Tag) => LabelOptic "tags" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasTags OpenApi (InsOrdHashSet Tag) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers OpenApi [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSecurity OpenApi [SecurityRequirement] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs OpenApi (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPaths OpenApi (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

type Code OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

data Info Source #

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

Constructors

Info 

Fields

Instances

Instances details
Eq Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Info -> Info -> Bool #

(/=) :: Info -> Info -> Bool #

Data Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Info -> c Info #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Info #

toConstr :: Info -> Constr #

dataTypeOf :: Info -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Info) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Info) #

gmapT :: (forall b. Data b => b -> b) -> Info -> Info #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Info -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Info -> r #

gmapQ :: (forall d. Data d => d -> u) -> Info -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Info -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Info -> m Info #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Info -> m Info #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Info -> m Info #

Show Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Info -> ShowS #

show :: Info -> String #

showList :: [Info] -> ShowS #

Generic Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Info :: Type -> Type #

Methods

from :: Info -> Rep Info x #

to :: Rep Info x -> Info #

Semigroup Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(<>) :: Info -> Info -> Info #

sconcat :: NonEmpty Info -> Info #

stimes :: Integral b => b -> Info -> Info #

Monoid Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

mempty :: Info #

mappend :: Info -> Info -> Info #

mconcat :: [Info] -> Info #

ToJSON Info Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Info Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue Info Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Info Source # 
Instance details

Defined in Data.OpenApi.Internal

HasInfo OpenApi Info Source # 
Instance details

Defined in Data.OpenApi.Lens

HasVersion Info Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTitle Info Text Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Maybe Contact, b ~ Maybe Contact) => LabelOptic "contact" k Info Info a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Info Info a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

(k ~ A_Lens, a ~ Maybe License, b ~ Maybe License) => LabelOptic "license" k Info Info a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "termsOfService" k Info Info a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "title" k Info Info a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "version" k Info Info a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

HasDescription Info (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTermsOfService Info (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Info Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Info = D1 ('MetaData "Info" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Info" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_infoTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_infoDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_infoTermsOfService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "_infoContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Contact)) :*: (S1 ('MetaSel ('Just "_infoLicense") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe License)) :*: S1 ('MetaSel ('Just "_infoVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data Contact Source #

Contact information for the exposed API.

Constructors

Contact 

Fields

Instances

Instances details
Eq Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Contact -> Contact -> Bool #

(/=) :: Contact -> Contact -> Bool #

Data Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Contact -> c Contact #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Contact #

toConstr :: Contact -> Constr #

dataTypeOf :: Contact -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Contact) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Contact) #

gmapT :: (forall b. Data b => b -> b) -> Contact -> Contact #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Contact -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Contact -> r #

gmapQ :: (forall d. Data d => d -> u) -> Contact -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Contact -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Contact -> m Contact #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Contact -> m Contact #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Contact -> m Contact #

Show Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Contact :: Type -> Type #

Methods

from :: Contact -> Rep Contact x #

to :: Rep Contact x -> Contact #

Semigroup Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "email" k Contact Contact a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k Contact Contact a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "url" k Contact Contact a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasUrl Contact (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName Contact (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEmail Contact (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Contact = D1 ('MetaData "Contact" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Contact" 'PrefixI 'True) (S1 ('MetaSel ('Just "_contactName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_contactUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)) :*: S1 ('MetaSel ('Just "_contactEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data License Source #

License information for the exposed API.

Constructors

License 

Fields

Instances

Instances details
Eq License Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: License -> License -> Bool #

(/=) :: License -> License -> Bool #

Data License Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License #

toConstr :: License -> Constr #

dataTypeOf :: License -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c License) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) #

gmapT :: (forall b. Data b => b -> b) -> License -> License #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r #

gmapQ :: (forall d. Data d => d -> u) -> License -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #

Show License Source # 
Instance details

Defined in Data.OpenApi.Internal

IsString License Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> License #

Generic License Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep License :: Type -> Type #

Methods

from :: License -> Rep License x #

to :: Rep License x -> License #

ToJSON License Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON License Source # 
Instance details

Defined in Data.OpenApi.Internal

HasName License Text Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k License License a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "url" k License License a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasUrl License (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep License Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep License = D1 ('MetaData "License" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "License" 'PrefixI 'True) (S1 ('MetaSel ('Just "_licenseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_licenseUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL))))

data Server Source #

An object representing a Server.

Constructors

Server 

Fields

  • _serverUrl :: Text

    A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.

  • _serverDescription :: Maybe Text

    An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

  • _serverVariables :: InsOrdHashMap Text ServerVariable

    A map between a variable name and its value. The value is used for substitution in the server's URL template.

Instances

Instances details
Eq Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Server -> Server -> Bool #

(/=) :: Server -> Server -> Bool #

Data Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Server -> c Server #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Server #

toConstr :: Server -> Constr #

dataTypeOf :: Server -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Server) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Server) #

gmapT :: (forall b. Data b => b -> b) -> Server -> Server #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Server -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Server -> r #

gmapQ :: (forall d. Data d => d -> u) -> Server -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Server -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Server -> m Server #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Server -> m Server #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Server -> m Server #

Show Server Source # 
Instance details

Defined in Data.OpenApi.Internal

IsString Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Server #

Generic Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Server :: Type -> Type #

Methods

from :: Server -> Rep Server x #

to :: Rep Server x -> Server #

ToJSON Server Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Server :: [[Type]] #

Methods

from :: Server -> Rep Server #

to :: Rep Server -> Server #

HasDatatypeInfo Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Server :: DatatypeInfo #

AesonDefaultValue Server Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions Server Source # 
Instance details

Defined in Data.OpenApi.Internal

HasUrl Server Text Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Server Server a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k Server Server a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ InsOrdHashMap Text ServerVariable, b ~ InsOrdHashMap Text ServerVariable) => LabelOptic "variables" k Server Server a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasServers Operation [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers PathItem [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers OpenApi [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Server (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServer Link (Maybe Server) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasVariables Server (InsOrdHashMap Text ServerVariable) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Server Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Server = D1 ('MetaData "Server" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Server" 'PrefixI 'True) (S1 ('MetaSel ('Just "_serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_serverDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_serverVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text ServerVariable)))))
type Code Server Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Server Source # 
Instance details

Defined in Data.OpenApi.Internal

data ServerVariable Source #

Constructors

ServerVariable 

Fields

Instances

Instances details
Eq ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

Data ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ServerVariable -> c ServerVariable #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ServerVariable #

toConstr :: ServerVariable -> Constr #

dataTypeOf :: ServerVariable -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ServerVariable) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ServerVariable) #

gmapT :: (forall b. Data b => b -> b) -> ServerVariable -> ServerVariable #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ServerVariable -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ServerVariable -> r #

gmapQ :: (forall d. Data d => d -> u) -> ServerVariable -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ServerVariable -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ServerVariable -> m ServerVariable #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ServerVariable -> m ServerVariable #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ServerVariable -> m ServerVariable #

Show ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep ServerVariable :: Type -> Type #

ToJSON ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "default" k ServerVariable ServerVariable a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k ServerVariable ServerVariable a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe (InsOrdHashSet Text), b ~ Maybe (InsOrdHashSet Text)) => LabelOptic "enum" k ServerVariable ServerVariable a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasVariables Server (InsOrdHashMap Text ServerVariable) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ServerVariable = D1 ('MetaData "ServerVariable" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "ServerVariable" 'PrefixI 'True) (S1 ('MetaSel ('Just "_serverVariableEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (InsOrdHashSet Text))) :*: (S1 ('MetaSel ('Just "_serverVariableDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_serverVariableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data Components Source #

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Instances

Instances details
Eq Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Components -> c Components #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Components #

toConstr :: Components -> Constr #

dataTypeOf :: Components -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Components) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Components) #

gmapT :: (forall b. Data b => b -> b) -> Components -> Components #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Components -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Components -> r #

gmapQ :: (forall d. Data d => d -> u) -> Components -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Components -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Components -> m Components #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Components -> m Components #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Components -> m Components #

Show Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Components :: Type -> Type #

Semigroup Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Components Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Components Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Components :: [[Type]] #

HasDatatypeInfo Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Components :: DatatypeInfo #

AesonDefaultValue Components Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions Components Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Components Source # 
Instance details

Defined in Data.OpenApi.Internal

HasComponents OpenApi Components Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Definitions Callback, b ~ Definitions Callback) => LabelOptic "callbacks" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions Example, b ~ Definitions Example) => LabelOptic "examples" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions Header, b ~ Definitions Header) => LabelOptic "headers" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions Link, b ~ Definitions Link) => LabelOptic "links" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions Param, b ~ Definitions Param) => LabelOptic "parameters" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions RequestBody, b ~ Definitions RequestBody) => LabelOptic "requestBodies" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions Response, b ~ Definitions Response) => LabelOptic "responses" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions Schema, b ~ Definitions Schema) => LabelOptic "schemas" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Definitions SecurityScheme, b ~ Definitions SecurityScheme) => LabelOptic "securitySchemes" k Components Components a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasSecuritySchemes Components (Definitions SecurityScheme) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSchemas Components (Definitions Schema) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasResponses Components (Definitions Response) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequestBodies Components (Definitions RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters Components (Definitions Param) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLinks Components (Definitions Link) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Components (Definitions Header) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Components (Definitions Example) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasCallbacks Components (Definitions Callback) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Components Source # 
Instance details

Defined in Data.OpenApi.Internal

type Code Components Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Components Source # 
Instance details

Defined in Data.OpenApi.Internal

data PathItem Source #

Describes the operations available on a single path. A PathItem may be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

Constructors

PathItem 

Fields

Instances

Instances details
Eq PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Data PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PathItem -> c PathItem #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PathItem #

toConstr :: PathItem -> Constr #

dataTypeOf :: PathItem -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PathItem) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PathItem) #

gmapT :: (forall b. Data b => b -> b) -> PathItem -> PathItem #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PathItem -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PathItem -> r #

gmapQ :: (forall d. Data d => d -> u) -> PathItem -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PathItem -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PathItem -> m PathItem #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PathItem -> m PathItem #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PathItem -> m PathItem #

Show PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep PathItem :: Type -> Type #

Methods

from :: PathItem -> Rep PathItem x #

to :: Rep PathItem x -> PathItem #

Semigroup PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code PathItem :: [[Type]] #

HasDatatypeInfo PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf PathItem :: DatatypeInfo #

HasSwaggerAesonOptions PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "delete" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "get" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "head" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "options" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [Referenced Param], b ~ [Referenced Param]) => LabelOptic "parameters" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "patch" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "post" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "put" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [Server], b ~ [Server]) => LabelOptic "servers" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "trace" k PathItem PathItem a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasServers PathItem [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription PathItem (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTrace PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary PathItem (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPaths OpenApi (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Lens

SwaggerMonoid (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep PathItem = D1 ('MetaData "PathItem" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "PathItem" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_pathItemSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_pathItemDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_pathItemGet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)))) :*: (S1 ('MetaSel ('Just "_pathItemPut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)) :*: (S1 ('MetaSel ('Just "_pathItemPost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)) :*: S1 ('MetaSel ('Just "_pathItemDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation))))) :*: ((S1 ('MetaSel ('Just "_pathItemOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)) :*: (S1 ('MetaSel ('Just "_pathItemHead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)) :*: S1 ('MetaSel ('Just "_pathItemPatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)))) :*: (S1 ('MetaSel ('Just "_pathItemTrace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Operation)) :*: (S1 ('MetaSel ('Just "_pathItemServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Server]) :*: S1 ('MetaSel ('Just "_pathItemParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Referenced Param]))))))
type Code PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

data Operation Source #

Describes a single API operation on a path.

Constructors

Operation 

Fields

  • _operationTags :: InsOrdHashSet TagName

    A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

  • _operationSummary :: Maybe Text

    A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.

  • _operationDescription :: Maybe Text

    A verbose explanation of the operation behavior. CommonMark syntax can be used for rich text representation.

  • _operationExternalDocs :: Maybe ExternalDocs

    Additional external documentation for this operation.

  • _operationOperationId :: Maybe Text

    Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

  • _operationParameters :: [Referenced Param]

    A list of parameters that are applicable for this operation. If a parameter is already defined at the PathItem, the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

  • _operationRequestBody :: Maybe (Referenced RequestBody)

    The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.

  • _operationResponses :: Responses

    The list of possible responses as they are returned from executing this operation.

  • _operationCallbacks :: InsOrdHashMap Text (Referenced Callback)

    A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.

  • _operationDeprecated :: Maybe Bool

    Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is False.

  • _operationSecurity :: [SecurityRequirement]

    A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, Just [] can be used.

  • _operationServers :: [Server]

    An alternative server array to service this operation. If an alternative server object is specified at the PathItem Object or Root level, it will be overridden by this value.

Instances

Instances details
Eq Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Operation -> c Operation #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Operation #

toConstr :: Operation -> Constr #

dataTypeOf :: Operation -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Operation) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Operation) #

gmapT :: (forall b. Data b => b -> b) -> Operation -> Operation #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r #

gmapQ :: (forall d. Data d => d -> u) -> Operation -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Operation -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Operation -> m Operation #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation #

Show Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Operation :: Type -> Type #

Semigroup Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Operation :: [[Type]] #

HasDatatypeInfo Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Operation :: DatatypeInfo #

Ixed Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

At Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

Ixed Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

Associated Types

type IxKind Operation #

At Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

HasSwaggerAesonOptions Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

HasResponses Operation Responses Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Callback), b ~ InsOrdHashMap Text (Referenced Callback)) => LabelOptic "callbacks" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationId" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [Referenced Param], b ~ [Referenced Param]) => LabelOptic "parameters" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe (Referenced RequestBody), b ~ Maybe (Referenced RequestBody)) => LabelOptic "requestBody" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Responses, b ~ Responses) => LabelOptic "responses" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [SecurityRequirement], b ~ [SecurityRequirement]) => LabelOptic "security" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ [Server], b ~ [Server]) => LabelOptic "servers" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ InsOrdHashSet TagName, b ~ InsOrdHashSet TagName) => LabelOptic "tags" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasTags Operation (InsOrdHashSet TagName) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers Operation [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSecurity Operation [SecurityRequirement] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs Operation (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTrace PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOperationId Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Operation (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Operation = D1 ('MetaData "Operation" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Operation" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_operationTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashSet TagName)) :*: (S1 ('MetaSel ('Just "_operationSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_operationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "_operationExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs)) :*: (S1 ('MetaSel ('Just "_operationOperationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_operationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Referenced Param])))) :*: ((S1 ('MetaSel ('Just "_operationRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced RequestBody))) :*: (S1 ('MetaSel ('Just "_operationResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Responses) :*: S1 ('MetaSel ('Just "_operationCallbacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Callback))))) :*: (S1 ('MetaSel ('Just "_operationDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "_operationSecurity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SecurityRequirement]) :*: S1 ('MetaSel ('Just "_operationServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Server]))))))
type Code Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

type Index Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

type IxValue Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

type Index Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

type IxValue Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

type IxKind Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

data RequestBody Source #

Describes a single request body.

Constructors

RequestBody 

Fields

Instances

Instances details
Eq RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Data RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestBody -> c RequestBody #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestBody #

toConstr :: RequestBody -> Constr #

dataTypeOf :: RequestBody -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RequestBody) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestBody) #

gmapT :: (forall b. Data b => b -> b) -> RequestBody -> RequestBody #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestBody -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestBody -> r #

gmapQ :: (forall d. Data d => d -> u) -> RequestBody -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestBody -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestBody -> m RequestBody #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestBody -> m RequestBody #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestBody -> m RequestBody #

Show RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep RequestBody :: Type -> Type #

Semigroup RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code RequestBody :: [[Type]] #

HasDatatypeInfo RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf RequestBody :: DatatypeInfo #

HasSwaggerAesonOptions RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ InsOrdHashMap MediaType MediaTypeObject, b ~ InsOrdHashMap MediaType MediaTypeObject) => LabelOptic "content" k RequestBody RequestBody a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k RequestBody RequestBody a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k RequestBody RequestBody a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasRequestBodies Components (Definitions RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription RequestBody (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired RequestBody (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep RequestBody = D1 ('MetaData "RequestBody" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "RequestBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "_requestBodyDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_requestBodyContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap MediaType MediaTypeObject)) :*: S1 ('MetaSel ('Just "_requestBodyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))
type Code RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf RequestBody = 'ADT "Data.OpenApi.Internal" "RequestBody" '['Record "RequestBody" '['FieldInfo "_requestBodyDescription", 'FieldInfo "_requestBodyContent", 'FieldInfo "_requestBodyRequired"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data MediaTypeObject Source #

Each Media Type Object provides schema and examples for the media type identified by its key.

Constructors

MediaTypeObject 

Fields

Instances

Instances details
Eq MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Data MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MediaTypeObject -> c MediaTypeObject #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MediaTypeObject #

toConstr :: MediaTypeObject -> Constr #

dataTypeOf :: MediaTypeObject -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MediaTypeObject) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MediaTypeObject) #

gmapT :: (forall b. Data b => b -> b) -> MediaTypeObject -> MediaTypeObject #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MediaTypeObject -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MediaTypeObject -> r #

gmapQ :: (forall d. Data d => d -> u) -> MediaTypeObject -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MediaTypeObject -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MediaTypeObject -> m MediaTypeObject #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaTypeObject -> m MediaTypeObject #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaTypeObject -> m MediaTypeObject #

Show MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep MediaTypeObject :: Type -> Type #

Semigroup MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code MediaTypeObject :: [[Type]] #

HasDatatypeInfo MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ InsOrdHashMap Text Encoding, b ~ InsOrdHashMap Text Encoding) => LabelOptic "encoding" k MediaTypeObject MediaTypeObject a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k MediaTypeObject MediaTypeObject a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Example), b ~ InsOrdHashMap Text (Referenced Example)) => LabelOptic "examples" k MediaTypeObject MediaTypeObject a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k MediaTypeObject MediaTypeObject a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasSchema MediaTypeObject (Maybe (Referenced Schema)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExample MediaTypeObject (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent Response (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep MediaTypeObject = D1 ('MetaData "MediaTypeObject" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "MediaTypeObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_mediaTypeObjectSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))) :*: S1 ('MetaSel ('Just "_mediaTypeObjectExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "_mediaTypeObjectExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Example))) :*: S1 ('MetaSel ('Just "_mediaTypeObjectEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Encoding)))))
type Code MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf MediaTypeObject = 'ADT "Data.OpenApi.Internal" "MediaTypeObject" '['Record "MediaTypeObject" '['FieldInfo "_mediaTypeObjectSchema", 'FieldInfo "_mediaTypeObjectExample", 'FieldInfo "_mediaTypeObjectExamples", 'FieldInfo "_mediaTypeObjectEncoding"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data Style Source #

In order to support common ways of serializing simple parameters, a set of style values are defined.

Constructors

StyleMatrix

Path-style parameters defined by RFC6570.

StyleLabel

Label style parameters defined by RFC6570.

StyleForm

Form style parameters defined by RFC6570. This option replaces collectionFormat with a csv (when explode is false) or multi (when explode is true) value from OpenAPI 2.0.

StyleSimple

Simple style parameters defined by RFC6570. This option replaces collectionFormat with a csv value from OpenAPI 2.0.

StyleSpaceDelimited

Space separated array values. This option replaces collectionFormat equal to ssv from OpenAPI 2.0.

StylePipeDelimited

Pipe separated array values. This option replaces collectionFormat equal to pipes from OpenAPI 2.0.

StyleDeepObject

Provides a simple way of rendering nested objects using form parameters.

Instances

Instances details
Eq Style Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Style -> Style -> Bool #

(/=) :: Style -> Style -> Bool #

Data Style Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Style -> c Style #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Style #

toConstr :: Style -> Constr #

dataTypeOf :: Style -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Style) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Style) #

gmapT :: (forall b. Data b => b -> b) -> Style -> Style #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Style -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Style -> r #

gmapQ :: (forall d. Data d => d -> u) -> Style -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Style -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Style -> m Style #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Style -> m Style #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Style -> m Style #

Show Style Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Style -> ShowS #

show :: Style -> String #

showList :: [Style] -> ShowS #

Generic Style Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Style :: Type -> Type #

Methods

from :: Style -> Rep Style x #

to :: Rep Style x -> Style #

ToJSON Style Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Style Source # 
Instance details

Defined in Data.OpenApi.Internal

HasStyle Param (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasStyle Encoding (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Style Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Style = D1 ('MetaData "Style" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) ((C1 ('MetaCons "StyleMatrix" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "StyleLabel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StyleForm" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "StyleSimple" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StyleSpaceDelimited" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "StylePipeDelimited" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StyleDeepObject" 'PrefixI 'False) (U1 :: Type -> Type))))

data Encoding Source #

Constructors

Encoding 

Fields

  • _encodingContentType :: Maybe MediaType

    The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binaryapplication/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.

  • _encodingHeaders :: InsOrdHashMap Text (Referenced Header)

    A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.

  • _encodingStyle :: Maybe Style

    Describes how a specific property value will be serialized depending on its type. See Param Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.

  • _encodingExplode :: Maybe Bool

    When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.

  • _encodingAllowReserved :: Maybe Bool

    Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded@.

Instances

Instances details
Eq Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Encoding -> c Encoding #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Encoding #

toConstr :: Encoding -> Constr #

dataTypeOf :: Encoding -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Encoding) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Encoding) #

gmapT :: (forall b. Data b => b -> b) -> Encoding -> Encoding #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Encoding -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Encoding -> r #

gmapQ :: (forall d. Data d => d -> u) -> Encoding -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Encoding -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Encoding -> m Encoding #

Show Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Encoding :: Type -> Type #

Methods

from :: Encoding -> Rep Encoding x #

to :: Rep Encoding x -> Encoding #

Semigroup Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Encoding :: [[Type]] #

HasDatatypeInfo Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Encoding :: DatatypeInfo #

HasSwaggerAesonOptions Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowReserved" k Encoding Encoding a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe MediaType, b ~ Maybe MediaType) => LabelOptic "contentType" k Encoding Encoding a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "explode" k Encoding Encoding a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Header), b ~ InsOrdHashMap Text (Referenced Header)) => LabelOptic "headers" k Encoding Encoding a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe Style, b ~ Maybe Style) => LabelOptic "style" k Encoding Encoding a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasStyle Encoding (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Encoding (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowReserved Encoding (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContentType Encoding (Maybe MediaType) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Encoding = D1 ('MetaData "Encoding" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Encoding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_encodingContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MediaType)) :*: S1 ('MetaSel ('Just "_encodingHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Header)))) :*: (S1 ('MetaSel ('Just "_encodingStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Style)) :*: (S1 ('MetaSel ('Just "_encodingExplode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_encodingAllowReserved") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))
type Code Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

newtype MimeList Source #

Constructors

MimeList 

Fields

Instances

Instances details
Eq MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

Data MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MimeList -> c MimeList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MimeList #

toConstr :: MimeList -> Constr #

dataTypeOf :: MimeList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MimeList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MimeList) #

gmapT :: (forall b. Data b => b -> b) -> MimeList -> MimeList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MimeList -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MimeList -> r #

gmapQ :: (forall d. Data d => d -> u) -> MimeList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MimeList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MimeList -> m MimeList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MimeList -> m MimeList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MimeList -> m MimeList #

Show MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

Semigroup MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

data Param Source #

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.

Constructors

Param 

Fields

  • _paramName :: Text

    The name of the parameter. Parameter names are case sensitive.

  • _paramDescription :: Maybe Text

    A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

  • _paramRequired :: Maybe Bool

    Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is False.

  • _paramDeprecated :: Maybe Bool

    Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.

  • _paramIn :: ParamLocation

    The location of the parameter.

  • _paramAllowEmptyValue :: Maybe Bool

    Sets the ability to pass empty-valued parameters. This is valid only for ParamQuery parameters and allows sending a parameter with an empty value. Default value is false.

  • _paramAllowReserved :: Maybe Bool

    Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]!$&'()*+,;=@ to be included without percent-encoding. This property only applies to parameters with an _paramIn value of ParamQuery. The default value is False.

  • _paramSchema :: Maybe (Referenced Schema)

    Parameter schema.

  • _paramStyle :: Maybe Style

    Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of _paramIn): for ParamQuery - StyleForm; for ParamPath - StyleSimple; for ParamHeader - StyleSimple; for ParamCookie - StyleForm.

  • _paramExplode :: Maybe Bool

    When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.

  • _paramExample :: Maybe Value

    Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The _paramExample field is mutually exclusive of the _paramExamples field. Furthermore, if referencing a schema that contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

  • _paramExamples :: InsOrdHashMap Text (Referenced Example)

    Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The _paramExamples field is mutually exclusive of the _paramExample field. Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.

Instances

Instances details
Eq Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Param -> Param -> Bool #

(/=) :: Param -> Param -> Bool #

Data Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Param -> c Param #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Param #

toConstr :: Param -> Constr #

dataTypeOf :: Param -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Param) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Param) #

gmapT :: (forall b. Data b => b -> b) -> Param -> Param #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Param -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Param -> r #

gmapQ :: (forall d. Data d => d -> u) -> Param -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Param -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Param -> m Param #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Param -> m Param #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Param -> m Param #

Show Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Param -> ShowS #

show :: Param -> String #

showList :: [Param] -> ShowS #

Generic Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Param :: Type -> Type #

Methods

from :: Param -> Rep Param x #

to :: Rep Param x -> Param #

Semigroup Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(<>) :: Param -> Param -> Param #

sconcat :: NonEmpty Param -> Param #

stimes :: Integral b => b -> Param -> Param #

Monoid Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

mempty :: Param #

mappend :: Param -> Param -> Param #

mconcat :: [Param] -> Param #

ToJSON Param Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Param :: [[Type]] #

Methods

from :: Param -> Rep Param #

to :: Rep Param -> Param #

HasDatatypeInfo Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Param :: DatatypeInfo #

Methods

datatypeInfo :: proxy Param -> DatatypeInfo (Code Param) #

HasSwaggerAesonOptions Param Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Param Source # 
Instance details

Defined in Data.OpenApi.Internal

HasName Param Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasIn Param ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowEmptyValue" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowReserved" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Example), b ~ InsOrdHashMap Text (Referenced Example)) => LabelOptic "examples" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "explode" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ ParamLocation, b ~ ParamLocation) => LabelOptic "in" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

(k ~ A_Lens, a ~ Maybe Style, b ~ Maybe Style) => LabelOptic "style" k Param Param a b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters Components (Definitions Param) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Param (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSchema Param (Maybe (Referenced Schema)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExample Param (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasStyle Param (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowReserved Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowEmptyValue Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced Param) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Param) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Param Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Param = D1 ('MetaData "Param" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Param" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_paramName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_paramDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_paramRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "_paramDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "_paramIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ParamLocation) :*: S1 ('MetaSel ('Just "_paramAllowEmptyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "_paramAllowReserved") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "_paramSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))) :*: S1 ('MetaSel ('Just "_paramStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Style)))) :*: (S1 ('MetaSel ('Just "_paramExplode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "_paramExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_paramExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Example))))))))
type Code Param Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Param Source # 
Instance details

Defined in Data.OpenApi.Internal

data Example Source #

Constructors

Example 

Fields

Instances

Instances details
Eq Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Example -> Example -> Bool #

(/=) :: Example -> Example -> Bool #

Data Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Example -> c Example #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Example #

toConstr :: Example -> Constr #

dataTypeOf :: Example -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Example) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Example) #

gmapT :: (forall b. Data b => b -> b) -> Example -> Example #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Example -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Example -> r #

gmapQ :: (forall d. Data d => d -> u) -> Example -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Example -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Example -> m Example #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Example -> m Example #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Example -> m Example #

Show Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Example :: Type -> Type #

Methods

from :: Example -> Rep Example x #

to :: Rep Example x -> Example #

ToJSON Example Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Example :: [[Type]] #

HasDatatypeInfo Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Example :: DatatypeInfo #

HasSwaggerAesonOptions Example Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Example Example a b Source # 
Instance d