| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.OpenApi.Internal
Contents
Synopsis
- type Definitions = InsOrdHashMap Text
- data OpenApi = OpenApi {}
- lowerOpenApiSpecVersion :: Version
- upperOpenApiSpecVersion :: Version
- data Info = Info {}
- data Contact = Contact {}
- data License = License {
- _licenseName :: Text
- _licenseUrl :: Maybe URL
- data Server = Server {}
- data ServerVariable = ServerVariable {}
- data Components = Components {
- _componentsSchemas :: Definitions Schema
- _componentsResponses :: Definitions Response
- _componentsParameters :: Definitions Param
- _componentsExamples :: Definitions Example
- _componentsRequestBodies :: Definitions RequestBody
- _componentsHeaders :: Definitions Header
- _componentsSecuritySchemes :: SecurityDefinitions
- _componentsLinks :: Definitions Link
- _componentsCallbacks :: Definitions Callback
- data PathItem = PathItem {
- _pathItemSummary :: Maybe Text
- _pathItemDescription :: Maybe Text
- _pathItemGet :: Maybe Operation
- _pathItemPut :: Maybe Operation
- _pathItemPost :: Maybe Operation
- _pathItemDelete :: Maybe Operation
- _pathItemOptions :: Maybe Operation
- _pathItemHead :: Maybe Operation
- _pathItemPatch :: Maybe Operation
- _pathItemTrace :: Maybe Operation
- _pathItemServers :: [Server]
- _pathItemParameters :: [Referenced Param]
- data Operation = Operation {
- _operationTags :: InsOrdHashSet TagName
- _operationSummary :: Maybe Text
- _operationDescription :: Maybe Text
- _operationExternalDocs :: Maybe ExternalDocs
- _operationOperationId :: Maybe Text
- _operationParameters :: [Referenced Param]
- _operationRequestBody :: Maybe (Referenced RequestBody)
- _operationResponses :: Responses
- _operationCallbacks :: InsOrdHashMap Text (Referenced Callback)
- _operationDeprecated :: Maybe Bool
- _operationSecurity :: [SecurityRequirement]
- _operationServers :: [Server]
- mediaTypeConstr :: Constr
- mediaTypeData :: DataType
- data RequestBody = RequestBody {}
- data MediaTypeObject = MediaTypeObject {}
- data Style
- data Encoding = Encoding {}
- newtype MimeList = MimeList {
- getMimeList :: [MediaType]
- mimeListConstr :: Constr
- mimeListDataType :: DataType
- data Param = Param {
- _paramName :: Text
- _paramDescription :: Maybe Text
- _paramRequired :: Maybe Bool
- _paramDeprecated :: Maybe Bool
- _paramIn :: ParamLocation
- _paramAllowEmptyValue :: Maybe Bool
- _paramAllowReserved :: Maybe Bool
- _paramSchema :: Maybe (Referenced Schema)
- _paramStyle :: Maybe Style
- _paramExplode :: Maybe Bool
- _paramExample :: Maybe Value
- _paramExamples :: InsOrdHashMap Text (Referenced Example)
- data Example = Example {}
- data ExpressionOrValue
- = Expression Text
- | Value Value
- data Link = Link {}
- data OpenApiItems where
- data OpenApiType where
- data ParamLocation
- type Format = Text
- type ParamName = Text
- data Schema = Schema {
- _schemaTitle :: Maybe Text
- _schemaDescription :: Maybe Text
- _schemaRequired :: [ParamName]
- _schemaNullable :: Maybe Bool
- _schemaAllOf :: Maybe [Referenced Schema]
- _schemaOneOf :: Maybe [Referenced Schema]
- _schemaNot :: Maybe (Referenced Schema)
- _schemaAnyOf :: Maybe [Referenced Schema]
- _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
- _schemaAdditionalProperties :: Maybe AdditionalProperties
- _schemaDiscriminator :: Maybe Discriminator
- _schemaReadOnly :: Maybe Bool
- _schemaWriteOnly :: Maybe Bool
- _schemaXml :: Maybe Xml
- _schemaExternalDocs :: Maybe ExternalDocs
- _schemaExample :: Maybe Value
- _schemaDeprecated :: Maybe Bool
- _schemaMaxProperties :: Maybe Integer
- _schemaMinProperties :: Maybe Integer
- _schemaDefault :: Maybe Value
- _schemaType :: Maybe OpenApiType
- _schemaFormat :: Maybe Format
- _schemaItems :: Maybe OpenApiItems
- _schemaMaximum :: Maybe Scientific
- _schemaExclusiveMaximum :: Maybe Bool
- _schemaMinimum :: Maybe Scientific
- _schemaExclusiveMinimum :: Maybe Bool
- _schemaMaxLength :: Maybe Integer
- _schemaMinLength :: Maybe Integer
- _schemaPattern :: Maybe Pattern
- _schemaMaxItems :: Maybe Integer
- _schemaMinItems :: Maybe Integer
- _schemaUniqueItems :: Maybe Bool
- _schemaEnum :: Maybe [Value]
- _schemaMultipleOf :: Maybe Scientific
- type Pattern = Text
- data Discriminator = Discriminator {}
- data NamedSchema = NamedSchema {}
- data Xml = Xml {
- _xmlName :: Maybe Text
- _xmlNamespace :: Maybe Text
- _xmlPrefix :: Maybe Text
- _xmlAttribute :: Maybe Bool
- _xmlWrapped :: Maybe Bool
- data Responses = Responses {}
- type HttpStatusCode = Int
- data Response = Response {}
- newtype Callback = Callback (InsOrdHashMap Text PathItem)
- type HeaderName = Text
- data Header = Header {}
- data ApiKeyLocation
- data ApiKeyParams = ApiKeyParams {}
- type AuthorizationURL = Text
- type TokenURL = Text
- newtype OAuth2ImplicitFlow = OAuth2ImplicitFlow {}
- newtype OAuth2PasswordFlow = OAuth2PasswordFlow {}
- newtype OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow {}
- data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow {}
- data OAuth2Flow p = OAuth2Flow {}
- data OAuth2Flows = OAuth2Flows {}
- type BearerFormat = Text
- data HttpSchemeType
- data SecuritySchemeType
- data SecurityScheme = SecurityScheme {}
- newtype SecurityDefinitions = SecurityDefinitions (Definitions SecurityScheme)
- newtype SecurityRequirement = SecurityRequirement {}
- type TagName = Text
- data Tag = Tag {}
- data ExternalDocs = ExternalDocs {}
- newtype Reference = Reference {
- getReference :: Text
- data Referenced a
- newtype URL = URL {}
- data AdditionalProperties
- newtype OpenApiSpecVersion = OpenApiSpecVersion {}
- referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
- referencedParseJSON :: FromJSON a => Text -> Value -> Parser (Referenced a)
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.
This is the root document object for the API specification.
Constructors
| OpenApi | |
Fields
| |
Instances
lowerOpenApiSpecVersion :: Version Source #
This is the lower version of the OpenApi Spec this library can parse or produce
upperOpenApiSpecVersion :: Version Source #
This is the upper version of the OpenApi Spec this library can parse or produce
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
| FromJSON Info Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Info Source # | |||||
| Data Info Source # | |||||
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 # 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 # | |||||
| Monoid Info Source # | |||||
| Semigroup Info Source # | |||||
| Generic Info Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Info Source # | |||||
| Eq Info Source # | |||||
| AesonDefaultValue Info Source # | |||||
Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Info Source # | |||||
| SwaggerMonoid Info Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasInfo OpenApi Info Source # | |||||
| HasTitle Info Text Source # | |||||
| HasVersion Info Text Source # | |||||
| (k ~ A_Lens, a ~ Maybe Contact, b ~ Maybe Contact) => LabelOptic "contact" k Info Info a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Info Info a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe License, b ~ Maybe License) => LabelOptic "license" k Info Info a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "termsOfService" k Info Info a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "title" k Info Info a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "version" k Info Info a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasContact Info (Maybe Contact) Source # | |||||
| HasDescription Info (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasLicense Info (Maybe License) Source # | |||||
| HasTermsOfService Info (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Rep Info Source # | |||||
Defined in Data.OpenApi.Internal type Rep Info = D1 ('MetaData "Info" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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))))) | |||||
Contact information for the exposed API.
Constructors
| Contact | |
Fields
| |
Instances
| FromJSON Contact Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Contact Source # | |||||
| Data Contact Source # | |||||
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 # | |||||
| Monoid Contact Source # | |||||
| Semigroup Contact Source # | |||||
| Generic Contact Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Contact Source # | |||||
| Eq Contact Source # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "email" k Contact Contact a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k Contact Contact a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "url" k Contact Contact a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasContact Info (Maybe Contact) Source # | |||||
| HasEmail Contact (Maybe Text) Source # | |||||
| HasName Contact (Maybe Text) Source # | |||||
| HasUrl Contact (Maybe URL) Source # | |||||
| type Rep Contact Source # | |||||
Defined in Data.OpenApi.Internal type Rep Contact = D1 ('MetaData "Contact" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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))))) | |||||
License information for the exposed API.
Constructors
| License | |
Fields
| |
Instances
| FromJSON License Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON License Source # | |||||
| Data License Source # | |||||
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 # | |||||
| IsString License Source # | |||||
Defined in Data.OpenApi.Internal Methods fromString :: String -> License # | |||||
| Generic License Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show License Source # | |||||
| Eq License Source # | |||||
| HasName License Text Source # | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k License License a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "url" k License License a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasLicense Info (Maybe License) Source # | |||||
| HasUrl License (Maybe URL) Source # | |||||
| type Rep License Source # | |||||
Defined in Data.OpenApi.Internal type Rep License = D1 ('MetaData "License" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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)))) | |||||
An object representing a Server.
Constructors
| Server | |
Fields
| |
Instances
| FromJSON Server Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Server Source # | |||||
| Data Server Source # | |||||
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 # | |||||
| IsString Server Source # | |||||
Defined in Data.OpenApi.Internal Methods fromString :: String -> Server # | |||||
| Generic Server Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Server Source # | |||||
| Generic Server Source # | |||||
| HasDatatypeInfo Server Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Server -> DatatypeInfo (Code Server) # | |||||
| Eq Server Source # | |||||
| AesonDefaultValue Server Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasSwaggerAesonOptions Server Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Server -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Server -> POP Maybe (Code Server) Source # | |||||
| HasUrl Server Text Source # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Server Server a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k Server Server a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text ServerVariable, b ~ InsOrdHashMap Text ServerVariable) => LabelOptic "variables" k Server Server a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDescription Server (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasServer Link (Maybe Server) Source # | |||||
| HasServers OpenApi [Server] Source # | |||||
| HasServers Operation [Server] Source # | |||||
| HasServers PathItem [Server] Source # | |||||
| HasVariables Server (InsOrdHashMap Text ServerVariable) Source # | |||||
Defined in Data.OpenApi.Lens Methods variables :: Lens' Server (InsOrdHashMap Text ServerVariable) Source # | |||||
| type Rep Server Source # | |||||
Defined in Data.OpenApi.Internal type Rep Server = D1 ('MetaData "Server" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf Server Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Server = 'ADT "Data.OpenApi.Internal" "Server" '['Record "Server" '['FieldInfo "_serverUrl", 'FieldInfo "_serverDescription", 'FieldInfo "_serverVariables"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
data ServerVariable Source #
Constructors
| ServerVariable | |
Fields
| |
Instances
| FromJSON ServerVariable Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ServerVariable # parseJSONList :: Value -> Parser [ServerVariable] # | |||||
| ToJSON ServerVariable Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: ServerVariable -> Value # toEncoding :: ServerVariable -> Encoding # toJSONList :: [ServerVariable] -> Value # toEncodingList :: [ServerVariable] -> Encoding # omitField :: ServerVariable -> Bool # | |||||
| Data ServerVariable Source # | |||||
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 # | |||||
| Generic ServerVariable Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: ServerVariable -> Rep ServerVariable x # to :: Rep ServerVariable x -> ServerVariable # | |||||
| Show ServerVariable Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ServerVariable -> ShowS # show :: ServerVariable -> String # showList :: [ServerVariable] -> ShowS # | |||||
| Eq ServerVariable Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: ServerVariable -> ServerVariable -> Bool # (/=) :: ServerVariable -> ServerVariable -> Bool # | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "default" k ServerVariable ServerVariable a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ServerVariable ServerVariable a b # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k ServerVariable ServerVariable a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ServerVariable ServerVariable a b # | |||||
| (k ~ A_Lens, a ~ Maybe (InsOrdHashSet Text), b ~ Maybe (InsOrdHashSet Text)) => LabelOptic "enum" k ServerVariable ServerVariable a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ServerVariable ServerVariable a b # | |||||
| HasVariables Server (InsOrdHashMap Text ServerVariable) Source # | |||||
Defined in Data.OpenApi.Lens Methods variables :: Lens' Server (InsOrdHashMap Text ServerVariable) Source # | |||||
| type Rep ServerVariable Source # | |||||
Defined in Data.OpenApi.Internal type Rep ServerVariable = D1 ('MetaData "ServerVariable" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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.
Constructors
| Components | |
Fields
| |
Instances
| FromJSON Components Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Components Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Components -> Value # toEncoding :: Components -> Encoding # toJSONList :: [Components] -> Value # toEncodingList :: [Components] -> Encoding # omitField :: Components -> Bool # | |||||
| Data Components Source # | |||||
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 # | |||||
| Monoid Components Source # | |||||
Defined in Data.OpenApi.Internal Methods mempty :: Components # mappend :: Components -> Components -> Components # mconcat :: [Components] -> Components # | |||||
| Semigroup Components Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: Components -> Components -> Components # sconcat :: NonEmpty Components -> Components # stimes :: Integral b => b -> Components -> Components # | |||||
| Generic Components Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Components Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Components -> ShowS # show :: Components -> String # showList :: [Components] -> ShowS # | |||||
| Generic Components Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo Components Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Components -> DatatypeInfo (Code Components) # | |||||
| Eq Components Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| AesonDefaultValue Components Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasSwaggerAesonOptions Components Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Components -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Components -> POP Maybe (Code Components) Source # | |||||
| SwaggerMonoid Components Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerMempty :: Components Source # swaggerMappend :: Components -> Components -> Components Source # | |||||
| HasComponents OpenApi Components Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasSecuritySchemes Components SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Lens Methods securitySchemes :: Lens' Components SecurityDefinitions Source # | |||||
| (k ~ A_Lens, a ~ Definitions Callback, b ~ Definitions Callback) => LabelOptic "callbacks" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions Example, b ~ Definitions Example) => LabelOptic "examples" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions Header, b ~ Definitions Header) => LabelOptic "headers" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions Link, b ~ Definitions Link) => LabelOptic "links" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions Param, b ~ Definitions Param) => LabelOptic "parameters" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions RequestBody, b ~ Definitions RequestBody) => LabelOptic "requestBodies" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions Response, b ~ Definitions Response) => LabelOptic "responses" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ Definitions Schema, b ~ Definitions Schema) => LabelOptic "schemas" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| (k ~ A_Lens, a ~ SecurityDefinitions, b ~ SecurityDefinitions) => LabelOptic "securitySchemes" k Components Components a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b # | |||||
| HasCallbacks Components (Definitions Callback) Source # | |||||
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Components (Definitions Callback) Source # | |||||
| HasExamples Components (Definitions Example) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasHeaders Components (Definitions Header) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasLinks Components (Definitions Link) Source # | |||||
Defined in Data.OpenApi.Lens Methods links :: Lens' Components (Definitions Link) Source # | |||||
| HasParameters Components (Definitions Param) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasRequestBodies Components (Definitions RequestBody) Source # | |||||
Defined in Data.OpenApi.Lens Methods requestBodies :: Lens' Components (Definitions RequestBody) Source # | |||||
| HasResponses Components (Definitions Response) Source # | |||||
Defined in Data.OpenApi.Lens Methods responses :: Lens' Components (Definitions Response) Source # | |||||
| HasSchemas Components (Definitions Schema) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| type Rep Components Source # | |||||
Defined in Data.OpenApi.Internal type Rep Components = D1 ('MetaData "Components" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Components" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_componentsSchemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Schema)) :*: S1 ('MetaSel ('Just "_componentsResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Response))) :*: (S1 ('MetaSel ('Just "_componentsParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Param)) :*: S1 ('MetaSel ('Just "_componentsExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Example)))) :*: ((S1 ('MetaSel ('Just "_componentsRequestBodies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions RequestBody)) :*: S1 ('MetaSel ('Just "_componentsHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Header))) :*: (S1 ('MetaSel ('Just "_componentsSecuritySchemes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecurityDefinitions) :*: (S1 ('MetaSel ('Just "_componentsLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Link)) :*: S1 ('MetaSel ('Just "_componentsCallbacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Callback))))))) | |||||
| type Code Components Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf Components Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Components = 'ADT "Data.OpenApi.Internal" "Components" '['Record "Components" '['FieldInfo "_componentsSchemas", 'FieldInfo "_componentsResponses", 'FieldInfo "_componentsParameters", 'FieldInfo "_componentsExamples", 'FieldInfo "_componentsRequestBodies", 'FieldInfo "_componentsHeaders", 'FieldInfo "_componentsSecuritySchemes", 'FieldInfo "_componentsLinks", 'FieldInfo "_componentsCallbacks"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
Describes the operations available on a single path.
A PathItem
Constructors
| PathItem | |
Fields
| |
Instances
| FromJSON PathItem Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON PathItem Source # | |||||
| Data PathItem Source # | |||||
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 # | |||||
| Monoid PathItem Source # | |||||
| Semigroup PathItem Source # | |||||
| Generic PathItem Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show PathItem Source # | |||||
| Generic PathItem Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasDatatypeInfo PathItem Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy PathItem -> DatatypeInfo (Code PathItem) # | |||||
| Eq PathItem Source # | |||||
| HasSwaggerAesonOptions PathItem Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy PathItem -> SwaggerAesonOptions Source # aesonDefaults :: Proxy PathItem -> POP Maybe (Code PathItem) Source # | |||||
| SwaggerMonoid PathItem Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "delete" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "get" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "head" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "options" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ [Referenced Param], b ~ [Referenced Param]) => LabelOptic "parameters" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "patch" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "post" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "put" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ [Server], b ~ [Server]) => LabelOptic "servers" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "trace" k PathItem PathItem a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDelete PathItem (Maybe Operation) Source # | |||||
| HasDescription PathItem (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasGet PathItem (Maybe Operation) Source # | |||||
| HasHead PathItem (Maybe Operation) Source # | |||||
| HasOptions PathItem (Maybe Operation) Source # | |||||
| HasParameters PathItem [Referenced Param] Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasPatch PathItem (Maybe Operation) Source # | |||||
| HasPost PathItem (Maybe Operation) Source # | |||||
| HasPut PathItem (Maybe Operation) Source # | |||||
| HasServers PathItem [Server] Source # | |||||
| HasSummary PathItem (Maybe Text) Source # | |||||
| HasTrace PathItem (Maybe Operation) Source # | |||||
| HasPaths OpenApi (InsOrdHashMap FilePath PathItem) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| SwaggerMonoid (InsOrdHashMap FilePath PathItem) Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type Rep PathItem Source # | |||||
Defined in Data.OpenApi.Internal type Rep PathItem = D1 ('MetaData "PathItem" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
| type DatatypeInfoOf PathItem Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf PathItem = 'ADT "Data.OpenApi.Internal" "PathItem" '['Record "PathItem" '['FieldInfo "_pathItemSummary", 'FieldInfo "_pathItemDescription", 'FieldInfo "_pathItemGet", 'FieldInfo "_pathItemPut", 'FieldInfo "_pathItemPost", 'FieldInfo "_pathItemDelete", 'FieldInfo "_pathItemOptions", 'FieldInfo "_pathItemHead", 'FieldInfo "_pathItemPatch", 'FieldInfo "_pathItemTrace", 'FieldInfo "_pathItemServers", 'FieldInfo "_pathItemParameters"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
Describes a single API operation on a path.
Constructors
| Operation | |
Fields
| |
Instances
| FromJSON Operation Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Operation Source # | |||||
| Data Operation Source # | |||||
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 # | |||||
| Monoid Operation Source # | |||||
| Semigroup Operation Source # | |||||
| Generic Operation Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Operation Source # | |||||
| Generic Operation Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo Operation Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Operation -> DatatypeInfo (Code Operation) # | |||||
| Eq Operation Source # | |||||
| At Operation Source # | |||||
| Ixed Operation Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasSwaggerAesonOptions Operation Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Operation -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Operation -> POP Maybe (Code Operation) Source # | |||||
| SwaggerMonoid Operation Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerMempty :: Operation Source # swaggerMappend :: Operation -> Operation -> Operation Source # | |||||
| At Operation Source # | |||||
| Ixed Operation Source # | |||||
| HasResponses Operation Responses Source # | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Callback), b ~ InsOrdHashMap Text (Referenced Callback)) => LabelOptic "callbacks" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationId" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ [Referenced Param], b ~ [Referenced Param]) => LabelOptic "parameters" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe (Referenced RequestBody), b ~ Maybe (Referenced RequestBody)) => LabelOptic "requestBody" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Responses, b ~ Responses) => LabelOptic "responses" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ [SecurityRequirement], b ~ [SecurityRequirement]) => LabelOptic "security" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ [Server], b ~ [Server]) => LabelOptic "servers" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashSet TagName, b ~ InsOrdHashSet TagName) => LabelOptic "tags" k Operation Operation a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDelete PathItem (Maybe Operation) Source # | |||||
| HasDeprecated Operation (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDescription Operation (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExternalDocs Operation (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Operation (Maybe ExternalDocs) Source # | |||||
| HasGet PathItem (Maybe Operation) Source # | |||||
| HasHead PathItem (Maybe Operation) Source # | |||||
| HasOperationId Operation (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasOptions PathItem (Maybe Operation) Source # | |||||
| HasParameters Operation [Referenced Param] Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasPatch PathItem (Maybe Operation) Source # | |||||
| HasPost PathItem (Maybe Operation) Source # | |||||
| HasPut PathItem (Maybe Operation) Source # | |||||
| HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # | |||||
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation (Maybe (Referenced RequestBody)) Source # | |||||
| HasSecurity Operation [SecurityRequirement] Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasServers Operation [Server] Source # | |||||
| HasSummary Operation (Maybe Text) Source # | |||||
| HasTags Operation (InsOrdHashSet TagName) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasTrace PathItem (Maybe Operation) Source # | |||||
| HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |||||
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |||||
| type Rep Operation Source # | |||||
Defined in Data.OpenApi.Internal type Rep Operation = D1 ('MetaData "Operation" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
Defined in Data.OpenApi.Internal type Code Operation = '['[InsOrdHashSet TagName, Maybe Text, Maybe Text, Maybe ExternalDocs, Maybe Text, [Referenced Param], Maybe (Referenced RequestBody), Responses, InsOrdHashMap Text (Referenced Callback), Maybe Bool, [SecurityRequirement], [Server]]] | |||||
| type DatatypeInfoOf Operation Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Operation = 'ADT "Data.OpenApi.Internal" "Operation" '['Record "Operation" '['FieldInfo "_operationTags", 'FieldInfo "_operationSummary", 'FieldInfo "_operationDescription", 'FieldInfo "_operationExternalDocs", 'FieldInfo "_operationOperationId", 'FieldInfo "_operationParameters", 'FieldInfo "_operationRequestBody", 'FieldInfo "_operationResponses", 'FieldInfo "_operationCallbacks", 'FieldInfo "_operationDeprecated", 'FieldInfo "_operationSecurity", 'FieldInfo "_operationServers"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
| type Index Operation Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type IxValue Operation Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Index Operation Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| type IxKind Operation Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| type IxValue Operation Source # | |||||
Defined in Data.OpenApi.Optics | |||||
data RequestBody Source #
Describes a single request body.
Constructors
| RequestBody | |
Fields
| |
Instances
| FromJSON RequestBody Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: RequestBody -> Value # toEncoding :: RequestBody -> Encoding # toJSONList :: [RequestBody] -> Value # toEncodingList :: [RequestBody] -> Encoding # omitField :: RequestBody -> Bool # | |||||
| Data RequestBody Source # | |||||
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 # | |||||
| Monoid RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Methods mempty :: RequestBody # mappend :: RequestBody -> RequestBody -> RequestBody # mconcat :: [RequestBody] -> RequestBody # | |||||
| Semigroup RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: RequestBody -> RequestBody -> RequestBody # sconcat :: NonEmpty RequestBody -> RequestBody # stimes :: Integral b => b -> RequestBody -> RequestBody # | |||||
| Generic RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> RequestBody -> ShowS # show :: RequestBody -> String # showList :: [RequestBody] -> ShowS # | |||||
| Generic RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy RequestBody -> DatatypeInfo (Code RequestBody) # | |||||
| Eq RequestBody Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasSwaggerAesonOptions RequestBody Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy RequestBody -> SwaggerAesonOptions Source # aesonDefaults :: Proxy RequestBody -> POP Maybe (Code RequestBody) Source # | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap MediaType MediaTypeObject, b ~ InsOrdHashMap MediaType MediaTypeObject) => LabelOptic "content" k RequestBody RequestBody a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx RequestBody RequestBody a b # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k RequestBody RequestBody a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx RequestBody RequestBody a b # | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k RequestBody RequestBody a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx RequestBody RequestBody a b # | |||||
| HasDescription RequestBody (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens Methods description :: Lens' RequestBody (Maybe Text) Source # | |||||
| HasRequestBodies Components (Definitions RequestBody) Source # | |||||
Defined in Data.OpenApi.Lens Methods requestBodies :: Lens' Components (Definitions RequestBody) Source # | |||||
| HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # | |||||
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation (Maybe (Referenced RequestBody)) Source # | |||||
| HasRequired RequestBody (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
Defined in Data.OpenApi.Lens Methods content :: Lens' RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
| FromJSON (Referenced RequestBody) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced RequestBody) # parseJSONList :: Value -> Parser [Referenced RequestBody] # | |||||
| ToJSON (Referenced RequestBody) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced RequestBody -> Value # toEncoding :: Referenced RequestBody -> Encoding # toJSONList :: [Referenced RequestBody] -> Value # toEncodingList :: [Referenced RequestBody] -> Encoding # omitField :: Referenced RequestBody -> Bool # | |||||
| type Rep RequestBody Source # | |||||
Defined in Data.OpenApi.Internal type Rep RequestBody = D1 ('MetaData "RequestBody" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf RequestBody Source # | |||||
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
| FromJSON MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser MediaTypeObject # parseJSONList :: Value -> Parser [MediaTypeObject] # | |||||
| ToJSON MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: MediaTypeObject -> Value # toEncoding :: MediaTypeObject -> Encoding # toJSONList :: [MediaTypeObject] -> Value # toEncodingList :: [MediaTypeObject] -> Encoding # omitField :: MediaTypeObject -> Bool # | |||||
| Data MediaTypeObject Source # | |||||
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 # | |||||
| Monoid MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods mappend :: MediaTypeObject -> MediaTypeObject -> MediaTypeObject # mconcat :: [MediaTypeObject] -> MediaTypeObject # | |||||
| Semigroup MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: MediaTypeObject -> MediaTypeObject -> MediaTypeObject # sconcat :: NonEmpty MediaTypeObject -> MediaTypeObject # stimes :: Integral b => b -> MediaTypeObject -> MediaTypeObject # | |||||
| Generic MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: MediaTypeObject -> Rep MediaTypeObject x # to :: Rep MediaTypeObject x -> MediaTypeObject # | |||||
| Show MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> MediaTypeObject -> ShowS # show :: MediaTypeObject -> String # showList :: [MediaTypeObject] -> ShowS # | |||||
| Generic MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: MediaTypeObject -> Rep MediaTypeObject # to :: Rep MediaTypeObject -> MediaTypeObject # | |||||
| HasDatatypeInfo MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy MediaTypeObject -> DatatypeInfo (Code MediaTypeObject) # | |||||
| Eq MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: MediaTypeObject -> MediaTypeObject -> Bool # (/=) :: MediaTypeObject -> MediaTypeObject -> Bool # | |||||
| HasSwaggerAesonOptions MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy MediaTypeObject -> SwaggerAesonOptions Source # aesonDefaults :: Proxy MediaTypeObject -> POP Maybe (Code MediaTypeObject) Source # | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text Encoding, b ~ InsOrdHashMap Text Encoding) => LabelOptic "encoding" k MediaTypeObject MediaTypeObject a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b # | |||||
| (k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k MediaTypeObject MediaTypeObject a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b # | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Example), b ~ InsOrdHashMap Text (Referenced Example)) => LabelOptic "examples" k MediaTypeObject MediaTypeObject a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b # | |||||
| (k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k MediaTypeObject MediaTypeObject a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b # | |||||
| HasExample MediaTypeObject (Maybe Value) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasSchema MediaTypeObject (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject (Maybe (Referenced Schema)) Source # | |||||
| HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
Defined in Data.OpenApi.Lens Methods content :: Lens' RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
| HasContent Response (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
Defined in Data.OpenApi.Lens Methods content :: Lens' Response (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
| HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # | |||||
Defined in Data.OpenApi.Lens Methods encoding :: Lens' MediaTypeObject (InsOrdHashMap Text Encoding) Source # | |||||
| HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |||||
Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |||||
| type Rep MediaTypeObject Source # | |||||
Defined in Data.OpenApi.Internal type Rep MediaTypeObject = D1 ('MetaData "MediaTypeObject" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
Defined in Data.OpenApi.Internal type Code MediaTypeObject = '['[Maybe (Referenced Schema), Maybe Value, InsOrdHashMap Text (Referenced Example), InsOrdHashMap Text Encoding]] | |||||
| type DatatypeInfoOf MediaTypeObject Source # | |||||
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]] | |||||
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 |
| StyleSimple | Simple style parameters defined by RFC6570.
This option replaces |
| StyleSpaceDelimited | Space separated array values.
This option replaces |
| StylePipeDelimited | Pipe separated array values.
This option replaces |
| StyleDeepObject | Provides a simple way of rendering nested objects using form parameters. |
Instances
| FromJSON Style Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Style Source # | |||||
| Data Style Source # | |||||
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 # 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 # | |||||
| Generic Style Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Style Source # | |||||
| Eq Style Source # | |||||
| HasStyle Encoding (Maybe Style) Source # | |||||
| HasStyle Param (Maybe Style) Source # | |||||
| type Rep Style Source # | |||||
Defined in Data.OpenApi.Internal type Rep Style = D1 ('MetaData "Style" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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)))) | |||||
Constructors
| Encoding | |
Fields
| |
Instances
| FromJSON Encoding Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Encoding Source # | |||||
| Data Encoding Source # | |||||
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 # | |||||
| Monoid Encoding Source # | |||||
| Semigroup Encoding Source # | |||||
| Generic Encoding Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Encoding Source # | |||||
| Generic Encoding Source # | |||||
| HasDatatypeInfo Encoding Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Encoding -> DatatypeInfo (Code Encoding) # | |||||
| Eq Encoding Source # | |||||
| HasSwaggerAesonOptions Encoding Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Encoding -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Encoding -> POP Maybe (Code Encoding) Source # | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowReserved" k Encoding Encoding a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe MediaType, b ~ Maybe MediaType) => LabelOptic "contentType" k Encoding Encoding a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "explode" k Encoding Encoding a b Source # | |||||
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 # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Style, b ~ Maybe Style) => LabelOptic "style" k Encoding Encoding a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasAllowReserved Encoding (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasContentType Encoding (Maybe MediaType) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExplode Encoding (Maybe Bool) Source # | |||||
| HasStyle Encoding (Maybe Style) Source # | |||||
| HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # | |||||
Defined in Data.OpenApi.Lens Methods encoding :: Lens' MediaTypeObject (InsOrdHashMap Text Encoding) Source # | |||||
| HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |||||
Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |||||
| type Rep Encoding Source # | |||||
Defined in Data.OpenApi.Internal type Rep Encoding = D1 ('MetaData "Encoding" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf Encoding Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Encoding = 'ADT "Data.OpenApi.Internal" "Encoding" '['Record "Encoding" '['FieldInfo "_encodingContentType", 'FieldInfo "_encodingHeaders", 'FieldInfo "_encodingStyle", 'FieldInfo "_encodingExplode", 'FieldInfo "_encodingAllowReserved"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
Constructors
| MimeList | |
Fields
| |
Instances
| FromJSON MimeList Source # | |
Defined in Data.OpenApi.Internal | |
| ToJSON MimeList Source # | |
| Data MimeList Source # | |
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 # | |
| Monoid MimeList Source # | |
| Semigroup MimeList Source # | |
| Show MimeList Source # | |
| Eq MimeList Source # | |
| AesonDefaultValue MimeList Source # | |
Defined in Data.OpenApi.Internal Methods | |
| SwaggerMonoid MimeList Source # | |
Defined in Data.OpenApi.Internal Methods | |
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
Constructors
| Param | |
Fields
| |
Instances
| FromJSON Param Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Param Source # | |||||
| Data Param Source # | |||||
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 # 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 # | |||||
| Monoid Param Source # | |||||
| Semigroup Param Source # | |||||
| Generic Param Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Param Source # | |||||
| Generic Param Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasDatatypeInfo Param Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Param -> DatatypeInfo (Code Param) # | |||||
| Eq Param Source # | |||||
| HasSwaggerAesonOptions Param Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Param -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Param -> POP Maybe (Code Param) Source # | |||||
| SwaggerMonoid Param Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasIn Param ParamLocation Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasName Param Text Source # | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowEmptyValue" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowReserved" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Example), b ~ InsOrdHashMap Text (Referenced Example)) => LabelOptic "examples" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "explode" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ ParamLocation, b ~ ParamLocation) => LabelOptic "in" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Style, b ~ Maybe Style) => LabelOptic "style" k Param Param a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasAllowEmptyValue Param (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasAllowReserved Param (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDeprecated Param (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDescription Param (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExample Param (Maybe Value) Source # | |||||
| HasExplode Param (Maybe Bool) Source # | |||||
| HasParameters Components (Definitions Param) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasParameters Operation [Referenced Param] Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasParameters PathItem [Referenced Param] Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasRequired Param (Maybe Bool) Source # | |||||
| HasSchema Param (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasStyle Param (Maybe Style) Source # | |||||
| HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # | |||||
Defined in Data.OpenApi.Lens Methods examples :: Lens' Param (InsOrdHashMap Text (Referenced Example)) Source # | |||||
| FromJSON (Referenced Param) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Param) # parseJSONList :: Value -> Parser [Referenced Param] # omittedField :: Maybe (Referenced Param) # | |||||
| ToJSON (Referenced Param) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Param -> Value # toEncoding :: Referenced Param -> Encoding # toJSONList :: [Referenced Param] -> Value # toEncodingList :: [Referenced Param] -> Encoding # omitField :: Referenced Param -> Bool # | |||||
| type Rep Param Source # | |||||
Defined in Data.OpenApi.Internal type Rep Param = D1 ('MetaData "Param" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" '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 # | |||||
| type DatatypeInfoOf Param Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Param = 'ADT "Data.OpenApi.Internal" "Param" '['Record "Param" '['FieldInfo "_paramName", 'FieldInfo "_paramDescription", 'FieldInfo "_paramRequired", 'FieldInfo "_paramDeprecated", 'FieldInfo "_paramIn", 'FieldInfo "_paramAllowEmptyValue", 'FieldInfo "_paramAllowReserved", 'FieldInfo "_paramSchema", 'FieldInfo "_paramStyle", 'FieldInfo "_paramExplode", 'FieldInfo "_paramExample", 'FieldInfo "_paramExamples"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
Constructors
| Example | |
Fields
| |
Instances
| FromJSON Example Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Example Source # | |||||
| Data Example Source # | |||||
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 # | |||||
| Generic Example Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Example Source # | |||||
| Generic Example Source # | |||||
| HasDatatypeInfo Example Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Example -> DatatypeInfo (Code Example) # | |||||
| Eq Example Source # | |||||
| HasSwaggerAesonOptions Example Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Example -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Example -> POP Maybe (Code Example) Source # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Example Example a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "externalValue" k Example Example a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k Example Example a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "value" k Example Example a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDescription Example (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExamples Components (Definitions Example) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasExternalValue Example (Maybe URL) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasSummary Example (Maybe Text) Source # | |||||
| HasValue Example (Maybe Value) Source # | |||||
| HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # | |||||
Defined in Data.OpenApi.Lens Methods examples :: Lens' Header (InsOrdHashMap Text (Referenced Example)) Source # | |||||
| HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |||||
Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |||||
| HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # | |||||
Defined in Data.OpenApi.Lens Methods examples :: Lens' Param (InsOrdHashMap Text (Referenced Example)) Source # | |||||
| FromJSON (Referenced Example) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Example) # parseJSONList :: Value -> Parser [Referenced Example] # omittedField :: Maybe (Referenced Example) # | |||||
| ToJSON (Referenced Example) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Example -> Value # toEncoding :: Referenced Example -> Encoding # toJSONList :: [Referenced Example] -> Value # toEncodingList :: [Referenced Example] -> Encoding # omitField :: Referenced Example -> Bool # | |||||
| type Rep Example Source # | |||||
Defined in Data.OpenApi.Internal type Rep Example = D1 ('MetaData "Example" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Example" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_exampleSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_exampleDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_exampleValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_exampleExternalValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL))))) | |||||
| type Code Example Source # | |||||
| type DatatypeInfoOf Example Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Example = 'ADT "Data.OpenApi.Internal" "Example" '['Record "Example" '['FieldInfo "_exampleSummary", 'FieldInfo "_exampleDescription", 'FieldInfo "_exampleValue", 'FieldInfo "_exampleExternalValue"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
data ExpressionOrValue Source #
Constructors
| Expression Text | |
| Value Value |
Instances
| FromJSON ExpressionOrValue Source # | All strings are parsed as expressions | ||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ExpressionOrValue # parseJSONList :: Value -> Parser [ExpressionOrValue] # | |||||
| ToJSON ExpressionOrValue Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: ExpressionOrValue -> Value # toEncoding :: ExpressionOrValue -> Encoding # toJSONList :: [ExpressionOrValue] -> Value # toEncodingList :: [ExpressionOrValue] -> Encoding # omitField :: ExpressionOrValue -> Bool # | |||||
| Data ExpressionOrValue Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExpressionOrValue -> c ExpressionOrValue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExpressionOrValue # toConstr :: ExpressionOrValue -> Constr # dataTypeOf :: ExpressionOrValue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ExpressionOrValue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExpressionOrValue) # gmapT :: (forall b. Data b => b -> b) -> ExpressionOrValue -> ExpressionOrValue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExpressionOrValue -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExpressionOrValue -> r # gmapQ :: (forall d. Data d => d -> u) -> ExpressionOrValue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ExpressionOrValue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExpressionOrValue -> m ExpressionOrValue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExpressionOrValue -> m ExpressionOrValue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExpressionOrValue -> m ExpressionOrValue # | |||||
| Generic ExpressionOrValue Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: ExpressionOrValue -> Rep ExpressionOrValue x # to :: Rep ExpressionOrValue x -> ExpressionOrValue # | |||||
| Show ExpressionOrValue Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ExpressionOrValue -> ShowS # show :: ExpressionOrValue -> String # showList :: [ExpressionOrValue] -> ShowS # | |||||
| Eq ExpressionOrValue Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: ExpressionOrValue -> ExpressionOrValue -> Bool # (/=) :: ExpressionOrValue -> ExpressionOrValue -> Bool # | |||||
| HasRequestBody Link (Maybe ExpressionOrValue) Source # | |||||
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Link (Maybe ExpressionOrValue) Source # | |||||
| HasParameters Link (InsOrdHashMap Text ExpressionOrValue) Source # | |||||
Defined in Data.OpenApi.Lens Methods parameters :: Lens' Link (InsOrdHashMap Text ExpressionOrValue) Source # | |||||
| type Rep ExpressionOrValue Source # | |||||
Defined in Data.OpenApi.Internal type Rep ExpressionOrValue = D1 ('MetaData "ExpressionOrValue" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Expression" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Value" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))) | |||||
The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
Constructors
| Link | |
Fields
| |
Instances
| FromJSON Link Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Link Source # | |||||
| Data Link Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Link -> c Link # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Link # dataTypeOf :: Link -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Link) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Link) # gmapT :: (forall b. Data b => b -> b) -> Link -> Link # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Link -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Link -> r # gmapQ :: (forall d. Data d => d -> u) -> Link -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Link -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Link -> m Link # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Link -> m Link # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Link -> m Link # | |||||
| Generic Link Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Link Source # | |||||
| Generic Link Source # | |||||
| HasDatatypeInfo Link Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Link -> DatatypeInfo (Code Link) # | |||||
| Eq Link Source # | |||||
| AesonDefaultValue Link Source # | |||||
Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Link Source # | |||||
| HasSwaggerAesonOptions Link Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Link -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Link -> POP Maybe (Code Link) Source # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Link Link a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationId" k Link Link a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationRef" k Link Link a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text ExpressionOrValue, b ~ InsOrdHashMap Text ExpressionOrValue) => LabelOptic "parameters" k Link Link a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe ExpressionOrValue, b ~ Maybe ExpressionOrValue) => LabelOptic "requestBody" k Link Link a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Server, b ~ Maybe Server) => LabelOptic "server" k Link Link a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDescription Link (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasLinks Components (Definitions Link) Source # | |||||
Defined in Data.OpenApi.Lens Methods links :: Lens' Components (Definitions Link) Source # | |||||
| HasOperationId Link (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasOperationRef Link (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasRequestBody Link (Maybe ExpressionOrValue) Source # | |||||
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Link (Maybe ExpressionOrValue) Source # | |||||
| HasServer Link (Maybe Server) Source # | |||||
| HasLinks Response (InsOrdHashMap Text (Referenced Link)) Source # | |||||
Defined in Data.OpenApi.Lens Methods links :: Lens' Response (InsOrdHashMap Text (Referenced Link)) Source # | |||||
| HasParameters Link (InsOrdHashMap Text ExpressionOrValue) Source # | |||||
Defined in Data.OpenApi.Lens Methods parameters :: Lens' Link (InsOrdHashMap Text ExpressionOrValue) Source # | |||||
| FromJSON (Referenced Link) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Link) # parseJSONList :: Value -> Parser [Referenced Link] # omittedField :: Maybe (Referenced Link) # | |||||
| ToJSON (Referenced Link) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Link -> Value # toEncoding :: Referenced Link -> Encoding # toJSONList :: [Referenced Link] -> Value # toEncodingList :: [Referenced Link] -> Encoding # omitField :: Referenced Link -> Bool # | |||||
| type Rep Link Source # | |||||
Defined in Data.OpenApi.Internal type Rep Link = D1 ('MetaData "Link" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Link" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_linkOperationRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_linkOperationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_linkParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text ExpressionOrValue)))) :*: (S1 ('MetaSel ('Just "_linkRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExpressionOrValue)) :*: (S1 ('MetaSel ('Just "_linkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_linkServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Server)))))) | |||||
| type Code Link Source # | |||||
Defined in Data.OpenApi.Internal type Code Link = '['[Maybe Text, Maybe Text, InsOrdHashMap Text ExpressionOrValue, Maybe ExpressionOrValue, Maybe Text, Maybe Server]] | |||||
| type DatatypeInfoOf Link Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Link = 'ADT "Data.OpenApi.Internal" "Link" '['Record "Link" '['FieldInfo "_linkOperationRef", 'FieldInfo "_linkOperationId", 'FieldInfo "_linkParameters", 'FieldInfo "_linkRequestBody", 'FieldInfo "_linkDescription", 'FieldInfo "_linkServer"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
data OpenApiItems where Source #
Items for OpenApiArray
Warning: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as it will incorporate Json Schema mostly verbatim.
OpenApiItemsObjectSchema
OpenApiItemsArraySchema
Constructors
| OpenApiItemsObject :: Referenced Schema -> OpenApiItems | |
| OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems |
Instances
| FromJSON OpenApiItems Source # | |
Defined in Data.OpenApi.Internal | |
| ToJSON OpenApiItems Source # | As for nullary schema for 0-arity type constructors, see https://github.com/GetShopTV/swagger2/issues/167.
|
Defined in Data.OpenApi.Internal Methods toJSON :: OpenApiItems -> Value # toEncoding :: OpenApiItems -> Encoding # toJSONList :: [OpenApiItems] -> Value # toEncodingList :: [OpenApiItems] -> Encoding # omitField :: OpenApiItems -> Bool # | |
| Data OpenApiItems Source # | |
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenApiItems -> c OpenApiItems # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OpenApiItems # toConstr :: OpenApiItems -> Constr # dataTypeOf :: OpenApiItems -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OpenApiItems) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OpenApiItems) # gmapT :: (forall b. Data b => b -> b) -> OpenApiItems -> OpenApiItems # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenApiItems -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenApiItems -> r # gmapQ :: (forall d. Data d => d -> u) -> OpenApiItems -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenApiItems -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenApiItems -> m OpenApiItems # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApiItems -> m OpenApiItems # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApiItems -> m OpenApiItems # | |
| Show OpenApiItems Source # | |
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OpenApiItems -> ShowS # show :: OpenApiItems -> String # showList :: [OpenApiItems] -> ShowS # | |
| Eq OpenApiItems Source # | |
Defined in Data.OpenApi.Internal | |
| (a ~ [Referenced Schema], b ~ [Referenced Schema]) => LabelOptic "_OpenApiItemsArray" A_Review OpenApiItems OpenApiItems a b Source # | |
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Review NoIx OpenApiItems OpenApiItems a b # | |
| (a ~ Referenced Schema, b ~ Referenced Schema) => LabelOptic "_OpenApiItemsObject" A_Review OpenApiItems OpenApiItems a b Source # | |
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Review NoIx OpenApiItems OpenApiItems a b # | |
| HasItems Schema (Maybe OpenApiItems) Source # | |
Defined in Data.OpenApi.Lens | |
| HasSchema s Schema => HasItems s (Maybe OpenApiItems) Source # | |
Defined in Data.OpenApi.Lens | |
data OpenApiType where Source #
Constructors
| OpenApiString :: OpenApiType | |
| OpenApiNumber :: OpenApiType | |
| OpenApiInteger :: OpenApiType | |
| OpenApiBoolean :: OpenApiType | |
| OpenApiArray :: OpenApiType | |
| OpenApiNull :: OpenApiType | |
| OpenApiObject :: OpenApiType |
Instances
| FromJSON OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OpenApiType -> Value # toEncoding :: OpenApiType -> Encoding # toJSONList :: [OpenApiType] -> Value # toEncodingList :: [OpenApiType] -> Encoding # omitField :: OpenApiType -> Bool # | |||||
| Data OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenApiType -> c OpenApiType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OpenApiType # toConstr :: OpenApiType -> Constr # dataTypeOf :: OpenApiType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OpenApiType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OpenApiType) # gmapT :: (forall b. Data b => b -> b) -> OpenApiType -> OpenApiType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenApiType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenApiType -> r # gmapQ :: (forall d. Data d => d -> u) -> OpenApiType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenApiType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenApiType -> m OpenApiType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApiType -> m OpenApiType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApiType -> m OpenApiType # | |||||
| Generic OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OpenApiType -> ShowS # show :: OpenApiType -> String # showList :: [OpenApiType] -> ShowS # | |||||
| Eq OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| AesonDefaultValue OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| SwaggerMonoid OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerMempty :: OpenApiType Source # swaggerMappend :: OpenApiType -> OpenApiType -> OpenApiType Source # | |||||
| HasType NamedSchema (Maybe OpenApiType) Source # | |||||
Defined in Data.OpenApi.Lens Methods type_ :: Lens' NamedSchema (Maybe OpenApiType) Source # | |||||
| HasType Schema (Maybe OpenApiType) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Rep OpenApiType Source # | |||||
Defined in Data.OpenApi.Internal type Rep OpenApiType = D1 ('MetaData "OpenApiType" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) ((C1 ('MetaCons "OpenApiString" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OpenApiNumber" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpenApiInteger" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "OpenApiBoolean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpenApiArray" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "OpenApiNull" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpenApiObject" 'PrefixI 'False) (U1 :: Type -> Type)))) | |||||
data ParamLocation Source #
Constructors
| ParamQuery | Parameters that are appended to the URL.
For example, in |
| ParamHeader | Custom headers that are expected as part of the request. |
| ParamPath | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
This does not include the host or base path of the API.
For example, in |
| ParamCookie | Used to pass a specific cookie value to the API. |
Instances
| FromJSON ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ParamLocation # parseJSONList :: Value -> Parser [ParamLocation] # | |||||
| ToJSON ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: ParamLocation -> Value # toEncoding :: ParamLocation -> Encoding # toJSONList :: [ParamLocation] -> Value # toEncodingList :: [ParamLocation] -> Encoding # omitField :: ParamLocation -> Bool # | |||||
| Data ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParamLocation -> c ParamLocation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParamLocation # toConstr :: ParamLocation -> Constr # dataTypeOf :: ParamLocation -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ParamLocation) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParamLocation) # gmapT :: (forall b. Data b => b -> b) -> ParamLocation -> ParamLocation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParamLocation -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParamLocation -> r # gmapQ :: (forall d. Data d => d -> u) -> ParamLocation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ParamLocation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParamLocation -> m ParamLocation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamLocation -> m ParamLocation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamLocation -> m ParamLocation # | |||||
| Generic ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ParamLocation -> ShowS # show :: ParamLocation -> String # showList :: [ParamLocation] -> ShowS # | |||||
| Eq ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: ParamLocation -> ParamLocation -> Bool # (/=) :: ParamLocation -> ParamLocation -> Bool # | |||||
| AesonDefaultValue ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| SwaggerMonoid ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerMempty :: ParamLocation Source # swaggerMappend :: ParamLocation -> ParamLocation -> ParamLocation Source # | |||||
| HasIn Param ParamLocation Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Rep ParamLocation Source # | |||||
Defined in Data.OpenApi.Internal type Rep ParamLocation = D1 ('MetaData "ParamLocation" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) ((C1 ('MetaCons "ParamQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ParamHeader" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ParamPath" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ParamCookie" 'PrefixI 'False) (U1 :: Type -> Type))) | |||||
Constructors
| Schema | |
Fields
| |
Instances
| FromJSON Schema Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Schema Source # | |||||
| Data Schema Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Schema -> c Schema # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Schema # toConstr :: Schema -> Constr # dataTypeOf :: Schema -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Schema) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Schema) # gmapT :: (forall b. Data b => b -> b) -> Schema -> Schema # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Schema -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Schema -> r # gmapQ :: (forall d. Data d => d -> u) -> Schema -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Schema -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Schema -> m Schema # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Schema -> m Schema # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Schema -> m Schema # | |||||
| Monoid Schema Source # | |||||
| Semigroup Schema Source # | |||||
| Generic Schema Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Schema Source # | |||||
| Generic Schema Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo Schema Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Schema -> DatatypeInfo (Code Schema) # | |||||
| Eq Schema Source # | |||||
| HasSwaggerAesonOptions Schema Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Schema -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Schema -> POP Maybe (Code Schema) Source # | |||||
| SwaggerMonoid Schema Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasSchema NamedSchema Schema Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ A_Lens, a ~ Maybe AdditionalProperties, b ~ Maybe AdditionalProperties) => LabelOptic "additionalProperties" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "allOf" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "anyOf" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Discriminator, b ~ Maybe Discriminator) => LabelOptic "discriminator" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe OpenApiItems, b ~ Maybe OpenApiItems) => LabelOptic "items" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxProperties" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minProperties" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "not" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "nullable" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "oneOf" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Pattern, b ~ Maybe Pattern) => LabelOptic "pattern" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Schema), b ~ InsOrdHashMap Text (Referenced Schema)) => LabelOptic "properties" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "readOnly" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ [ParamName], b ~ [ParamName]) => LabelOptic "required" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "title" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe OpenApiType, b ~ Maybe OpenApiType) => LabelOptic "type" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "writeOnly" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Xml, b ~ Maybe Xml) => LabelOptic "xml" k Schema Schema a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # | |||||
Defined in Data.OpenApi.Lens Methods additionalProperties :: Lens' Schema (Maybe AdditionalProperties) Source # | |||||
| HasAllOf Schema (Maybe [Referenced Schema]) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasAnyOf Schema (Maybe [Referenced Schema]) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDefault Schema (Maybe Value) Source # | |||||
| HasDeprecated Schema (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDescription Schema (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDiscriminator Schema (Maybe Discriminator) Source # | |||||
Defined in Data.OpenApi.Lens Methods discriminator :: Lens' Schema (Maybe Discriminator) Source # | |||||
| HasEnum Schema (Maybe [Value]) Source # | |||||
| HasExample Schema (Maybe Value) Source # | |||||
| HasExclusiveMaximum Schema (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExclusiveMinimum Schema (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExternalDocs Schema (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasFormat Schema (Maybe Format) Source # | |||||
| HasItems Schema (Maybe OpenApiItems) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasMaxItems Schema (Maybe Integer) Source # | |||||
| HasMaxLength Schema (Maybe Integer) Source # | |||||
| HasMaxProperties Schema (Maybe Integer) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasMaximum Schema (Maybe Scientific) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasMinItems Schema (Maybe Integer) Source # | |||||
| HasMinLength Schema (Maybe Integer) Source # | |||||
| HasMinProperties Schema (Maybe Integer) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasMinimum Schema (Maybe Scientific) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasMultipleOf Schema (Maybe Scientific) Source # | |||||
Defined in Data.OpenApi.Lens Methods multipleOf :: Lens' Schema (Maybe Scientific) Source # | |||||
| HasNot Schema (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasNullable Schema (Maybe Bool) Source # | |||||
| HasOneOf Schema (Maybe [Referenced Schema]) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasPattern Schema (Maybe Pattern) Source # | |||||
| HasReadOnly Schema (Maybe Bool) Source # | |||||
| HasRequired Schema [ParamName] Source # | |||||
| HasSchema Header (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasSchema MediaTypeObject (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject (Maybe (Referenced Schema)) Source # | |||||
| HasSchema Param (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasSchemas Components (Definitions Schema) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasTitle Schema (Maybe Text) Source # | |||||
| HasType Schema (Maybe OpenApiType) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasUniqueItems Schema (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasWriteOnly Schema (Maybe Bool) Source # | |||||
| HasXml Schema (Maybe Xml) Source # | |||||
| HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens Methods properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |||||
| FromJSON (Referenced Schema) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Schema) # parseJSONList :: Value -> Parser [Referenced Schema] # omittedField :: Maybe (Referenced Schema) # | |||||
| ToJSON (Referenced Schema) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Schema -> Value # toEncoding :: Referenced Schema -> Encoding # toJSONList :: [Referenced Schema] -> Value # toEncodingList :: [Referenced Schema] -> Encoding # omitField :: Referenced Schema -> Bool # | |||||
| type Rep Schema Source # | |||||
Defined in Data.OpenApi.Internal type Rep Schema = D1 ('MetaData "Schema" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Schema" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "_schemaTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_schemaDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_schemaRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ParamName]) :*: S1 ('MetaSel ('Just "_schemaNullable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "_schemaAllOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Referenced Schema])) :*: S1 ('MetaSel ('Just "_schemaOneOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Referenced Schema]))) :*: (S1 ('MetaSel ('Just "_schemaNot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))) :*: S1 ('MetaSel ('Just "_schemaAnyOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Referenced Schema]))))) :*: (((S1 ('MetaSel ('Just "_schemaProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Schema))) :*: S1 ('MetaSel ('Just "_schemaAdditionalProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AdditionalProperties))) :*: (S1 ('MetaSel ('Just "_schemaDiscriminator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Discriminator)) :*: S1 ('MetaSel ('Just "_schemaReadOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "_schemaWriteOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_schemaXml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Xml))) :*: (S1 ('MetaSel ('Just "_schemaExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs)) :*: (S1 ('MetaSel ('Just "_schemaExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_schemaDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))) :*: ((((S1 ('MetaSel ('Just "_schemaMaxProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaMinProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_schemaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe OpenApiType)))) :*: ((S1 ('MetaSel ('Just "_schemaFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Format)) :*: S1 ('MetaSel ('Just "_schemaItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe OpenApiItems))) :*: (S1 ('MetaSel ('Just "_schemaMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)) :*: (S1 ('MetaSel ('Just "_schemaExclusiveMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_schemaMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)))))) :*: (((S1 ('MetaSel ('Just "_schemaExclusiveMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_schemaMaxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaMinLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pattern)))) :*: ((S1 ('MetaSel ('Just "_schemaMaxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaMinItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaUniqueItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "_schemaEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Value])) :*: S1 ('MetaSel ('Just "_schemaMultipleOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific))))))))) | |||||
| type Code Schema Source # | |||||
Defined in Data.OpenApi.Internal type Code Schema = '['[Maybe Text, Maybe Text, [ParamName], Maybe Bool, Maybe [Referenced Schema], Maybe [Referenced Schema], Maybe (Referenced Schema), Maybe [Referenced Schema], InsOrdHashMap Text (Referenced Schema), Maybe AdditionalProperties, Maybe Discriminator, Maybe Bool, Maybe Bool, Maybe Xml, Maybe ExternalDocs, Maybe Value, Maybe Bool, Maybe Integer, Maybe Integer, Maybe Value, Maybe OpenApiType, Maybe Format, Maybe OpenApiItems, Maybe Scientific, Maybe Bool, Maybe Scientific, Maybe Bool, Maybe Integer, Maybe Integer, Maybe Pattern, Maybe Integer, Maybe Integer, Maybe Bool, Maybe [Value], Maybe Scientific]] | |||||
| type DatatypeInfoOf Schema Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Schema = 'ADT "Data.OpenApi.Internal" "Schema" '['Record "Schema" '['FieldInfo "_schemaTitle", 'FieldInfo "_schemaDescription", 'FieldInfo "_schemaRequired", 'FieldInfo "_schemaNullable", 'FieldInfo "_schemaAllOf", 'FieldInfo "_schemaOneOf", 'FieldInfo "_schemaNot", 'FieldInfo "_schemaAnyOf", 'FieldInfo "_schemaProperties", 'FieldInfo "_schemaAdditionalProperties", 'FieldInfo "_schemaDiscriminator", 'FieldInfo "_schemaReadOnly", 'FieldInfo "_schemaWriteOnly", 'FieldInfo "_schemaXml", 'FieldInfo "_schemaExternalDocs", 'FieldInfo "_schemaExample", 'FieldInfo "_schemaDeprecated", 'FieldInfo "_schemaMaxProperties", 'FieldInfo "_schemaMinProperties", 'FieldInfo "_schemaDefault", 'FieldInfo "_schemaType", 'FieldInfo "_schemaFormat", 'FieldInfo "_schemaItems", 'FieldInfo "_schemaMaximum", 'FieldInfo "_schemaExclusiveMaximum", 'FieldInfo "_schemaMinimum", 'FieldInfo "_schemaExclusiveMinimum", 'FieldInfo "_schemaMaxLength", 'FieldInfo "_schemaMinLength", 'FieldInfo "_schemaPattern", 'FieldInfo "_schemaMaxItems", 'FieldInfo "_schemaMinItems", 'FieldInfo "_schemaUniqueItems", 'FieldInfo "_schemaEnum", 'FieldInfo "_schemaMultipleOf"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
data Discriminator Source #
Constructors
| Discriminator | |
Fields
| |
Instances
| FromJSON Discriminator Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Discriminator # parseJSONList :: Value -> Parser [Discriminator] # | |||||
| ToJSON Discriminator Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Discriminator -> Value # toEncoding :: Discriminator -> Encoding # toJSONList :: [Discriminator] -> Value # toEncodingList :: [Discriminator] -> Encoding # omitField :: Discriminator -> Bool # | |||||
| Data Discriminator Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Discriminator -> c Discriminator # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Discriminator # toConstr :: Discriminator -> Constr # dataTypeOf :: Discriminator -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Discriminator) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Discriminator) # gmapT :: (forall b. Data b => b -> b) -> Discriminator -> Discriminator # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Discriminator -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Discriminator -> r # gmapQ :: (forall d. Data d => d -> u) -> Discriminator -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Discriminator -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Discriminator -> m Discriminator # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Discriminator -> m Discriminator # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Discriminator -> m Discriminator # | |||||
| Generic Discriminator Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Discriminator Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Discriminator -> ShowS # show :: Discriminator -> String # showList :: [Discriminator] -> ShowS # | |||||
| Eq Discriminator Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: Discriminator -> Discriminator -> Bool # (/=) :: Discriminator -> Discriminator -> Bool # | |||||
| HasPropertyName Discriminator Text Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text Text, b ~ InsOrdHashMap Text Text) => LabelOptic "mapping" k Discriminator Discriminator a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Discriminator Discriminator a b # | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "propertyName" k Discriminator Discriminator a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Discriminator Discriminator a b # | |||||
| HasDiscriminator Schema (Maybe Discriminator) Source # | |||||
Defined in Data.OpenApi.Lens Methods discriminator :: Lens' Schema (Maybe Discriminator) Source # | |||||
| HasMapping Discriminator (InsOrdHashMap Text Text) Source # | |||||
Defined in Data.OpenApi.Lens Methods mapping :: Lens' Discriminator (InsOrdHashMap Text Text) Source # | |||||
| type Rep Discriminator Source # | |||||
Defined in Data.OpenApi.Internal type Rep Discriminator = D1 ('MetaData "Discriminator" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Discriminator" 'PrefixI 'True) (S1 ('MetaSel ('Just "_discriminatorPropertyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_discriminatorMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Text)))) | |||||
data NamedSchema Source #
A Schema
Constructors
| NamedSchema | |
Fields | |
Instances
| Data NamedSchema Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NamedSchema -> c NamedSchema # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NamedSchema # toConstr :: NamedSchema -> Constr # dataTypeOf :: NamedSchema -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NamedSchema) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NamedSchema) # gmapT :: (forall b. Data b => b -> b) -> NamedSchema -> NamedSchema # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NamedSchema -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NamedSchema -> r # gmapQ :: (forall d. Data d => d -> u) -> NamedSchema -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NamedSchema -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NamedSchema -> m NamedSchema # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NamedSchema -> m NamedSchema # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NamedSchema -> m NamedSchema # | |||||
| Generic NamedSchema Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show NamedSchema Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> NamedSchema -> ShowS # show :: NamedSchema -> String # showList :: [NamedSchema] -> ShowS # | |||||
| Eq NamedSchema Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasSchema NamedSchema Schema Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe OpenApiItems, b ~ Maybe OpenApiItems) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (k ~ A_Lens, a ~ Schema, b ~ Schema) => LabelOptic "schema" k NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe OpenApiType, b ~ Maybe OpenApiType) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| (a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b # | |||||
| HasName NamedSchema (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasType NamedSchema (Maybe OpenApiType) Source # | |||||
Defined in Data.OpenApi.Lens Methods type_ :: Lens' NamedSchema (Maybe OpenApiType) Source # | |||||
| type Rep NamedSchema Source # | |||||
Defined in Data.OpenApi.Internal type Rep NamedSchema = D1 ('MetaData "NamedSchema" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "NamedSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "_namedSchemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_namedSchemaSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Schema))) | |||||
Constructors
| Xml | |
Fields
| |
Instances
| FromJSON Xml Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Xml Source # | |||||
| Data Xml Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Xml -> c Xml # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Xml # dataTypeOf :: Xml -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Xml) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Xml) # gmapT :: (forall b. Data b => b -> b) -> Xml -> Xml # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Xml -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Xml -> r # gmapQ :: (forall d. Data d => d -> u) -> Xml -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Xml -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Xml -> m Xml # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Xml -> m Xml # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Xml -> m Xml # | |||||
| Generic Xml Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Xml Source # | |||||
| Eq Xml Source # | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "attribute" k Xml Xml a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k Xml Xml a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "namespace" k Xml Xml a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "prefix" k Xml Xml a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "wrapped" k Xml Xml a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasAttribute Xml (Maybe Bool) Source # | |||||
| HasName Xml (Maybe Text) Source # | |||||
| HasNamespace Xml (Maybe Text) Source # | |||||
| HasPrefix Xml (Maybe Text) Source # | |||||
| HasWrapped Xml (Maybe Bool) Source # | |||||
| HasXml Schema (Maybe Xml) Source # | |||||
| type Rep Xml Source # | |||||
Defined in Data.OpenApi.Internal type Rep Xml = D1 ('MetaData "Xml" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Xml" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_xmlName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_xmlNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_xmlPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_xmlAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_xmlWrapped") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))) | |||||
A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.
Constructors
| Responses | |
Fields
| |
Instances
| FromJSON Responses Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Responses Source # | |||||
| Data Responses Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Responses -> c Responses # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Responses # toConstr :: Responses -> Constr # dataTypeOf :: Responses -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Responses) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Responses) # gmapT :: (forall b. Data b => b -> b) -> Responses -> Responses # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Responses -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Responses -> r # gmapQ :: (forall d. Data d => d -> u) -> Responses -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Responses -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Responses -> m Responses # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Responses -> m Responses # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Responses -> m Responses # | |||||
| Monoid Responses Source # | |||||
| Semigroup Responses Source # | |||||
| Generic Responses Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Responses Source # | |||||
| Generic Responses Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo Responses Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Responses -> DatatypeInfo (Code Responses) # | |||||
| Eq Responses Source # | |||||
| At Responses Source # | |||||
| Ixed Responses Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| AesonDefaultValue Responses Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasSwaggerAesonOptions Responses Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Responses -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Responses -> POP Maybe (Code Responses) Source # | |||||
| SwaggerMonoid Responses Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerMempty :: Responses Source # swaggerMappend :: Responses -> Responses -> Responses Source # | |||||
| At Responses Source # | |||||
| Ixed Responses Source # | |||||
| HasResponses Operation Responses Source # | |||||
| (k ~ A_Lens, a ~ Maybe (Referenced Response), b ~ Maybe (Referenced Response)) => LabelOptic "default" k Responses Responses a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap HttpStatusCode (Referenced Response), b ~ InsOrdHashMap HttpStatusCode (Referenced Response)) => LabelOptic "responses" k Responses Responses a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDefault Responses (Maybe (Referenced Response)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |||||
Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |||||
| type Rep Responses Source # | |||||
Defined in Data.OpenApi.Internal type Rep Responses = D1 ('MetaData "Responses" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Responses" 'PrefixI 'True) (S1 ('MetaSel ('Just "_responsesDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Response))) :*: S1 ('MetaSel ('Just "_responsesResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HttpStatusCode (Referenced Response))))) | |||||
| type Code Responses Source # | |||||
Defined in Data.OpenApi.Internal type Code Responses = '['[Maybe (Referenced Response), InsOrdHashMap HttpStatusCode (Referenced Response)]] | |||||
| type DatatypeInfoOf Responses Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Responses = 'ADT "Data.OpenApi.Internal" "Responses" '['Record "Responses" '['FieldInfo "_responsesDefault", 'FieldInfo "_responsesResponses"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
| type Index Responses Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type IxValue Responses Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Index Responses Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| type IxKind Responses Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| type IxValue Responses Source # | |||||
Defined in Data.OpenApi.Optics | |||||
type HttpStatusCode = Int Source #
Describes a single response from an API Operation.
Constructors
| Response | |
Fields
| |
Instances
| FromJSON Response Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Response Source # | |||||
| Data Response Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Response -> c Response # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Response # toConstr :: Response -> Constr # dataTypeOf :: Response -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Response) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Response) # gmapT :: (forall b. Data b => b -> b) -> Response -> Response # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Response -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Response -> r # gmapQ :: (forall d. Data d => d -> u) -> Response -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Response -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Response -> m Response # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Response -> m Response # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Response -> m Response # | |||||
| IsString Response Source # | |||||
Defined in Data.OpenApi.Internal Methods fromString :: String -> Response # | |||||
| Monoid Response Source # | |||||
| Semigroup Response Source # | |||||
| Generic Response Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Response Source # | |||||
| Generic Response Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo Response Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Response -> DatatypeInfo (Code Response) # | |||||
| Eq Response Source # | |||||
| HasSwaggerAesonOptions Response Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Response -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Response -> POP Maybe (Code Response) Source # | |||||
| SwaggerMonoid Response Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasDescription Response Text Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap MediaType MediaTypeObject, b ~ InsOrdHashMap MediaType MediaTypeObject) => LabelOptic "content" k Response Response a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "description" k Response Response a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap HeaderName (Referenced Header), b ~ InsOrdHashMap HeaderName (Referenced Header)) => LabelOptic "headers" k Response Response a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Link), b ~ InsOrdHashMap Text (Referenced Link)) => LabelOptic "links" k Response Response a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDefault Responses (Maybe (Referenced Response)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasResponses Components (Definitions Response) Source # | |||||
Defined in Data.OpenApi.Lens Methods responses :: Lens' Components (Definitions Response) Source # | |||||
| HasContent Response (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
Defined in Data.OpenApi.Lens Methods content :: Lens' Response (InsOrdHashMap MediaType MediaTypeObject) Source # | |||||
| HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |||||
Defined in Data.OpenApi.Lens Methods headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |||||
| HasLinks Response (InsOrdHashMap Text (Referenced Link)) Source # | |||||
Defined in Data.OpenApi.Lens Methods links :: Lens' Response (InsOrdHashMap Text (Referenced Link)) Source # | |||||
| HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |||||
Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |||||
| FromJSON (Referenced Response) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Response) # parseJSONList :: Value -> Parser [Referenced Response] # omittedField :: Maybe (Referenced Response) # | |||||
| ToJSON (Referenced Response) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Response -> Value # toEncoding :: Referenced Response -> Encoding # toJSONList :: [Referenced Response] -> Value # toEncodingList :: [Referenced Response] -> Encoding # omitField :: Referenced Response -> Bool # | |||||
| type Rep Response Source # | |||||
Defined in Data.OpenApi.Internal type Rep Response = D1 ('MetaData "Response" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Response" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_responseDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_responseContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap MediaType MediaTypeObject))) :*: (S1 ('MetaSel ('Just "_responseHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HeaderName (Referenced Header))) :*: S1 ('MetaSel ('Just "_responseLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Link)))))) | |||||
| type Code Response Source # | |||||
Defined in Data.OpenApi.Internal type Code Response = '['[Text, InsOrdHashMap MediaType MediaTypeObject, InsOrdHashMap HeaderName (Referenced Header), InsOrdHashMap Text (Referenced Link)]] | |||||
| type DatatypeInfoOf Response Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Response = 'ADT "Data.OpenApi.Internal" "Response" '['Record "Response" '['FieldInfo "_responseDescription", 'FieldInfo "_responseContent", 'FieldInfo "_responseHeaders", 'FieldInfo "_responseLinks"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
A map of possible out-of band callbacks related to the parent operation.
Each value in the map is a PathItem Object that describes a set of requests that
may be initiated by the API provider and the expected responses.
The key value used to identify the path item object is an expression, evaluated at runtime,
that identifies a URL to use for the callback operation.
Constructors
| Callback (InsOrdHashMap Text PathItem) |
Instances
| FromJSON Callback Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Callback Source # | |||||
| Data Callback Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Callback -> c Callback # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Callback # toConstr :: Callback -> Constr # dataTypeOf :: Callback -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Callback) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Callback) # gmapT :: (forall b. Data b => b -> b) -> Callback -> Callback # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Callback -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Callback -> r # gmapQ :: (forall d. Data d => d -> u) -> Callback -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Callback -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Callback -> m Callback # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Callback -> m Callback # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Callback -> m Callback # | |||||
| Generic Callback Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Callback Source # | |||||
| Eq Callback Source # | |||||
| HasCallbacks Components (Definitions Callback) Source # | |||||
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Components (Definitions Callback) Source # | |||||
| HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |||||
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |||||
| FromJSON (Referenced Callback) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Callback) # parseJSONList :: Value -> Parser [Referenced Callback] # omittedField :: Maybe (Referenced Callback) # | |||||
| ToJSON (Referenced Callback) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Callback -> Value # toEncoding :: Referenced Callback -> Encoding # toJSONList :: [Referenced Callback] -> Value # toEncodingList :: [Referenced Callback] -> Encoding # omitField :: Referenced Callback -> Bool # | |||||
| type Rep Callback Source # | |||||
Defined in Data.OpenApi.Internal | |||||
type HeaderName = Text Source #
Header fields have the same meaning as for Param.
Style is always treated as StyleSimple, as it is the only value allowed for headers.
Constructors
| Header | |
Fields
| |
Instances
| FromJSON Header Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Header Source # | |||||
| Data Header Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Header -> c Header # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Header # toConstr :: Header -> Constr # dataTypeOf :: Header -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Header) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Header) # gmapT :: (forall b. Data b => b -> b) -> Header -> Header # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r # gmapQ :: (forall d. Data d => d -> u) -> Header -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Header -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Header -> m Header # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Header -> m Header # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Header -> m Header # | |||||
| Monoid Header Source # | |||||
| Semigroup Header Source # | |||||
| Generic Header Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Header Source # | |||||
| Generic Header Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo Header Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy Header -> DatatypeInfo (Code Header) # | |||||
| Eq Header Source # | |||||
| HasSwaggerAesonOptions Header Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Header -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Header -> POP Maybe (Code Header) Source # | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowEmptyValue" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe HeaderName, b ~ Maybe HeaderName) => LabelOptic "description" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Example), b ~ InsOrdHashMap Text (Referenced Example)) => LabelOptic "examples" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "explode" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k Header Header a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasAllowEmptyValue Header (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDeprecated Header (Maybe Bool) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasDescription Header (Maybe HeaderName) Source # | |||||
Defined in Data.OpenApi.Lens Methods description :: Lens' Header (Maybe HeaderName) Source # | |||||
| HasExample Header (Maybe Value) Source # | |||||
| HasExplode Header (Maybe Bool) Source # | |||||
| HasHeaders Components (Definitions Header) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasRequired Header (Maybe Bool) Source # | |||||
| HasSchema Header (Maybe (Referenced Schema)) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # | |||||
Defined in Data.OpenApi.Lens Methods examples :: Lens' Header (InsOrdHashMap Text (Referenced Example)) Source # | |||||
| HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |||||
Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |||||
| HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |||||
Defined in Data.OpenApi.Lens Methods headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |||||
| FromJSON (Referenced Header) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Header) # parseJSONList :: Value -> Parser [Referenced Header] # omittedField :: Maybe (Referenced Header) # | |||||
| ToJSON (Referenced Header) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Header -> Value # toEncoding :: Referenced Header -> Encoding # toJSONList :: [Referenced Header] -> Value # toEncodingList :: [Referenced Header] -> Encoding # omitField :: Referenced Header -> Bool # | |||||
| type Rep Header Source # | |||||
Defined in Data.OpenApi.Internal type Rep Header = D1 ('MetaData "Header" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Header" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_headerDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HeaderName)) :*: S1 ('MetaSel ('Just "_headerRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "_headerDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_headerAllowEmptyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "_headerExplode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_headerExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "_headerExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Example))) :*: S1 ('MetaSel ('Just "_headerSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))))))) | |||||
| type Code Header Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf Header Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf Header = 'ADT "Data.OpenApi.Internal" "Header" '['Record "Header" '['FieldInfo "_headerDescription", 'FieldInfo "_headerRequired", 'FieldInfo "_headerDeprecated", 'FieldInfo "_headerAllowEmptyValue", 'FieldInfo "_headerExplode", 'FieldInfo "_headerExample", 'FieldInfo "_headerExamples", 'FieldInfo "_headerSchema"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
data ApiKeyLocation Source #
The location of the API key.
Constructors
| ApiKeyQuery | |
| ApiKeyHeader | |
| ApiKeyCookie |
Instances
| FromJSON ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ApiKeyLocation # parseJSONList :: Value -> Parser [ApiKeyLocation] # | |||||
| ToJSON ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: ApiKeyLocation -> Value # toEncoding :: ApiKeyLocation -> Encoding # toJSONList :: [ApiKeyLocation] -> Value # toEncodingList :: [ApiKeyLocation] -> Encoding # omitField :: ApiKeyLocation -> Bool # | |||||
| Data ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApiKeyLocation -> c ApiKeyLocation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApiKeyLocation # toConstr :: ApiKeyLocation -> Constr # dataTypeOf :: ApiKeyLocation -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ApiKeyLocation) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApiKeyLocation) # gmapT :: (forall b. Data b => b -> b) -> ApiKeyLocation -> ApiKeyLocation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApiKeyLocation -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ApiKeyLocation -> r # gmapQ :: (forall d. Data d => d -> u) -> ApiKeyLocation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ApiKeyLocation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ApiKeyLocation -> m ApiKeyLocation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ApiKeyLocation -> m ApiKeyLocation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ApiKeyLocation -> m ApiKeyLocation # | |||||
| Generic ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: ApiKeyLocation -> Rep ApiKeyLocation x # to :: Rep ApiKeyLocation x -> ApiKeyLocation # | |||||
| Show ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ApiKeyLocation -> ShowS # show :: ApiKeyLocation -> String # showList :: [ApiKeyLocation] -> ShowS # | |||||
| Eq ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: ApiKeyLocation -> ApiKeyLocation -> Bool # (/=) :: ApiKeyLocation -> ApiKeyLocation -> Bool # | |||||
| type Rep ApiKeyLocation Source # | |||||
Defined in Data.OpenApi.Internal type Rep ApiKeyLocation = D1 ('MetaData "ApiKeyLocation" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "ApiKeyQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ApiKeyHeader" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ApiKeyCookie" 'PrefixI 'False) (U1 :: Type -> Type))) | |||||
data ApiKeyParams Source #
Constructors
| ApiKeyParams | |
Fields
| |
Instances
| FromJSON ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: ApiKeyParams -> Value # toEncoding :: ApiKeyParams -> Encoding # toJSONList :: [ApiKeyParams] -> Value # toEncodingList :: [ApiKeyParams] -> Encoding # omitField :: ApiKeyParams -> Bool # | |||||
| Data ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApiKeyParams -> c ApiKeyParams # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApiKeyParams # toConstr :: ApiKeyParams -> Constr # dataTypeOf :: ApiKeyParams -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ApiKeyParams) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApiKeyParams) # gmapT :: (forall b. Data b => b -> b) -> ApiKeyParams -> ApiKeyParams # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApiKeyParams -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ApiKeyParams -> r # gmapQ :: (forall d. Data d => d -> u) -> ApiKeyParams -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ApiKeyParams -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ApiKeyParams -> m ApiKeyParams # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ApiKeyParams -> m ApiKeyParams # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ApiKeyParams -> m ApiKeyParams # | |||||
| Generic ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ApiKeyParams -> ShowS # show :: ApiKeyParams -> String # showList :: [ApiKeyParams] -> ShowS # | |||||
| Eq ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type Rep ApiKeyParams Source # | |||||
Defined in Data.OpenApi.Internal type Rep ApiKeyParams = D1 ('MetaData "ApiKeyParams" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "ApiKeyParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "_apiKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_apiKeyIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiKeyLocation))) | |||||
type AuthorizationURL = Text Source #
The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
newtype OAuth2ImplicitFlow Source #
Constructors
| OAuth2ImplicitFlow | |
Instances
| FromJSON OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2ImplicitFlow # parseJSONList :: Value -> Parser [OAuth2ImplicitFlow] # | |||||
| ToJSON OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2ImplicitFlow -> Value # toEncoding :: OAuth2ImplicitFlow -> Encoding # toJSONList :: [OAuth2ImplicitFlow] -> Value # toEncodingList :: [OAuth2ImplicitFlow] -> Encoding # omitField :: OAuth2ImplicitFlow -> Bool # | |||||
| Data OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2ImplicitFlow -> c OAuth2ImplicitFlow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2ImplicitFlow # toConstr :: OAuth2ImplicitFlow -> Constr # dataTypeOf :: OAuth2ImplicitFlow -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2ImplicitFlow) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2ImplicitFlow) # gmapT :: (forall b. Data b => b -> b) -> OAuth2ImplicitFlow -> OAuth2ImplicitFlow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2ImplicitFlow -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2ImplicitFlow -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth2ImplicitFlow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2ImplicitFlow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2ImplicitFlow -> m OAuth2ImplicitFlow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2ImplicitFlow -> m OAuth2ImplicitFlow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2ImplicitFlow -> m OAuth2ImplicitFlow # | |||||
| Generic OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: OAuth2ImplicitFlow -> Rep OAuth2ImplicitFlow x # to :: Rep OAuth2ImplicitFlow x -> OAuth2ImplicitFlow # | |||||
| Show OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2ImplicitFlow -> ShowS # show :: OAuth2ImplicitFlow -> String # showList :: [OAuth2ImplicitFlow] -> ShowS # | |||||
| Eq OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: OAuth2ImplicitFlow -> OAuth2ImplicitFlow -> Bool # (/=) :: OAuth2ImplicitFlow -> OAuth2ImplicitFlow -> Bool # | |||||
| AesonDefaultValue OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasAuthorizationUrl OAuth2ImplicitFlow AuthorizationURL Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ An_Iso, a ~ AuthorizationURL, b ~ AuthorizationURL) => LabelOptic "authorizationUrl" k OAuth2ImplicitFlow OAuth2ImplicitFlow a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2ImplicitFlow OAuth2ImplicitFlow a b # | |||||
| HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |||||
| type Rep OAuth2ImplicitFlow Source # | |||||
Defined in Data.OpenApi.Internal type Rep OAuth2ImplicitFlow = D1 ('MetaData "OAuth2ImplicitFlow" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'True) (C1 ('MetaCons "OAuth2ImplicitFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2ImplicitFlowAuthorizationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL))) | |||||
newtype OAuth2PasswordFlow Source #
Constructors
| OAuth2PasswordFlow | |
Fields | |
Instances
| FromJSON OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2PasswordFlow # parseJSONList :: Value -> Parser [OAuth2PasswordFlow] # | |||||
| ToJSON OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2PasswordFlow -> Value # toEncoding :: OAuth2PasswordFlow -> Encoding # toJSONList :: [OAuth2PasswordFlow] -> Value # toEncodingList :: [OAuth2PasswordFlow] -> Encoding # omitField :: OAuth2PasswordFlow -> Bool # | |||||
| Data OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2PasswordFlow -> c OAuth2PasswordFlow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2PasswordFlow # toConstr :: OAuth2PasswordFlow -> Constr # dataTypeOf :: OAuth2PasswordFlow -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2PasswordFlow) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2PasswordFlow) # gmapT :: (forall b. Data b => b -> b) -> OAuth2PasswordFlow -> OAuth2PasswordFlow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2PasswordFlow -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2PasswordFlow -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth2PasswordFlow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2PasswordFlow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2PasswordFlow -> m OAuth2PasswordFlow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2PasswordFlow -> m OAuth2PasswordFlow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2PasswordFlow -> m OAuth2PasswordFlow # | |||||
| Generic OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: OAuth2PasswordFlow -> Rep OAuth2PasswordFlow x # to :: Rep OAuth2PasswordFlow x -> OAuth2PasswordFlow # | |||||
| Show OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2PasswordFlow -> ShowS # show :: OAuth2PasswordFlow -> String # showList :: [OAuth2PasswordFlow] -> ShowS # | |||||
| Eq OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: OAuth2PasswordFlow -> OAuth2PasswordFlow -> Bool # (/=) :: OAuth2PasswordFlow -> OAuth2PasswordFlow -> Bool # | |||||
| AesonDefaultValue OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasTokenUrl OAuth2PasswordFlow TokenURL Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ An_Iso, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2PasswordFlow OAuth2PasswordFlow a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2PasswordFlow OAuth2PasswordFlow a b # | |||||
| HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |||||
| type Rep OAuth2PasswordFlow Source # | |||||
Defined in Data.OpenApi.Internal type Rep OAuth2PasswordFlow = D1 ('MetaData "OAuth2PasswordFlow" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'True) (C1 ('MetaCons "OAuth2PasswordFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2PasswordFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL))) | |||||
newtype OAuth2ClientCredentialsFlow Source #
Constructors
| OAuth2ClientCredentialsFlow | |
Instances
| FromJSON OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2ClientCredentialsFlow -> Value # toEncoding :: OAuth2ClientCredentialsFlow -> Encoding # toJSONList :: [OAuth2ClientCredentialsFlow] -> Value # toEncodingList :: [OAuth2ClientCredentialsFlow] -> Encoding # | |||||
| Data OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2ClientCredentialsFlow -> c OAuth2ClientCredentialsFlow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2ClientCredentialsFlow # toConstr :: OAuth2ClientCredentialsFlow -> Constr # dataTypeOf :: OAuth2ClientCredentialsFlow -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2ClientCredentialsFlow) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2ClientCredentialsFlow) # gmapT :: (forall b. Data b => b -> b) -> OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2ClientCredentialsFlow -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2ClientCredentialsFlow -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth2ClientCredentialsFlow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2ClientCredentialsFlow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2ClientCredentialsFlow -> m OAuth2ClientCredentialsFlow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2ClientCredentialsFlow -> m OAuth2ClientCredentialsFlow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2ClientCredentialsFlow -> m OAuth2ClientCredentialsFlow # | |||||
| Generic OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: OAuth2ClientCredentialsFlow -> Rep OAuth2ClientCredentialsFlow x # to :: Rep OAuth2ClientCredentialsFlow x -> OAuth2ClientCredentialsFlow # | |||||
| Show OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2ClientCredentialsFlow -> ShowS # show :: OAuth2ClientCredentialsFlow -> String # showList :: [OAuth2ClientCredentialsFlow] -> ShowS # | |||||
| Eq OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow -> Bool # (/=) :: OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow -> Bool # | |||||
| AesonDefaultValue OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasTokenUrl OAuth2ClientCredentialsFlow TokenURL Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ An_Iso, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b # | |||||
| HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods clientCredentials :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # | |||||
| type Rep OAuth2ClientCredentialsFlow Source # | |||||
Defined in Data.OpenApi.Internal type Rep OAuth2ClientCredentialsFlow = D1 ('MetaData "OAuth2ClientCredentialsFlow" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'True) (C1 ('MetaCons "OAuth2ClientCredentialsFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2ClientCredentialsFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL))) | |||||
data OAuth2AuthorizationCodeFlow Source #
Constructors
| OAuth2AuthorizationCodeFlow | |
Instances
| FromJSON OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2AuthorizationCodeFlow -> Value # toEncoding :: OAuth2AuthorizationCodeFlow -> Encoding # toJSONList :: [OAuth2AuthorizationCodeFlow] -> Value # toEncodingList :: [OAuth2AuthorizationCodeFlow] -> Encoding # | |||||
| Data OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2AuthorizationCodeFlow -> c OAuth2AuthorizationCodeFlow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2AuthorizationCodeFlow # toConstr :: OAuth2AuthorizationCodeFlow -> Constr # dataTypeOf :: OAuth2AuthorizationCodeFlow -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2AuthorizationCodeFlow) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2AuthorizationCodeFlow) # gmapT :: (forall b. Data b => b -> b) -> OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2AuthorizationCodeFlow -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2AuthorizationCodeFlow -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth2AuthorizationCodeFlow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2AuthorizationCodeFlow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2AuthorizationCodeFlow -> m OAuth2AuthorizationCodeFlow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2AuthorizationCodeFlow -> m OAuth2AuthorizationCodeFlow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2AuthorizationCodeFlow -> m OAuth2AuthorizationCodeFlow # | |||||
| Generic OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: OAuth2AuthorizationCodeFlow -> Rep OAuth2AuthorizationCodeFlow x # to :: Rep OAuth2AuthorizationCodeFlow x -> OAuth2AuthorizationCodeFlow # | |||||
| Show OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2AuthorizationCodeFlow -> ShowS # show :: OAuth2AuthorizationCodeFlow -> String # showList :: [OAuth2AuthorizationCodeFlow] -> ShowS # | |||||
| Eq OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow -> Bool # (/=) :: OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow -> Bool # | |||||
| AesonDefaultValue OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasAuthorizationUrl OAuth2AuthorizationCodeFlow AuthorizationURL Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasTokenUrl OAuth2AuthorizationCodeFlow TokenURL Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ A_Lens, a ~ AuthorizationURL, b ~ AuthorizationURL) => LabelOptic "authorizationUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b # | |||||
| (k ~ A_Lens, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b # | |||||
| HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods authorizationCode :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # | |||||
| type Rep OAuth2AuthorizationCodeFlow Source # | |||||
Defined in Data.OpenApi.Internal type Rep OAuth2AuthorizationCodeFlow = D1 ('MetaData "OAuth2AuthorizationCodeFlow" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "OAuth2AuthorizationCodeFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2AuthorizationCodeFlowAuthorizationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL) :*: S1 ('MetaSel ('Just "_oAuth2AuthorizationCodeFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL))) | |||||
data OAuth2Flow p Source #
Constructors
| OAuth2Flow | |
Fields
| |
Instances
| HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods authorizationCode :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # | |||||
| HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods clientCredentials :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # | |||||
| HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |||||
| HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |||||
| (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (OAuth2Flow p) # parseJSONList :: Value -> Parser [OAuth2Flow p] # omittedField :: Maybe (OAuth2Flow p) # | |||||
| (Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2Flow p -> Value # toEncoding :: OAuth2Flow p -> Encoding # toJSONList :: [OAuth2Flow p] -> Value # toEncodingList :: [OAuth2Flow p] -> Encoding # omitField :: OAuth2Flow p -> Bool # | |||||
| Data p => Data (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2Flow p -> c (OAuth2Flow p) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (OAuth2Flow p) # toConstr :: OAuth2Flow p -> Constr # dataTypeOf :: OAuth2Flow p -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (OAuth2Flow p)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (OAuth2Flow p)) # gmapT :: (forall b. Data b => b -> b) -> OAuth2Flow p -> OAuth2Flow p # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flow p -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flow p -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth2Flow p -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2Flow p -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2Flow p -> m (OAuth2Flow p) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flow p -> m (OAuth2Flow p) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flow p -> m (OAuth2Flow p) # | |||||
| Semigroup (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: OAuth2Flow p -> OAuth2Flow p -> OAuth2Flow p # sconcat :: NonEmpty (OAuth2Flow p) -> OAuth2Flow p # stimes :: Integral b => b -> OAuth2Flow p -> OAuth2Flow p # | |||||
| Generic (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show p => Show (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2Flow p -> ShowS # show :: OAuth2Flow p -> String # showList :: [OAuth2Flow p] -> ShowS # | |||||
| Generic (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy (OAuth2Flow p) -> DatatypeInfo (Code (OAuth2Flow p)) # | |||||
| Eq p => Eq (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe (OAuth2Flow p) Source # | |||||
| AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy (OAuth2Flow p) -> SwaggerAesonOptions Source # aesonDefaults :: Proxy (OAuth2Flow p) -> POP Maybe (Code (OAuth2Flow p)) Source # | |||||
| type Rep (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal type Rep (OAuth2Flow p) = D1 ('MetaData "OAuth2Flow" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "OAuth2Flow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2Params") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 p) :*: (S1 ('MetaSel ('Just "_oAath2RefreshUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)) :*: S1 ('MetaSel ('Just "_oAuth2Scopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Text))))) | |||||
| type Code (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf (OAuth2Flow p) Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf (OAuth2Flow p) = 'ADT "Data.OpenApi.Internal" "OAuth2Flow" '['Record "OAuth2Flow" '['FieldInfo "_oAuth2Params", 'FieldInfo "_oAath2RefreshUrl", 'FieldInfo "_oAuth2Scopes"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
data OAuth2Flows Source #
Constructors
| OAuth2Flows | |
Fields
| |
Instances
| FromJSON OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2Flows -> Value # toEncoding :: OAuth2Flows -> Encoding # toJSONList :: [OAuth2Flows] -> Value # toEncodingList :: [OAuth2Flows] -> Encoding # omitField :: OAuth2Flows -> Bool # | |||||
| Data OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2Flows -> c OAuth2Flows # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2Flows # toConstr :: OAuth2Flows -> Constr # dataTypeOf :: OAuth2Flows -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2Flows) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2Flows) # gmapT :: (forall b. Data b => b -> b) -> OAuth2Flows -> OAuth2Flows # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flows -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flows -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth2Flows -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2Flows -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2Flows -> m OAuth2Flows # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flows -> m OAuth2Flows # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flows -> m OAuth2Flows # | |||||
| Monoid OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Methods mempty :: OAuth2Flows # mappend :: OAuth2Flows -> OAuth2Flows -> OAuth2Flows # mconcat :: [OAuth2Flows] -> OAuth2Flows # | |||||
| Semigroup OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: OAuth2Flows -> OAuth2Flows -> OAuth2Flows # sconcat :: NonEmpty OAuth2Flows -> OAuth2Flows # stimes :: Integral b => b -> OAuth2Flows -> OAuth2Flows # | |||||
| Generic OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2Flows -> ShowS # show :: OAuth2Flows -> String # showList :: [OAuth2Flows] -> ShowS # | |||||
| Generic OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy OAuth2Flows -> DatatypeInfo (Code OAuth2Flows) # | |||||
| Eq OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasSwaggerAesonOptions OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy OAuth2Flows -> SwaggerAesonOptions Source # aesonDefaults :: Proxy OAuth2Flows -> POP Maybe (Code OAuth2Flows) Source # | |||||
| (k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow), b ~ Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) => LabelOptic "authorizationCode" k OAuth2Flows OAuth2Flows a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b # | |||||
| (k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2ClientCredentialsFlow), b ~ Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) => LabelOptic "clientCredentials" k OAuth2Flows OAuth2Flows a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b # | |||||
| (k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2ImplicitFlow), b ~ Maybe (OAuth2Flow OAuth2ImplicitFlow)) => LabelOptic "implicit" k OAuth2Flows OAuth2Flows a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b # | |||||
| (k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2PasswordFlow), b ~ Maybe (OAuth2Flow OAuth2PasswordFlow)) => LabelOptic "password" k OAuth2Flows OAuth2Flows a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b # | |||||
| HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods authorizationCode :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # | |||||
| HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods clientCredentials :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # | |||||
| HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |||||
| HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |||||
Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |||||
| type Rep OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal type Rep OAuth2Flows = D1 ('MetaData "OAuth2Flows" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "OAuth2Flows" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_oAuth2FlowsImplicit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2ImplicitFlow))) :*: S1 ('MetaSel ('Just "_oAuth2FlowsPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2PasswordFlow)))) :*: (S1 ('MetaSel ('Just "_oAuth2FlowsClientCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))) :*: S1 ('MetaSel ('Just "_oAuth2FlowsAuthorizationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)))))) | |||||
| type Code OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf OAuth2Flows Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf OAuth2Flows = 'ADT "Data.OpenApi.Internal" "OAuth2Flows" '['Record "OAuth2Flows" '['FieldInfo "_oAuth2FlowsImplicit", 'FieldInfo "_oAuth2FlowsPassword", 'FieldInfo "_oAuth2FlowsClientCredentials", 'FieldInfo "_oAuth2FlowsAuthorizationCode"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
type BearerFormat = Text Source #
data HttpSchemeType Source #
Constructors
| HttpSchemeBearer (Maybe BearerFormat) | |
| HttpSchemeBasic | |
| HttpSchemeCustom Text |
Instances
| Data HttpSchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HttpSchemeType -> c HttpSchemeType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HttpSchemeType # toConstr :: HttpSchemeType -> Constr # dataTypeOf :: HttpSchemeType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HttpSchemeType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HttpSchemeType) # gmapT :: (forall b. Data b => b -> b) -> HttpSchemeType -> HttpSchemeType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HttpSchemeType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HttpSchemeType -> r # gmapQ :: (forall d. Data d => d -> u) -> HttpSchemeType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> HttpSchemeType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> HttpSchemeType -> m HttpSchemeType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HttpSchemeType -> m HttpSchemeType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HttpSchemeType -> m HttpSchemeType # | |||||
| Generic HttpSchemeType Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: HttpSchemeType -> Rep HttpSchemeType x # to :: Rep HttpSchemeType x -> HttpSchemeType # | |||||
| Show HttpSchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> HttpSchemeType -> ShowS # show :: HttpSchemeType -> String # showList :: [HttpSchemeType] -> ShowS # | |||||
| Eq HttpSchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: HttpSchemeType -> HttpSchemeType -> Bool # (/=) :: HttpSchemeType -> HttpSchemeType -> Bool # | |||||
| type Rep HttpSchemeType Source # | |||||
Defined in Data.OpenApi.Internal type Rep HttpSchemeType = D1 ('MetaData "HttpSchemeType" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "HttpSchemeBearer" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BearerFormat))) :+: (C1 ('MetaCons "HttpSchemeBasic" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HttpSchemeCustom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) | |||||
data SecuritySchemeType Source #
>>>BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer Nothing)){ "scheme": "bearer", "type": "http" }
>>>BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt"))){ "bearerFormat": "jwt", "scheme": "bearer", "type": "http" }
>>>BSL.putStrLn $ encodePretty (SecuritySchemeHttp HttpSchemeBasic){ "scheme": "basic", "type": "http" }
>>>BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeCustom "CANARY")){ "scheme": "CANARY", "type": "http" }
>>>BSL.putStrLn $ encodePretty (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie)){ "in": "cookie", "name": "id", "type": "apiKey" }
Constructors
| SecuritySchemeHttp HttpSchemeType | |
| SecuritySchemeApiKey ApiKeyParams | |
| SecuritySchemeOAuth2 OAuth2Flows | |
| SecuritySchemeOpenIdConnect URL |
Instances
| FromJSON SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecuritySchemeType # parseJSONList :: Value -> Parser [SecuritySchemeType] # | |||||
| ToJSON SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: SecuritySchemeType -> Value # toEncoding :: SecuritySchemeType -> Encoding # toJSONList :: [SecuritySchemeType] -> Value # toEncodingList :: [SecuritySchemeType] -> Encoding # omitField :: SecuritySchemeType -> Bool # | |||||
| Data SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecuritySchemeType -> c SecuritySchemeType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecuritySchemeType # toConstr :: SecuritySchemeType -> Constr # dataTypeOf :: SecuritySchemeType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SecuritySchemeType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecuritySchemeType) # gmapT :: (forall b. Data b => b -> b) -> SecuritySchemeType -> SecuritySchemeType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecuritySchemeType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecuritySchemeType -> r # gmapQ :: (forall d. Data d => d -> u) -> SecuritySchemeType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SecuritySchemeType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecuritySchemeType -> m SecuritySchemeType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecuritySchemeType -> m SecuritySchemeType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecuritySchemeType -> m SecuritySchemeType # | |||||
| Generic SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: SecuritySchemeType -> Rep SecuritySchemeType x # to :: Rep SecuritySchemeType x -> SecuritySchemeType # | |||||
| Show SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecuritySchemeType -> ShowS # show :: SecuritySchemeType -> String # showList :: [SecuritySchemeType] -> ShowS # | |||||
| Eq SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: SecuritySchemeType -> SecuritySchemeType -> Bool # (/=) :: SecuritySchemeType -> SecuritySchemeType -> Bool # | |||||
| AesonDefaultValue SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasType SecurityScheme SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| (k ~ A_Prism, a ~ ApiKeyParams, b ~ ApiKeyParams) => LabelOptic "_SecuritySchemeApiKey" k SecuritySchemeType SecuritySchemeType a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b # | |||||
| (k ~ A_Prism, a ~ HttpSchemeType, b ~ HttpSchemeType) => LabelOptic "_SecuritySchemeHttp" k SecuritySchemeType SecuritySchemeType a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b # | |||||
| (k ~ A_Prism, a ~ OAuth2Flows, b ~ OAuth2Flows) => LabelOptic "_SecuritySchemeOAuth2" k SecuritySchemeType SecuritySchemeType a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b # | |||||
| (k ~ A_Prism, a ~ URL, b ~ URL) => LabelOptic "_SecuritySchemeOpenIdConnect" k SecuritySchemeType SecuritySchemeType a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b # | |||||
| type Rep SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Internal type Rep SecuritySchemeType = D1 ('MetaData "SecuritySchemeType" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) ((C1 ('MetaCons "SecuritySchemeHttp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HttpSchemeType)) :+: C1 ('MetaCons "SecuritySchemeApiKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiKeyParams))) :+: (C1 ('MetaCons "SecuritySchemeOAuth2" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2Flows)) :+: C1 ('MetaCons "SecuritySchemeOpenIdConnect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URL)))) | |||||
data SecurityScheme Source #
Constructors
| SecurityScheme | |
Fields
| |
Instances
| FromJSON SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecurityScheme # parseJSONList :: Value -> Parser [SecurityScheme] # | |||||
| ToJSON SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: SecurityScheme -> Value # toEncoding :: SecurityScheme -> Encoding # toJSONList :: [SecurityScheme] -> Value # toEncodingList :: [SecurityScheme] -> Encoding # omitField :: SecurityScheme -> Bool # | |||||
| Data SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecurityScheme -> c SecurityScheme # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecurityScheme # toConstr :: SecurityScheme -> Constr # dataTypeOf :: SecurityScheme -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SecurityScheme) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecurityScheme) # gmapT :: (forall b. Data b => b -> b) -> SecurityScheme -> SecurityScheme # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecurityScheme -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecurityScheme -> r # gmapQ :: (forall d. Data d => d -> u) -> SecurityScheme -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SecurityScheme -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecurityScheme -> m SecurityScheme # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityScheme -> m SecurityScheme # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityScheme -> m SecurityScheme # | |||||
| Semigroup SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: SecurityScheme -> SecurityScheme -> SecurityScheme # sconcat :: NonEmpty SecurityScheme -> SecurityScheme # stimes :: Integral b => b -> SecurityScheme -> SecurityScheme # | |||||
| Generic SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: SecurityScheme -> Rep SecurityScheme x # to :: Rep SecurityScheme x -> SecurityScheme # | |||||
| Show SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecurityScheme -> ShowS # show :: SecurityScheme -> String # showList :: [SecurityScheme] -> ShowS # | |||||
| Generic SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| HasDatatypeInfo SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy SecurityScheme -> DatatypeInfo (Code SecurityScheme) # | |||||
| Eq SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: SecurityScheme -> SecurityScheme -> Bool # (/=) :: SecurityScheme -> SecurityScheme -> Bool # | |||||
| HasSwaggerAesonOptions SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy SecurityScheme -> SwaggerAesonOptions Source # aesonDefaults :: Proxy SecurityScheme -> POP Maybe (Code SecurityScheme) Source # | |||||
| HasType SecurityScheme SecuritySchemeType Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k SecurityScheme SecurityScheme a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b # | |||||
| (k ~ A_Lens, a ~ SecuritySchemeType, b ~ SecuritySchemeType) => LabelOptic "type" k SecurityScheme SecurityScheme a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b # | |||||
| HasDescription SecurityScheme (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| type Rep SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal type Rep SecurityScheme = D1 ('MetaData "SecurityScheme" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "SecurityScheme" 'PrefixI 'True) (S1 ('MetaSel ('Just "_securitySchemeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecuritySchemeType) :*: S1 ('MetaSel ('Just "_securitySchemeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) | |||||
| type Code SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf SecurityScheme Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf SecurityScheme = 'ADT "Data.OpenApi.Internal" "SecurityScheme" '['Record "SecurityScheme" '['FieldInfo "_securitySchemeType", 'FieldInfo "_securitySchemeDescription"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |||||
newtype SecurityDefinitions Source #
Constructors
| SecurityDefinitions (Definitions SecurityScheme) |
Instances
| FromJSON SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecurityDefinitions # parseJSONList :: Value -> Parser [SecurityDefinitions] # | |||||
| ToJSON SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: SecurityDefinitions -> Value # toEncoding :: SecurityDefinitions -> Encoding # toJSONList :: [SecurityDefinitions] -> Value # toEncodingList :: [SecurityDefinitions] -> Encoding # omitField :: SecurityDefinitions -> Bool # | |||||
| Data SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecurityDefinitions -> c SecurityDefinitions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecurityDefinitions # toConstr :: SecurityDefinitions -> Constr # dataTypeOf :: SecurityDefinitions -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SecurityDefinitions) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecurityDefinitions) # gmapT :: (forall b. Data b => b -> b) -> SecurityDefinitions -> SecurityDefinitions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecurityDefinitions -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecurityDefinitions -> r # gmapQ :: (forall d. Data d => d -> u) -> SecurityDefinitions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SecurityDefinitions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecurityDefinitions -> m SecurityDefinitions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityDefinitions -> m SecurityDefinitions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityDefinitions -> m SecurityDefinitions # | |||||
| Monoid SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods mempty :: SecurityDefinitions # mappend :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions # | |||||
| Semigroup SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions # sconcat :: NonEmpty SecurityDefinitions -> SecurityDefinitions # stimes :: Integral b => b -> SecurityDefinitions -> SecurityDefinitions # | |||||
| Generic SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: SecurityDefinitions -> Rep SecurityDefinitions x # to :: Rep SecurityDefinitions x -> SecurityDefinitions # | |||||
| Show SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecurityDefinitions -> ShowS # show :: SecurityDefinitions -> String # showList :: [SecurityDefinitions] -> ShowS # | |||||
| Eq SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: SecurityDefinitions -> SecurityDefinitions -> Bool # (/=) :: SecurityDefinitions -> SecurityDefinitions -> Bool # | |||||
| AesonDefaultValue SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| SwaggerMonoid SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasSecuritySchemes Components SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Lens Methods securitySchemes :: Lens' Components SecurityDefinitions Source # | |||||
| type Rep SecurityDefinitions Source # | |||||
Defined in Data.OpenApi.Internal type Rep SecurityDefinitions = D1 ('MetaData "SecurityDefinitions" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'True) (C1 ('MetaCons "SecurityDefinitions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions SecurityScheme)))) | |||||
newtype SecurityRequirement Source #
Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes).
Constructors
| SecurityRequirement | |
Fields | |
Instances
| FromJSON SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecurityRequirement # parseJSONList :: Value -> Parser [SecurityRequirement] # | |
| ToJSON SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: SecurityRequirement -> Value # toEncoding :: SecurityRequirement -> Encoding # toJSONList :: [SecurityRequirement] -> Value # toEncodingList :: [SecurityRequirement] -> Encoding # omitField :: SecurityRequirement -> Bool # | |
| Data SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecurityRequirement -> c SecurityRequirement # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecurityRequirement # toConstr :: SecurityRequirement -> Constr # dataTypeOf :: SecurityRequirement -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SecurityRequirement) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecurityRequirement) # gmapT :: (forall b. Data b => b -> b) -> SecurityRequirement -> SecurityRequirement # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecurityRequirement -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecurityRequirement -> r # gmapQ :: (forall d. Data d => d -> u) -> SecurityRequirement -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SecurityRequirement -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement # | |
| Monoid SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods mempty :: SecurityRequirement # mappend :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement # | |
| Semigroup SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods (<>) :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement # sconcat :: NonEmpty SecurityRequirement -> SecurityRequirement # stimes :: Integral b => b -> SecurityRequirement -> SecurityRequirement # | |
| Read SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods readsPrec :: Int -> ReadS SecurityRequirement # readList :: ReadS [SecurityRequirement] # | |
| Show SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecurityRequirement -> ShowS # show :: SecurityRequirement -> String # showList :: [SecurityRequirement] -> ShowS # | |
| Eq SecurityRequirement Source # | |
Defined in Data.OpenApi.Internal Methods (==) :: SecurityRequirement -> SecurityRequirement -> Bool # (/=) :: SecurityRequirement -> SecurityRequirement -> Bool # | |
| HasSecurity OpenApi [SecurityRequirement] Source # | |
Defined in Data.OpenApi.Lens | |
| HasSecurity Operation [SecurityRequirement] Source # | |
Defined in Data.OpenApi.Lens | |
Allows adding meta data to a single tag that is used by Operation.
It is not mandatory to have a Tag per tag used there.
Constructors
| Tag | |
Fields
| |
Instances
| FromJSON Tag Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON Tag Source # | |||||
| Data Tag Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # | |||||
| IsString Tag Source # | |||||
Defined in Data.OpenApi.Internal Methods fromString :: String -> Tag # | |||||
| Generic Tag Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show Tag Source # | |||||
| Eq Tag Source # | |||||
| Ord Tag Source # | |||||
| Hashable Tag Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasName Tag TagName Source # | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Tag Tag a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Tag Tag a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| (k ~ A_Lens, a ~ TagName, b ~ TagName) => LabelOptic "name" k Tag Tag a b Source # | |||||
Defined in Data.OpenApi.Optics | |||||
| HasDescription Tag (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| HasExternalDocs Tag (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Tag (Maybe ExternalDocs) Source # | |||||
| HasTags OpenApi (InsOrdHashSet Tag) Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Rep Tag Source # | |||||
Defined in Data.OpenApi.Internal type Rep Tag = D1 ('MetaData "Tag" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "Tag" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TagName) :*: (S1 ('MetaSel ('Just "_tagDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_tagExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs))))) | |||||
data ExternalDocs Source #
Allows referencing an external resource for extended documentation.
Constructors
| ExternalDocs | |
Fields
| |
Instances
| FromJSON ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| ToJSON ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: ExternalDocs -> Value # toEncoding :: ExternalDocs -> Encoding # toJSONList :: [ExternalDocs] -> Value # toEncodingList :: [ExternalDocs] -> Encoding # omitField :: ExternalDocs -> Bool # | |||||
| Data ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExternalDocs -> c ExternalDocs # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExternalDocs # toConstr :: ExternalDocs -> Constr # dataTypeOf :: ExternalDocs -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ExternalDocs) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExternalDocs) # gmapT :: (forall b. Data b => b -> b) -> ExternalDocs -> ExternalDocs # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExternalDocs -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExternalDocs -> r # gmapQ :: (forall d. Data d => d -> u) -> ExternalDocs -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ExternalDocs -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExternalDocs -> m ExternalDocs # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExternalDocs -> m ExternalDocs # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExternalDocs -> m ExternalDocs # | |||||
| Monoid ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods mempty :: ExternalDocs # mappend :: ExternalDocs -> ExternalDocs -> ExternalDocs # mconcat :: [ExternalDocs] -> ExternalDocs # | |||||
| Semigroup ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: ExternalDocs -> ExternalDocs -> ExternalDocs # sconcat :: NonEmpty ExternalDocs -> ExternalDocs # stimes :: Integral b => b -> ExternalDocs -> ExternalDocs # | |||||
| Generic ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
| |||||
| Show ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ExternalDocs -> ShowS # show :: ExternalDocs -> String # showList :: [ExternalDocs] -> ShowS # | |||||
| Eq ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| Ord ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods compare :: ExternalDocs -> ExternalDocs -> Ordering # (<) :: ExternalDocs -> ExternalDocs -> Bool # (<=) :: ExternalDocs -> ExternalDocs -> Bool # (>) :: ExternalDocs -> ExternalDocs -> Bool # (>=) :: ExternalDocs -> ExternalDocs -> Bool # max :: ExternalDocs -> ExternalDocs -> ExternalDocs # min :: ExternalDocs -> ExternalDocs -> ExternalDocs # | |||||
| Hashable ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| SwaggerMonoid ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal Methods swaggerMempty :: ExternalDocs Source # swaggerMappend :: ExternalDocs -> ExternalDocs -> ExternalDocs Source # | |||||
| HasUrl ExternalDocs URL Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| (k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k ExternalDocs ExternalDocs a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b # | |||||
| (k ~ A_Lens, a ~ URL, b ~ URL) => LabelOptic "url" k ExternalDocs ExternalDocs a b Source # | |||||
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b # | |||||
| HasDescription ExternalDocs (Maybe Text) Source # | |||||
Defined in Data.OpenApi.Lens Methods description :: Lens' ExternalDocs (Maybe Text) Source # | |||||
| HasExternalDocs OpenApi (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasExternalDocs Operation (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Operation (Maybe ExternalDocs) Source # | |||||
| HasExternalDocs Schema (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods | |||||
| HasExternalDocs Tag (Maybe ExternalDocs) Source # | |||||
Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Tag (Maybe ExternalDocs) Source # | |||||
| type Rep ExternalDocs Source # | |||||
Defined in Data.OpenApi.Internal type Rep ExternalDocs = D1 ('MetaData "ExternalDocs" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'False) (C1 ('MetaCons "ExternalDocs" 'PrefixI 'True) (S1 ('MetaSel ('Just "_externalDocsDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_externalDocsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URL))) | |||||
A simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse.
Constructors
| Reference | |
Fields
| |
Instances
| FromJSON Reference Source # | |
Defined in Data.OpenApi.Internal | |
| ToJSON Reference Source # | |
| Data Reference Source # | |
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Reference -> c Reference # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Reference # toConstr :: Reference -> Constr # dataTypeOf :: Reference -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Reference) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Reference) # gmapT :: (forall b. Data b => b -> b) -> Reference -> Reference # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Reference -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Reference -> r # gmapQ :: (forall d. Data d => d -> u) -> Reference -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Reference -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Reference -> m Reference # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Reference -> m Reference # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Reference -> m Reference # | |
| Show Reference Source # | |
| Eq Reference Source # | |
data Referenced a Source #
Instances
| Functor Referenced Source # | |
Defined in Data.OpenApi.Internal Methods fmap :: (a -> b) -> Referenced a -> Referenced b # (<$) :: a -> Referenced b -> Referenced a # | |
| (k ~ A_Prism, a1 ~ a2, b ~ a3) => LabelOptic "_Inline" k (Referenced a2) (Referenced a3) a1 b Source # | |
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx (Referenced a2) (Referenced a3) a1 b # | |
| (k ~ A_Prism, a1 ~ Reference, b ~ Reference) => LabelOptic "_Ref" k (Referenced a2) (Referenced a2) a1 b Source # | |
Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx (Referenced a2) (Referenced a2) a1 b # | |
| HasAllOf Schema (Maybe [Referenced Schema]) Source # | |
Defined in Data.OpenApi.Lens | |
| HasAnyOf Schema (Maybe [Referenced Schema]) Source # | |
Defined in Data.OpenApi.Lens | |
| HasDefault Responses (Maybe (Referenced Response)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasNot Schema (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasOneOf Schema (Maybe [Referenced Schema]) Source # | |
Defined in Data.OpenApi.Lens | |
| HasParameters Operation [Referenced Param] Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasParameters PathItem [Referenced Param] Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # | |
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation (Maybe (Referenced RequestBody)) Source # | |
| HasSchema Header (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasSchema MediaTypeObject (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject (Maybe (Referenced Schema)) Source # | |
| HasSchema Param (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |
| HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # | |
Defined in Data.OpenApi.Lens Methods examples :: Lens' Header (InsOrdHashMap Text (Referenced Example)) Source # | |
| HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |
Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |
| HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # | |
Defined in Data.OpenApi.Lens Methods examples :: Lens' Param (InsOrdHashMap Text (Referenced Example)) Source # | |
| HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |
Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |
| HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |
Defined in Data.OpenApi.Lens Methods headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |
| HasLinks Response (InsOrdHashMap Text (Referenced Link)) Source # | |
Defined in Data.OpenApi.Lens Methods links :: Lens' Response (InsOrdHashMap Text (Referenced Link)) Source # | |
| HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens Methods properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
| HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
| FromJSON (Referenced Callback) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Callback) # parseJSONList :: Value -> Parser [Referenced Callback] # omittedField :: Maybe (Referenced Callback) # | |
| FromJSON (Referenced Example) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Example) # parseJSONList :: Value -> Parser [Referenced Example] # omittedField :: Maybe (Referenced Example) # | |
| FromJSON (Referenced Header) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Header) # parseJSONList :: Value -> Parser [Referenced Header] # omittedField :: Maybe (Referenced Header) # | |
| FromJSON (Referenced Link) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Link) # parseJSONList :: Value -> Parser [Referenced Link] # omittedField :: Maybe (Referenced Link) # | |
| FromJSON (Referenced Param) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Param) # parseJSONList :: Value -> Parser [Referenced Param] # omittedField :: Maybe (Referenced Param) # | |
| FromJSON (Referenced RequestBody) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced RequestBody) # parseJSONList :: Value -> Parser [Referenced RequestBody] # | |
| FromJSON (Referenced Response) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Response) # parseJSONList :: Value -> Parser [Referenced Response] # omittedField :: Maybe (Referenced Response) # | |
| FromJSON (Referenced Schema) Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser (Referenced Schema) # parseJSONList :: Value -> Parser [Referenced Schema] # omittedField :: Maybe (Referenced Schema) # | |
| ToJSON (Referenced Callback) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Callback -> Value # toEncoding :: Referenced Callback -> Encoding # toJSONList :: [Referenced Callback] -> Value # toEncodingList :: [Referenced Callback] -> Encoding # omitField :: Referenced Callback -> Bool # | |
| ToJSON (Referenced Example) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Example -> Value # toEncoding :: Referenced Example -> Encoding # toJSONList :: [Referenced Example] -> Value # toEncodingList :: [Referenced Example] -> Encoding # omitField :: Referenced Example -> Bool # | |
| ToJSON (Referenced Header) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Header -> Value # toEncoding :: Referenced Header -> Encoding # toJSONList :: [Referenced Header] -> Value # toEncodingList :: [Referenced Header] -> Encoding # omitField :: Referenced Header -> Bool # | |
| ToJSON (Referenced Link) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Link -> Value # toEncoding :: Referenced Link -> Encoding # toJSONList :: [Referenced Link] -> Value # toEncodingList :: [Referenced Link] -> Encoding # omitField :: Referenced Link -> Bool # | |
| ToJSON (Referenced Param) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Param -> Value # toEncoding :: Referenced Param -> Encoding # toJSONList :: [Referenced Param] -> Value # toEncodingList :: [Referenced Param] -> Encoding # omitField :: Referenced Param -> Bool # | |
| ToJSON (Referenced RequestBody) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced RequestBody -> Value # toEncoding :: Referenced RequestBody -> Encoding # toJSONList :: [Referenced RequestBody] -> Value # toEncodingList :: [Referenced RequestBody] -> Encoding # omitField :: Referenced RequestBody -> Bool # | |
| ToJSON (Referenced Response) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Response -> Value # toEncoding :: Referenced Response -> Encoding # toJSONList :: [Referenced Response] -> Value # toEncodingList :: [Referenced Response] -> Encoding # omitField :: Referenced Response -> Bool # | |
| ToJSON (Referenced Schema) Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Schema -> Value # toEncoding :: Referenced Schema -> Encoding # toJSONList :: [Referenced Schema] -> Value # toEncodingList :: [Referenced Schema] -> Encoding # omitField :: Referenced Schema -> Bool # | |
| Data a => Data (Referenced a) Source # | |
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Referenced a -> c (Referenced a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Referenced a) # toConstr :: Referenced a -> Constr # dataTypeOf :: Referenced a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Referenced a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Referenced a)) # gmapT :: (forall b. Data b => b -> b) -> Referenced a -> Referenced a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Referenced a -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Referenced a -> r # gmapQ :: (forall d. Data d => d -> u) -> Referenced a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Referenced a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a) # | |
| IsString a => IsString (Referenced a) Source # | |
Defined in Data.OpenApi.Internal Methods fromString :: String -> Referenced a # | |
| Show a => Show (Referenced a) Source # | |
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Referenced a -> ShowS # show :: Referenced a -> String # showList :: [Referenced a] -> ShowS # | |
| Eq a => Eq (Referenced a) Source # | |
Defined in Data.OpenApi.Internal | |
| Monoid a => SwaggerMonoid (Referenced a) Source # | |
Defined in Data.OpenApi.Internal Methods swaggerMempty :: Referenced a Source # swaggerMappend :: Referenced a -> Referenced a -> Referenced a Source # | |
Instances
| FromJSON URL Source # | |
Defined in Data.OpenApi.Internal | |
| ToJSON URL Source # | |
| Data URL Source # | |
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URL -> c URL # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URL # dataTypeOf :: URL -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URL) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URL) # gmapT :: (forall b. Data b => b -> b) -> URL -> URL # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URL -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URL -> r # gmapQ :: (forall d. Data d => d -> u) -> URL -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> URL -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> URL -> m URL # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URL -> m URL # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URL -> m URL # | |
| Show URL Source # | |
| Eq URL Source # | |
| Ord URL Source # | |
| Hashable URL Source # | |
Defined in Data.OpenApi.Internal | |
| SwaggerMonoid URL Source # | |
Defined in Data.OpenApi.Internal | |
| HasUrl ExternalDocs URL Source # | |
Defined in Data.OpenApi.Lens | |
| HasExternalValue Example (Maybe URL) Source # | |
Defined in Data.OpenApi.Lens | |
| HasUrl Contact (Maybe URL) Source # | |
| HasUrl License (Maybe URL) Source # | |
data AdditionalProperties Source #
Instances
| FromJSON AdditionalProperties Source # | |
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser AdditionalProperties # parseJSONList :: Value -> Parser [AdditionalProperties] # | |
| ToJSON AdditionalProperties Source # | |
Defined in Data.OpenApi.Internal Methods toJSON :: AdditionalProperties -> Value # toEncoding :: AdditionalProperties -> Encoding # toJSONList :: [AdditionalProperties] -> Value # toEncodingList :: [AdditionalProperties] -> Encoding # omitField :: AdditionalProperties -> Bool # | |
| Data AdditionalProperties Source # | |
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdditionalProperties -> c AdditionalProperties # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdditionalProperties # toConstr :: AdditionalProperties -> Constr # dataTypeOf :: AdditionalProperties -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AdditionalProperties) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdditionalProperties) # gmapT :: (forall b. Data b => b -> b) -> AdditionalProperties -> AdditionalProperties # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdditionalProperties -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdditionalProperties -> r # gmapQ :: (forall d. Data d => d -> u) -> AdditionalProperties -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AdditionalProperties -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdditionalProperties -> m AdditionalProperties # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdditionalProperties -> m AdditionalProperties # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdditionalProperties -> m AdditionalProperties # | |
| Show AdditionalProperties Source # | |
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> AdditionalProperties -> ShowS # show :: AdditionalProperties -> String # showList :: [AdditionalProperties] -> ShowS # | |
| Eq AdditionalProperties Source # | |
Defined in Data.OpenApi.Internal Methods (==) :: AdditionalProperties -> AdditionalProperties -> Bool # (/=) :: AdditionalProperties -> AdditionalProperties -> Bool # | |
| HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # | |
Defined in Data.OpenApi.Lens Methods additionalProperties :: Lens' Schema (Maybe AdditionalProperties) Source # | |
newtype OpenApiSpecVersion Source #
Constructors
| OpenApiSpecVersion | |
Fields | |
Instances
| FromJSON OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OpenApiSpecVersion # parseJSONList :: Value -> Parser [OpenApiSpecVersion] # | |||||
| ToJSON OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods toJSON :: OpenApiSpecVersion -> Value # toEncoding :: OpenApiSpecVersion -> Encoding # toJSONList :: [OpenApiSpecVersion] -> Value # toEncodingList :: [OpenApiSpecVersion] -> Encoding # omitField :: OpenApiSpecVersion -> Bool # | |||||
| Data OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenApiSpecVersion -> c OpenApiSpecVersion # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OpenApiSpecVersion # toConstr :: OpenApiSpecVersion -> Constr # dataTypeOf :: OpenApiSpecVersion -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OpenApiSpecVersion) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OpenApiSpecVersion) # gmapT :: (forall b. Data b => b -> b) -> OpenApiSpecVersion -> OpenApiSpecVersion # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenApiSpecVersion -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenApiSpecVersion -> r # gmapQ :: (forall d. Data d => d -> u) -> OpenApiSpecVersion -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenApiSpecVersion -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenApiSpecVersion -> m OpenApiSpecVersion # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApiSpecVersion -> m OpenApiSpecVersion # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenApiSpecVersion -> m OpenApiSpecVersion # | |||||
| Monoid OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods mempty :: OpenApiSpecVersion # mappend :: OpenApiSpecVersion -> OpenApiSpecVersion -> OpenApiSpecVersion # mconcat :: [OpenApiSpecVersion] -> OpenApiSpecVersion # | |||||
| Semigroup OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods (<>) :: OpenApiSpecVersion -> OpenApiSpecVersion -> OpenApiSpecVersion # sconcat :: NonEmpty OpenApiSpecVersion -> OpenApiSpecVersion # stimes :: Integral b => b -> OpenApiSpecVersion -> OpenApiSpecVersion # | |||||
| Generic OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods from :: OpenApiSpecVersion -> Rep OpenApiSpecVersion x # to :: Rep OpenApiSpecVersion x -> OpenApiSpecVersion # | |||||
| Show OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OpenApiSpecVersion -> ShowS # show :: OpenApiSpecVersion -> String # showList :: [OpenApiSpecVersion] -> ShowS # | |||||
| Generic OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods | |||||
| HasDatatypeInfo OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Associated Types
Methods datatypeInfo :: proxy OpenApiSpecVersion -> DatatypeInfo (Code OpenApiSpecVersion) # | |||||
| Eq OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods (==) :: OpenApiSpecVersion -> OpenApiSpecVersion -> Bool # (/=) :: OpenApiSpecVersion -> OpenApiSpecVersion -> Bool # | |||||
| AesonDefaultValue OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal Methods | |||||
| HasSwaggerAesonOptions OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| SwaggerMonoid OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| HasOpenapi OpenApi OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Lens | |||||
| type Rep OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal type Rep OpenApiSpecVersion = D1 ('MetaData "OpenApiSpecVersion" "Data.OpenApi.Internal" "openapi3-3.2.4-KxLFsRf66iIFo3h2iNojXc" 'True) (C1 ('MetaCons "OpenApiSpecVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "getVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) | |||||
| type Code OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal | |||||
| type DatatypeInfoOf OpenApiSpecVersion Source # | |||||
Defined in Data.OpenApi.Internal type DatatypeInfoOf OpenApiSpecVersion = 'Newtype "Data.OpenApi.Internal" "OpenApiSpecVersion" ('Record "OpenApiSpecVersion" '['FieldInfo "getVersion"]) | |||||
referencedToJSON :: ToJSON a => Text -> Referenced a -> Value Source #
referencedParseJSON :: FromJSON a => Text -> Value -> Parser (Referenced a) Source #
Orphan instances
| FromJSON MediaType Source # | |
| FromJSONKey MediaType Source # | |
Methods | |
| ToJSON MediaType Source # | |
| ToJSONKey MediaType Source # | |
| Data MediaType Source # | |
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MediaType -> c MediaType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MediaType # toConstr :: MediaType -> Constr # dataTypeOf :: MediaType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MediaType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MediaType) # gmapT :: (forall b. Data b => b -> b) -> MediaType -> MediaType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MediaType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MediaType -> r # gmapQ :: (forall d. Data d => d -> u) -> MediaType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MediaType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MediaType -> m MediaType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaType -> m MediaType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaType -> m MediaType # | |
| Hashable MediaType Source # | |
| AesonDefaultValue Version Source # | |
Methods | |
| (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a) Source # | |
Methods swaggerMempty :: InsOrdHashSet a Source # swaggerMappend :: InsOrdHashSet a -> InsOrdHashSet a -> InsOrdHashSet a Source # | |