Maintainer | Nickolay Kudasov <nickolay@getshoptv.com> |
---|---|
Stability | experimental |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Swagger™ is a project used to describe and document RESTful APIs.
The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.
Synopsis
- module Data.Swagger.Lens
- module Data.Swagger.Operation
- module Data.Swagger.ParamSchema
- module Data.Swagger.Schema
- module Data.Swagger.Schema.Validation
- data Swagger = Swagger {
- _swaggerInfo :: Info
- _swaggerHost :: Maybe Host
- _swaggerBasePath :: Maybe FilePath
- _swaggerSchemes :: Maybe [Scheme]
- _swaggerConsumes :: MimeList
- _swaggerProduces :: MimeList
- _swaggerPaths :: InsOrdHashMap FilePath PathItem
- _swaggerDefinitions :: Definitions Schema
- _swaggerParameters :: Definitions Param
- _swaggerResponses :: Definitions Response
- _swaggerSecurityDefinitions :: SecurityDefinitions
- _swaggerSecurity :: [SecurityRequirement]
- _swaggerTags :: InsOrdHashSet Tag
- _swaggerExternalDocs :: Maybe ExternalDocs
- data Host = Host {}
- data Scheme
- data Info = Info {
- _infoTitle :: Text
- _infoDescription :: Maybe Text
- _infoTermsOfService :: Maybe Text
- _infoContact :: Maybe Contact
- _infoLicense :: Maybe License
- _infoVersion :: Text
- data Contact = Contact {
- _contactName :: Maybe Text
- _contactUrl :: Maybe URL
- _contactEmail :: Maybe Text
- data License = License {
- _licenseName :: Text
- _licenseUrl :: Maybe URL
- data PathItem = PathItem {
- _pathItemGet :: Maybe Operation
- _pathItemPut :: Maybe Operation
- _pathItemPost :: Maybe Operation
- _pathItemDelete :: Maybe Operation
- _pathItemOptions :: Maybe Operation
- _pathItemHead :: Maybe Operation
- _pathItemPatch :: Maybe Operation
- _pathItemParameters :: [Referenced Param]
- data Operation = Operation {
- _operationTags :: InsOrdHashSet TagName
- _operationSummary :: Maybe Text
- _operationDescription :: Maybe Text
- _operationExternalDocs :: Maybe ExternalDocs
- _operationOperationId :: Maybe Text
- _operationConsumes :: Maybe MimeList
- _operationProduces :: Maybe MimeList
- _operationParameters :: [Referenced Param]
- _operationResponses :: Responses
- _operationSchemes :: Maybe [Scheme]
- _operationDeprecated :: Maybe Bool
- _operationSecurity :: [SecurityRequirement]
- data Tag = Tag {
- _tagName :: TagName
- _tagDescription :: Maybe Text
- _tagExternalDocs :: Maybe ExternalDocs
- type TagName = Text
- data SwaggerType (t :: SwaggerKind *) where
- type Format = Text
- type Definitions = InsOrdHashMap Text
- data CollectionFormat (t :: SwaggerKind *) where
- data Param = Param {
- _paramName :: Text
- _paramDescription :: Maybe Text
- _paramRequired :: Maybe Bool
- _paramSchema :: ParamAnySchema
- data ParamAnySchema
- data ParamOtherSchema = ParamOtherSchema {}
- data ParamLocation
- type ParamName = Text
- data Header = Header {
- _headerDescription :: Maybe Text
- _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
- type HeaderName = Text
- data Example = Example {
- getExample :: Map MediaType Value
- data ParamSchema (t :: SwaggerKind *) = ParamSchema {
- _paramSchemaDefault :: Maybe Value
- _paramSchemaType :: Maybe (SwaggerType t)
- _paramSchemaFormat :: Maybe Format
- _paramSchemaItems :: Maybe (SwaggerItems t)
- _paramSchemaMaximum :: Maybe Scientific
- _paramSchemaExclusiveMaximum :: Maybe Bool
- _paramSchemaMinimum :: Maybe Scientific
- _paramSchemaExclusiveMinimum :: Maybe Bool
- _paramSchemaMaxLength :: Maybe Integer
- _paramSchemaMinLength :: Maybe Integer
- _paramSchemaPattern :: Maybe Pattern
- _paramSchemaMaxItems :: Maybe Integer
- _paramSchemaMinItems :: Maybe Integer
- _paramSchemaUniqueItems :: Maybe Bool
- _paramSchemaEnum :: Maybe [Value]
- _paramSchemaMultipleOf :: Maybe Scientific
- data Schema = Schema {
- _schemaTitle :: Maybe Text
- _schemaDescription :: Maybe Text
- _schemaRequired :: [ParamName]
- _schemaAllOf :: Maybe [Referenced Schema]
- _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
- _schemaAdditionalProperties :: Maybe AdditionalProperties
- _schemaDiscriminator :: Maybe Text
- _schemaReadOnly :: Maybe Bool
- _schemaXml :: Maybe Xml
- _schemaExternalDocs :: Maybe ExternalDocs
- _schemaExample :: Maybe Value
- _schemaMaxProperties :: Maybe Integer
- _schemaMinProperties :: Maybe Integer
- _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
- data NamedSchema = NamedSchema {
- _namedSchemaName :: Maybe Text
- _namedSchemaSchema :: Schema
- data SwaggerItems (t :: SwaggerKind *) where
- SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k -> SwaggerItems k
- SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
- SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
- data Xml = Xml {
- _xmlName :: Maybe Text
- _xmlNamespace :: Maybe Text
- _xmlPrefix :: Maybe Text
- _xmlAttribute :: Maybe Bool
- _xmlWrapped :: Maybe Bool
- type Pattern = Text
- data AdditionalProperties
- data Responses = Responses {
- _responsesDefault :: Maybe (Referenced Response)
- _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
- data Response = Response {
- _responseDescription :: Text
- _responseSchema :: Maybe (Referenced Schema)
- _responseHeaders :: InsOrdHashMap HeaderName Header
- _responseExamples :: Maybe Example
- type HttpStatusCode = Int
- data SecurityScheme = SecurityScheme {
- _securitySchemeType :: SecuritySchemeType
- _securitySchemeDescription :: Maybe Text
- data SecuritySchemeType
- newtype SecurityRequirement = SecurityRequirement {
- getSecurityRequirement :: InsOrdHashMap Text [Text]
- newtype SecurityDefinitions = SecurityDefinitions (Definitions SecurityScheme)
- data ApiKeyParams = ApiKeyParams {
- _apiKeyName :: Text
- _apiKeyIn :: ApiKeyLocation
- data ApiKeyLocation
- data OAuth2Params = OAuth2Params {
- _oauth2Flow :: OAuth2Flow
- _oauth2Scopes :: InsOrdHashMap Text Text
- data OAuth2Flow
- type AuthorizationURL = Text
- type TokenURL = Text
- data ExternalDocs = ExternalDocs {
- _externalDocsDescription :: Maybe Text
- _externalDocsUrl :: URL
- newtype Reference = Reference {
- getReference :: Text
- data Referenced a
- newtype MimeList = MimeList {
- getMimeList :: [MediaType]
- newtype URL = URL {
- getUrl :: Text
How to use this library
This section explains how to use this library to work with Swagger specification.
Monoid
instances
Monoid
Virtually all types representing Swagger specification have
instances.
The Monoid
type class provides two methods — Monoid
and mempty
.mappend
In this library you can use
for a default/empty value. For instance:mempty
>>>
encode (mempty :: Swagger)
"{\"swagger\":\"2.0\",\"info\":{\"title\":\"\",\"version\":\"\"}}"
As you can see some spec properties (e.g. "version"
) are there even when the spec is empty.
That is because these properties are actually required ones.
You should always override the default (empty) value for these properties, although it is not strictly necessary:
>>>
encode mempty { _infoTitle = "Todo API", _infoVersion = "1.0" }
"{\"title\":\"Todo API\",\"version\":\"1.0\"}"
You can merge two values using
or its infix version mappend
(
:<>
)
>>>
encode $ mempty { _infoTitle = "Todo API" } <> mempty { _infoVersion = "1.0" }
"{\"title\":\"Todo API\",\"version\":\"1.0\"}"
This can be useful for combining specifications of endpoints into a whole API specification:
-- /account subAPI specification accountAPI :: Swagger -- /task subAPI specification taskAPI :: Swagger -- while API specification is just a combination -- of subAPIs' specifications api :: Swagger api = accountAPI <> taskAPI
Lenses and prisms
Note: if you're working with the optics library, take a look at Data.Swagger.Optics.
Since
has a fairly complex structure, lenses and prisms are used
to work comfortably with it. In combination with Swagger
instances, lenses
make it fairly simple to construct/modify any part of the specification:Monoid
>>>
:{
encode $ (mempty :: Swagger) & definitions .~ [ ("User", mempty & type_ ?~ SwaggerString) ] & paths .~ [ ("/user", mempty & get ?~ (mempty & produces ?~ MimeList ["application/json"] & at 200 ?~ ("OK" & _Inline.schema ?~ Ref (Reference "User")) & at 404 ?~ "User info not found")) ] :} "{\"swagger\":\"2.0\",\"info\":{\"title\":\"\",\"version\":\"\"},\"paths\":{\"/user\":{\"get\":{\"produces\":[\"application/json\"],\"responses\":{\"200\":{\"description\":\"OK\",\"schema\":{\"$ref\":\"#/definitions/User\"}},\"404\":{\"description\":\"User info not found\"}}}}},\"definitions\":{\"User\":{\"type\":\"string\"}}}"
In the snippet above we declare an API with a single path /user
. This path provides method GET
which produces application/json
output. It should respond with code 200
and body specified
by schema User
which is defined in
property of swagger specification.
Alternatively it may respond with code definitions
404
meaning that user info is not found.
For convenience, swagger2
uses classy field lenses. It means that
field accessor names can be overloaded for different types. One such
common field is
. Many components of a Swagger specification
can have descriptions, and you can use the same name for them:description
>>>
encode $ (mempty :: Response) & description .~ "No content"
"{\"description\":\"No content\"}">>>
:{
encode $ (mempty :: Schema) & type_ ?~ SwaggerBoolean & description ?~ "To be or not to be" :} "{\"description\":\"To be or not to be\",\"type\":\"boolean\"}"
is basically the base schema specification and many types contain it (see ParamSchema
).
So for convenience, all HasParamSchema
fields are transitively made fields of the type that has it.
For example, you can use ParamSchema
to access type_
of SwaggerType
schema without having to use Header
:paramSchema
>>>
encode $ (mempty :: Header) & type_ ?~ SwaggerNumber
"{\"type\":\"number\"}"
Additionally, to simplify working with
, both Response
and Operation
have direct access to it via Responses
. Example:at
code
>>>
:{
encode $ (mempty :: Operation) & at 404 ?~ "Not found" :} "{\"responses\":{\"404\":{\"description\":\"Not found\"}}}"
You might've noticed that
has an extra underscore in its name
compared to, say, type_
field accessor.
This is because description
type
is a keyword in Haskell.
A few other field accessors are modified in this way:
Schema specification
and ParamSchema
are the two core types for data model specification.Schema
specifies all the common properties, available for every data schema.
The ParamSchema
tt
parameter imposes some restrictions on type
and items
properties (see
and SwaggerType
).SwaggerItems
is used for request and response bodies and allows specifying objects
with properties in addition to what Schema
provides.ParamSchema
In most cases you will have a Haskell data type for which you would like to
define a corresponding schema. To facilitate this use case
swagger2
provides two classes for schema encoding.
Both these classes provide means to encode types as Swagger schemas.
is intended to be used for primitive API endpoint parameters,
such as query parameters, headers and URL path pieces.
Its corresponding value-encoding class is ToParamSchema
(from ToHttpApiData
http-api-data
package).
is used for request and response bodies and mostly differ from
primitive parameters by allowing objects/mappings in addition to primitive types and arrays.
Its corresponding value-encoding class is ToSchema
(from ToJSON
aeson
package).
While lenses and prisms make it easy to define schemas, it might be that you don't need to:
and ToSchema
classes both have default ToParamSchema
-based implementations!Generic
default implementation is also aligned with ToSchema
default implementation with
the only difference being for sum encoding. ToJSON
defaults sum encoding to ToJSON
,
while defaultTaggedObject
defaults to something which corresponds to ToSchema
. This is due to
ObjectWithSingleField
behavior being hard to specify in Swagger.defaultTaggedObject
Here's an example showing
–ToJSON
correspondance:ToSchema
>>>
data Person = Person { name :: String, age :: Integer } deriving Generic
>>>
instance ToJSON Person
>>>
instance ToSchema Person
>>>
encode (Person "David" 28)
"{\"age\":28,\"name\":\"David\"}">>>
encode $ toSchema (Proxy :: Proxy Person)
"{\"required\":[\"name\",\"age\"],\"properties\":{\"name\":{\"type\":\"string\"},\"age\":{\"type\":\"integer\"}},\"type\":\"object\"}"
Please note that not all valid Haskell data types will have a proper swagger schema. For example while we can derive a schema for basic enums like
>>>
data SampleEnum = ChoiceOne | ChoiceTwo deriving Generic
>>>
instance ToSchema SampleEnum
>>>
instance ToJSON SampleEnum
and for sum types that have constructors with values
>>>
data SampleSumType = ChoiceInt Int | ChoiceString String deriving Generic
>>>
instance ToSchema SampleSumType
>>>
instance ToJSON SampleSumType
we can not derive a valid schema for a mix of the above. The following will result in a type error
>>>
data BadMixedType = ChoiceBool Bool | JustTag deriving Generic
>>>
instance ToSchema BadMixedType
... ... error: ... • Cannot derive Generic-based Swagger Schema for BadMixedType ... BadMixedType is a mixed sum type (has both unit and non-unit constructors). ... Swagger does not have a good representation for these types. ... Use genericDeclareNamedSchemaUnrestricted if you want to derive schema ... that matches aeson's Generic-based toJSON, ... but that's not supported by some Swagger tools. ... ... In the instance declaration for ‘ToSchema BadMixedType’
We can use genericDeclareNamedSchemaUnrestricted
to try our best to represent this type as a Swagger Schema and match ToJSON
:
>>>
data BadMixedType = ChoiceBool Bool | JustTag deriving Generic
>>>
instance ToSchema BadMixedType where declareNamedSchema = genericDeclareNamedSchemaUnrestricted defaultSchemaOptions
>>>
instance ToJSON BadMixedType
Manipulation
Sometimes you have to work with an imported or generated
.
For instance, http://hackage.haskell.org/package/servant-swagger generates basic Swagger
for a type-level servant API.Swagger
Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc.
To facilitate common needs, Data.Swagger.Operation
module provides useful helpers.
Validation
While
and ToParamSchema
provide means to easily obtain schemas for Haskell types,
there is no static mechanism to ensure those instances correspond to the ToSchema
or ToHttpApiData
instances.ToJSON
Data.Swagger.Schema.Validation
addresses
/ToJSON
validation.ToSchema
Re-exports
module Data.Swagger.Lens
module Data.Swagger.Operation
module Data.Swagger.ParamSchema
module Data.Swagger.Schema
Swagger specification
This is the root document object for the API specification.
Swagger | |
|
Instances
Data Swagger Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Swagger -> c Swagger gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Swagger dataTypeOf :: Swagger -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Swagger) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Swagger) gmapT :: (forall b. Data b => b -> b) -> Swagger -> Swagger gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Swagger -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Swagger -> r gmapQ :: (forall d. Data d => d -> u) -> Swagger -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> Swagger -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> Swagger -> m Swagger gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Swagger -> m Swagger gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Swagger -> m Swagger | |
Monoid Swagger Source # | |
Semigroup Swagger Source # | |
Generic Swagger Source # | |
Show Swagger Source # | |
Eq Swagger Source # | |
Generic Swagger Source # | |
HasDatatypeInfo Swagger Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Swagger :: DatatypeInfo datatypeInfo :: proxy Swagger -> DatatypeInfo (Code Swagger) | |
FromJSON Swagger Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Swagger parseJSONList :: Value -> Parser [Swagger] | |
ToJSON Swagger Source # | |
Defined in Data.Swagger.Internal toEncoding :: Swagger -> Encoding toJSONList :: [Swagger] -> Value toEncodingList :: [Swagger] -> Encoding | |
HasSwaggerAesonOptions Swagger Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Swagger -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Swagger -> POP Maybe (Code Swagger) Source # | |
HasConsumes Swagger MimeList Source # | |
HasInfo Swagger Info Source # | |
HasProduces Swagger MimeList Source # | |
HasSecurityDefinitions Swagger SecurityDefinitions Source # | |
Defined in Data.Swagger.Lens securityDefinitions :: Lens' Swagger SecurityDefinitions Source # | |
(k ~ A_Lens, a ~ Maybe FilePath, b ~ Maybe FilePath) => LabelOptic "basePath" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ MimeList, b ~ MimeList) => LabelOptic "consumes" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Definitions Schema, b ~ Definitions Schema) => LabelOptic "definitions" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Maybe Host, b ~ Maybe Host) => LabelOptic "host" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Info, b ~ Info) => LabelOptic "info" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Definitions Param, b ~ Definitions Param) => LabelOptic "parameters" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ InsOrdHashMap FilePath PathItem, b ~ InsOrdHashMap FilePath PathItem) => LabelOptic "paths" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ MimeList, b ~ MimeList) => LabelOptic "produces" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Definitions Response, b ~ Definitions Response) => LabelOptic "responses" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ Maybe [Scheme], b ~ Maybe [Scheme]) => LabelOptic "schemes" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ [SecurityRequirement], b ~ [SecurityRequirement]) => LabelOptic "security" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ SecurityDefinitions, b ~ SecurityDefinitions) => LabelOptic "securityDefinitions" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
(k ~ A_Lens, a ~ InsOrdHashSet Tag, b ~ InsOrdHashSet Tag) => LabelOptic "tags" k Swagger Swagger a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Swagger Swagger a b | |
HasBasePath Swagger (Maybe FilePath) Source # | |
Defined in Data.Swagger.Lens | |
HasDefinitions Swagger (Definitions Schema) Source # | |
Defined in Data.Swagger.Lens definitions :: Lens' Swagger (Definitions Schema) Source # | |
HasExternalDocs Swagger (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source # | |
HasHost Swagger (Maybe Host) Source # | |
HasParameters Swagger (Definitions Param) Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' Swagger (Definitions Param) Source # | |
HasResponses Swagger (Definitions Response) Source # | |
Defined in Data.Swagger.Lens | |
HasSchemes Swagger (Maybe [Scheme]) Source # | |
HasSecurity Swagger [SecurityRequirement] Source # | |
Defined in Data.Swagger.Lens security :: Lens' Swagger [SecurityRequirement] Source # | |
HasTags Swagger (InsOrdHashSet Tag) Source # | |
HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source # | |
type Rep Swagger Source # | |
Defined in Data.Swagger.Internal type Rep Swagger = D1 ('MetaData "Swagger" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "Swagger" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_swaggerInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Info) :*: (S1 ('MetaSel ('Just "_swaggerHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Host)) :*: S1 ('MetaSel ('Just "_swaggerBasePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))) :*: ((S1 ('MetaSel ('Just "_swaggerSchemes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Scheme])) :*: S1 ('MetaSel ('Just "_swaggerConsumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MimeList)) :*: (S1 ('MetaSel ('Just "_swaggerProduces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MimeList) :*: S1 ('MetaSel ('Just "_swaggerPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap FilePath PathItem))))) :*: ((S1 ('MetaSel ('Just "_swaggerDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Schema)) :*: (S1 ('MetaSel ('Just "_swaggerParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Param)) :*: S1 ('MetaSel ('Just "_swaggerResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Response)))) :*: ((S1 ('MetaSel ('Just "_swaggerSecurityDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecurityDefinitions) :*: S1 ('MetaSel ('Just "_swaggerSecurity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SecurityRequirement])) :*: (S1 ('MetaSel ('Just "_swaggerTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashSet Tag)) :*: S1 ('MetaSel ('Just "_swaggerExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs))))))) | |
type Code Swagger Source # | |
Defined in Data.Swagger.Internal type Code Swagger = '['[Info, Maybe Host, Maybe FilePath, Maybe [Scheme], MimeList, MimeList, InsOrdHashMap FilePath PathItem, Definitions Schema, Definitions Param, Definitions Response, SecurityDefinitions, [SecurityRequirement], InsOrdHashSet Tag, Maybe ExternalDocs]] | |
type DatatypeInfoOf Swagger Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Swagger = 'ADT "Data.Swagger.Internal" "Swagger" '['Record "Swagger" '['FieldInfo "_swaggerInfo", 'FieldInfo "_swaggerHost", 'FieldInfo "_swaggerBasePath", 'FieldInfo "_swaggerSchemes", 'FieldInfo "_swaggerConsumes", 'FieldInfo "_swaggerProduces", 'FieldInfo "_swaggerPaths", 'FieldInfo "_swaggerDefinitions", 'FieldInfo "_swaggerParameters", 'FieldInfo "_swaggerResponses", 'FieldInfo "_swaggerSecurityDefinitions", 'FieldInfo "_swaggerSecurity", 'FieldInfo "_swaggerTags", 'FieldInfo "_swaggerExternalDocs"]] '['['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]] |
The host (name or ip) serving the API. It MAY include a port.
Instances
Data Host Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Host -> c Host gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Host dataTypeOf :: Host -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Host) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Host) gmapT :: (forall b. Data b => b -> b) -> Host -> Host gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Host -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Host -> r gmapQ :: (forall d. Data d => d -> u) -> Host -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> Host -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> Host -> m Host gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Host -> m Host gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Host -> m Host | |
IsString Host Source # | |
Defined in Data.Swagger.Internal fromString :: String -> Host | |
Generic Host Source # | |
Show Host Source # | |
Eq Host Source # | |
FromJSON Host Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Host parseJSONList :: Value -> Parser [Host] | |
ToJSON Host Source # | |
Defined in Data.Swagger.Internal | |
HasName Host HostName Source # | |
Defined in Data.Swagger.Lens | |
(k ~ A_Lens, a ~ HostName, b ~ HostName) => LabelOptic "name" k Host Host a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Host Host a b | |
(k ~ A_Lens, a ~ Maybe PortNumber, b ~ Maybe PortNumber) => LabelOptic "port" k Host Host a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Host Host a b | |
HasHost Swagger (Maybe Host) Source # | |
HasPort Host (Maybe PortNumber) Source # | |
Defined in Data.Swagger.Lens | |
type Rep Host Source # | |
Defined in Data.Swagger.Internal type Rep Host = D1 ('MetaData "Host" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "Host" 'PrefixI 'True) (S1 ('MetaSel ('Just "_hostName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostName) :*: S1 ('MetaSel ('Just "_hostPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PortNumber)))) |
The transfer protocol of the API.
Instances
Data Scheme Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Scheme -> c Scheme gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Scheme dataTypeOf :: Scheme -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Scheme) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Scheme) gmapT :: (forall b. Data b => b -> b) -> Scheme -> Scheme gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Scheme -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Scheme -> r gmapQ :: (forall d. Data d => d -> u) -> Scheme -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> Scheme -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> Scheme -> m Scheme gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Scheme -> m Scheme gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Scheme -> m Scheme | |
Generic Scheme Source # | |
Show Scheme Source # | |
Eq Scheme Source # | |
FromJSON Scheme Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Scheme parseJSONList :: Value -> Parser [Scheme] | |
ToJSON Scheme Source # | |
Defined in Data.Swagger.Internal toEncoding :: Scheme -> Encoding toJSONList :: [Scheme] -> Value toEncodingList :: [Scheme] -> Encoding | |
HasSchemes Operation (Maybe [Scheme]) Source # | |
HasSchemes Swagger (Maybe [Scheme]) Source # | |
type Rep Scheme Source # | |
Defined in Data.Swagger.Internal type Rep Scheme = D1 ('MetaData "Scheme" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) ((C1 ('MetaCons "Http" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Https" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Ws" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Wss" 'PrefixI 'False) (U1 :: Type -> Type))) |
Info types
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
Info | |
|
Instances
Data Info Source # | |
Defined in Data.Swagger.Internal 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 # | |
Show Info Source # | |
Eq Info Source # | |
FromJSON Info Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Info parseJSONList :: Value -> Parser [Info] | |
ToJSON Info Source # | |
Defined in Data.Swagger.Internal | |
AesonDefaultValue Info Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe Info Source # | |
SwaggerMonoid Info Source # | |
Defined in Data.Swagger.Internal swaggerMempty :: Info Source # | |
HasInfo Swagger Info Source # | |
HasTitle Info Text Source # | |
Defined in Data.Swagger.Lens | |
HasVersion Info Text Source # | |
Defined in Data.Swagger.Lens | |
(k ~ A_Lens, a ~ Maybe Contact, b ~ Maybe Contact) => LabelOptic "contact" k Info Info a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Info Info a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Info Info a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Info Info a b | |
(k ~ A_Lens, a ~ Maybe License, b ~ Maybe License) => LabelOptic "license" k Info Info a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Info Info a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "termsOfService" k Info Info a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Info Info a b | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "title" k Info Info a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Info Info a b | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "version" k Info Info a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Info Info a b | |
HasContact Info (Maybe Contact) Source # | |
HasDescription Info (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' Info (Maybe Text) Source # | |
HasLicense Info (Maybe License) Source # | |
HasTermsOfService Info (Maybe Text) Source # | |
Defined in Data.Swagger.Lens termsOfService :: Lens' Info (Maybe Text) Source # | |
type Rep Info Source # | |
Defined in Data.Swagger.Internal type Rep Info = D1 ('MetaData "Info" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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.
Contact | |
|
Instances
Data Contact Source # | |
Defined in Data.Swagger.Internal 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 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 # | |
Show Contact Source # | |
Eq Contact Source # | |
FromJSON Contact Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Contact parseJSONList :: Value -> Parser [Contact] | |
ToJSON Contact Source # | |
Defined in Data.Swagger.Internal toEncoding :: Contact -> Encoding toJSONList :: [Contact] -> Value toEncodingList :: [Contact] -> Encoding | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "email" k Contact Contact a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Contact Contact a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k Contact Contact a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Contact Contact a b | |
(k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "url" k Contact Contact a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Contact Contact a b | |
HasContact Info (Maybe Contact) Source # | |
HasEmail Contact (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasName Contact (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasUrl Contact (Maybe URL) Source # | |
type Rep Contact Source # | |
Defined in Data.Swagger.Internal type Rep Contact = D1 ('MetaData "Contact" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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.
License | |
|
Instances
Data License Source # | |
Defined in Data.Swagger.Internal 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 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.Swagger.Internal fromString :: String -> License | |
Generic License Source # | |
Show License Source # | |
Eq License Source # | |
FromJSON License Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser License parseJSONList :: Value -> Parser [License] | |
ToJSON License Source # | |
Defined in Data.Swagger.Internal toEncoding :: License -> Encoding toJSONList :: [License] -> Value toEncodingList :: [License] -> Encoding | |
HasName License Text Source # | |
Defined in Data.Swagger.Lens | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k License License a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx License License a b | |
(k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "url" k License License a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx License License a b | |
HasLicense Info (Maybe License) Source # | |
HasUrl License (Maybe URL) Source # | |
type Rep License Source # | |
Defined in Data.Swagger.Internal type Rep License = D1 ('MetaData "License" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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)))) |
PathItem
Describes the operations available on a single path.
A
may be empty, due to ACL constraints.
The path itself is still exposed to the documentation viewer
but they will not know which operations and parameters are available.PathItem
PathItem | |
|
Instances
Data PathItem Source # | |
Defined in Data.Swagger.Internal 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 # | |
Show PathItem Source # | |
Eq PathItem Source # | |
Generic PathItem Source # | |
HasDatatypeInfo PathItem Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf PathItem :: DatatypeInfo datatypeInfo :: proxy PathItem -> DatatypeInfo (Code PathItem) | |
FromJSON PathItem Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser PathItem parseJSONList :: Value -> Parser [PathItem] | |
ToJSON PathItem Source # | |
Defined in Data.Swagger.Internal toEncoding :: PathItem -> Encoding toJSONList :: [PathItem] -> Value toEncodingList :: [PathItem] -> Encoding | |
HasSwaggerAesonOptions PathItem Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy PathItem -> SwaggerAesonOptions Source # aesonDefaults :: Proxy PathItem -> POP Maybe (Code PathItem) Source # | |
SwaggerMonoid PathItem Source # | |
Defined in Data.Swagger.Internal | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "delete" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "get" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "head" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "options" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ [Referenced Param], b ~ [Referenced Param]) => LabelOptic "parameters" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "patch" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "post" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
(k ~ A_Lens, a ~ Maybe Operation, b ~ Maybe Operation) => LabelOptic "put" k PathItem PathItem a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx PathItem PathItem a b | |
HasDelete PathItem (Maybe Operation) Source # | |
HasGet PathItem (Maybe Operation) Source # | |
HasHead PathItem (Maybe Operation) Source # | |
HasOptions PathItem (Maybe Operation) Source # | |
HasParameters PathItem [Referenced Param] Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' PathItem [Referenced Param] Source # | |
HasPatch PathItem (Maybe Operation) Source # | |
HasPost PathItem (Maybe Operation) Source # | |
HasPut PathItem (Maybe Operation) Source # | |
HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source # | |
SwaggerMonoid (InsOrdHashMap FilePath PathItem) Source # | |
Defined in Data.Swagger.Internal swaggerMempty :: InsOrdHashMap FilePath PathItem Source # swaggerMappend :: InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem Source # | |
type Rep PathItem Source # | |
Defined in Data.Swagger.Internal type Rep PathItem = D1 ('MetaData "PathItem" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "PathItem" 'PrefixI 'True) (((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 "_pathItemParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Referenced Param]))))) | |
type Code PathItem Source # | |
type DatatypeInfoOf PathItem Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf PathItem = 'ADT "Data.Swagger.Internal" "PathItem" '['Record "PathItem" '['FieldInfo "_pathItemGet", 'FieldInfo "_pathItemPut", 'FieldInfo "_pathItemPost", 'FieldInfo "_pathItemDelete", 'FieldInfo "_pathItemOptions", 'FieldInfo "_pathItemHead", 'FieldInfo "_pathItemPatch", '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]] |
Operations
Describes a single API operation on a path.
Operation | |
|
Instances
Data Operation Source # | |
Defined in Data.Swagger.Internal 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 # | |
Show Operation Source # | |
Eq Operation Source # | |
Generic Operation Source # | |
HasDatatypeInfo Operation Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Operation :: DatatypeInfo datatypeInfo :: proxy Operation -> DatatypeInfo (Code Operation) | |
At Operation | |
Defined in Data.Swagger.Lens | |
Ixed Operation | |
Defined in Data.Swagger.Lens | |
At Operation | |
Defined in Data.Swagger.Optics | |
Ixed Operation | |
FromJSON Operation Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Operation parseJSONList :: Value -> Parser [Operation] | |
ToJSON Operation Source # | |
Defined in Data.Swagger.Internal toEncoding :: Operation -> Encoding toJSONList :: [Operation] -> Value toEncodingList :: [Operation] -> Encoding | |
HasSwaggerAesonOptions Operation Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Operation -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Operation -> POP Maybe (Code Operation) Source # | |
SwaggerMonoid Operation Source # | |
Defined in Data.Swagger.Internal swaggerMempty :: Operation Source # swaggerMappend :: Operation -> Operation -> Operation Source # | |
HasResponses Operation Responses Source # | |
(k ~ A_Lens, a ~ Maybe MimeList, b ~ Maybe MimeList) => LabelOptic "consumes" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationId" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ [Referenced Param], b ~ [Referenced Param]) => LabelOptic "parameters" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe MimeList, b ~ Maybe MimeList) => LabelOptic "produces" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Responses, b ~ Responses) => LabelOptic "responses" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe [Scheme], b ~ Maybe [Scheme]) => LabelOptic "schemes" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ [SecurityRequirement], b ~ [SecurityRequirement]) => LabelOptic "security" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
(k ~ A_Lens, a ~ InsOrdHashSet TagName, b ~ InsOrdHashSet TagName) => LabelOptic "tags" k Operation Operation a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Operation Operation a b | |
HasConsumes Operation (Maybe MimeList) Source # | |
HasDelete PathItem (Maybe Operation) Source # | |
HasDeprecated Operation (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens deprecated :: Lens' Operation (Maybe Bool) Source # | |
HasDescription Operation (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' Operation (Maybe Text) Source # | |
HasExternalDocs Operation (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Operation (Maybe ExternalDocs) Source # | |
HasGet PathItem (Maybe Operation) Source # | |
HasHead PathItem (Maybe Operation) Source # | |
HasOperationId Operation (Maybe Text) Source # | |
Defined in Data.Swagger.Lens operationId :: Lens' Operation (Maybe Text) Source # | |
HasOptions PathItem (Maybe Operation) Source # | |
HasParameters Operation [Referenced Param] Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' Operation [Referenced Param] Source # | |
HasPatch PathItem (Maybe Operation) Source # | |
HasPost PathItem (Maybe Operation) Source # | |
HasProduces Operation (Maybe MimeList) Source # | |
HasPut PathItem (Maybe Operation) Source # | |
HasSchemes Operation (Maybe [Scheme]) Source # | |
HasSecurity Operation [SecurityRequirement] Source # | |
Defined in Data.Swagger.Lens security :: Lens' Operation [SecurityRequirement] Source # | |
HasSummary Operation (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasTags Operation (InsOrdHashSet TagName) Source # | |
type Rep Operation Source # | |
Defined in Data.Swagger.Internal type Rep Operation = D1 ('MetaData "Operation" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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 "_operationConsumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MimeList))))) :*: ((S1 ('MetaSel ('Just "_operationProduces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MimeList)) :*: (S1 ('MetaSel ('Just "_operationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Referenced Param]) :*: S1 ('MetaSel ('Just "_operationResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Responses))) :*: (S1 ('MetaSel ('Just "_operationSchemes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Scheme])) :*: (S1 ('MetaSel ('Just "_operationDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_operationSecurity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SecurityRequirement])))))) | |
type Code Operation Source # | |
Defined in Data.Swagger.Internal type Code Operation = '['[InsOrdHashSet TagName, Maybe Text, Maybe Text, Maybe ExternalDocs, Maybe Text, Maybe MimeList, Maybe MimeList, [Referenced Param], Responses, Maybe [Scheme], Maybe Bool, [SecurityRequirement]]] | |
type DatatypeInfoOf Operation Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Operation = 'ADT "Data.Swagger.Internal" "Operation" '['Record "Operation" '['FieldInfo "_operationTags", 'FieldInfo "_operationSummary", 'FieldInfo "_operationDescription", 'FieldInfo "_operationExternalDocs", 'FieldInfo "_operationOperationId", 'FieldInfo "_operationConsumes", 'FieldInfo "_operationProduces", 'FieldInfo "_operationParameters", 'FieldInfo "_operationResponses", 'FieldInfo "_operationSchemes", 'FieldInfo "_operationDeprecated", 'FieldInfo "_operationSecurity"]] '['['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 | |
Defined in Data.Swagger.Lens | |
type IxValue Operation | |
Defined in Data.Swagger.Lens | |
type Index Operation | |
Defined in Data.Swagger.Optics | |
type IxKind Operation | |
Defined in Data.Swagger.Optics type IxKind Operation = An_AffineTraversal | |
type IxValue Operation | |
Defined in Data.Swagger.Optics |
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.
Tag | |
|
Instances
Data Tag Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal fromString :: String -> Tag | |
Generic Tag Source # | |
Show Tag Source # | |
Eq Tag Source # | |
Ord Tag Source # | |
Hashable Tag Source # | |
Defined in Data.Swagger.Internal hashWithSalt :: Int -> Tag -> Int | |
FromJSON Tag Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Tag parseJSONList :: Value -> Parser [Tag] | |
ToJSON Tag Source # | |
Defined in Data.Swagger.Internal | |
HasName Tag TagName Source # | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Tag Tag a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Tag Tag a b | |
(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Tag Tag a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Tag Tag a b | |
(k ~ A_Lens, a ~ TagName, b ~ TagName) => LabelOptic "name" k Tag Tag a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Tag Tag a b | |
HasDescription Tag (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' Tag (Maybe Text) Source # | |
HasExternalDocs Tag (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Tag (Maybe ExternalDocs) Source # | |
HasTags Swagger (InsOrdHashSet Tag) Source # | |
type Rep Tag Source # | |
Defined in Data.Swagger.Internal type Rep Tag = D1 ('MetaData "Tag" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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))))) |
Types and formats
data SwaggerType (t :: SwaggerKind *) where Source #
Instances
type Definitions = InsOrdHashMap Text Source #
A list of definitions that can be used in references.
data CollectionFormat (t :: SwaggerKind *) where Source #
Determines the format of the array.
Instances
Parameters
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
Param | |
|
Instances
Data Param Source # | |
Defined in Data.Swagger.Internal 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 # | |
Show Param Source # | |
Eq Param Source # | |
Generic Param Source # | |
HasDatatypeInfo Param Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Param :: DatatypeInfo datatypeInfo :: proxy Param -> DatatypeInfo (Code Param) | |
FromJSON Param Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Param parseJSONList :: Value -> Parser [Param] | |
ToJSON Param Source # | |
Defined in Data.Swagger.Internal | |
HasSwaggerAesonOptions Param Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Param -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Param -> POP Maybe (Code Param) Source # | |
SwaggerMonoid Param Source # | |
Defined in Data.Swagger.Internal | |
HasName Param Text Source # | |
Defined in Data.Swagger.Lens | |
HasSchema Param ParamAnySchema Source # | |
Defined in Data.Swagger.Lens schema :: Lens' Param ParamAnySchema Source # | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Param Param a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Param Param a b | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k Param Param a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Param Param a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k Param Param a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Param Param a b | |
(k ~ A_Lens, a ~ ParamAnySchema, b ~ ParamAnySchema) => LabelOptic "schema" k Param Param a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Param Param a b | |
HasDescription Param (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' Param (Maybe Text) Source # | |
HasParameters Operation [Referenced Param] Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' Operation [Referenced Param] Source # | |
HasParameters PathItem [Referenced Param] Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' PathItem [Referenced Param] Source # | |
HasParameters Swagger (Definitions Param) Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' Swagger (Definitions Param) Source # | |
HasRequired Param (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens | |
FromJSON (Referenced Param) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (Referenced Param) parseJSONList :: Value -> Parser [Referenced Param] | |
ToJSON (Referenced Param) Source # | |
Defined in Data.Swagger.Internal toJSON :: Referenced Param -> Value toEncoding :: Referenced Param -> Encoding toJSONList :: [Referenced Param] -> Value toEncodingList :: [Referenced Param] -> Encoding | |
type Rep Param Source # | |
Defined in Data.Swagger.Internal type Rep Param = D1 ('MetaData "Param" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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 "_paramSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ParamAnySchema)))) | |
type Code Param Source # | |
Defined in Data.Swagger.Internal | |
type DatatypeInfoOf Param Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Param = 'ADT "Data.Swagger.Internal" "Param" '['Record "Param" '['FieldInfo "_paramName", 'FieldInfo "_paramDescription", 'FieldInfo "_paramRequired", 'FieldInfo "_paramSchema"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] |
data ParamAnySchema Source #
Instances
Data ParamAnySchema Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParamAnySchema -> c ParamAnySchema gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParamAnySchema toConstr :: ParamAnySchema -> Constr dataTypeOf :: ParamAnySchema -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ParamAnySchema) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParamAnySchema) gmapT :: (forall b. Data b => b -> b) -> ParamAnySchema -> ParamAnySchema gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParamAnySchema -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParamAnySchema -> r gmapQ :: (forall d. Data d => d -> u) -> ParamAnySchema -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> ParamAnySchema -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParamAnySchema -> m ParamAnySchema gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamAnySchema -> m ParamAnySchema gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamAnySchema -> m ParamAnySchema | |
Generic ParamAnySchema Source # | |
Defined in Data.Swagger.Internal type Rep ParamAnySchema :: Type -> Type from :: ParamAnySchema -> Rep ParamAnySchema x to :: Rep ParamAnySchema x -> ParamAnySchema | |
Show ParamAnySchema Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ParamAnySchema -> ShowS show :: ParamAnySchema -> String showList :: [ParamAnySchema] -> ShowS | |
Eq ParamAnySchema Source # | |
Defined in Data.Swagger.Internal (==) :: ParamAnySchema -> ParamAnySchema -> Bool (/=) :: ParamAnySchema -> ParamAnySchema -> Bool | |
FromJSON ParamAnySchema Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser ParamAnySchema parseJSONList :: Value -> Parser [ParamAnySchema] | |
ToJSON ParamAnySchema Source # | |
Defined in Data.Swagger.Internal toJSON :: ParamAnySchema -> Value toEncoding :: ParamAnySchema -> Encoding toJSONList :: [ParamAnySchema] -> Value toEncodingList :: [ParamAnySchema] -> Encoding | |
AesonDefaultValue ParamAnySchema Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe ParamAnySchema Source # | |
SwaggerMonoid ParamAnySchema Source # | |
Defined in Data.Swagger.Internal | |
HasSchema Param ParamAnySchema Source # | |
Defined in Data.Swagger.Lens schema :: Lens' Param ParamAnySchema Source # | |
(k ~ A_Prism, a ~ Referenced Schema, b ~ Referenced Schema) => LabelOptic "_ParamBody" k ParamAnySchema ParamAnySchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ParamAnySchema ParamAnySchema a b | |
(k ~ A_Prism, a ~ ParamOtherSchema, b ~ ParamOtherSchema) => LabelOptic "_ParamOther" k ParamAnySchema ParamAnySchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ParamAnySchema ParamAnySchema a b | |
type Rep ParamAnySchema Source # | |
Defined in Data.Swagger.Internal type Rep ParamAnySchema = D1 ('MetaData "ParamAnySchema" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "ParamBody" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Referenced Schema))) :+: C1 ('MetaCons "ParamOther" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ParamOtherSchema))) |
data ParamOtherSchema Source #
ParamOtherSchema | |
|
Instances
Data ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParamOtherSchema -> c ParamOtherSchema gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParamOtherSchema toConstr :: ParamOtherSchema -> Constr dataTypeOf :: ParamOtherSchema -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ParamOtherSchema) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParamOtherSchema) gmapT :: (forall b. Data b => b -> b) -> ParamOtherSchema -> ParamOtherSchema gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParamOtherSchema -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParamOtherSchema -> r gmapQ :: (forall d. Data d => d -> u) -> ParamOtherSchema -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> ParamOtherSchema -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParamOtherSchema -> m ParamOtherSchema gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamOtherSchema -> m ParamOtherSchema gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamOtherSchema -> m ParamOtherSchema | |
Monoid ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal | |
Semigroup ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal (<>) :: ParamOtherSchema -> ParamOtherSchema -> ParamOtherSchema sconcat :: NonEmpty ParamOtherSchema -> ParamOtherSchema stimes :: Integral b => b -> ParamOtherSchema -> ParamOtherSchema | |
Generic ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal type Rep ParamOtherSchema :: Type -> Type from :: ParamOtherSchema -> Rep ParamOtherSchema x to :: Rep ParamOtherSchema x -> ParamOtherSchema | |
Show ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ParamOtherSchema -> ShowS show :: ParamOtherSchema -> String showList :: [ParamOtherSchema] -> ShowS | |
Eq ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal (==) :: ParamOtherSchema -> ParamOtherSchema -> Bool (/=) :: ParamOtherSchema -> ParamOtherSchema -> Bool | |
Generic ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal type Code ParamOtherSchema :: [[Type]] from :: ParamOtherSchema -> Rep ParamOtherSchema to :: Rep ParamOtherSchema -> ParamOtherSchema | |
HasDatatypeInfo ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf ParamOtherSchema :: DatatypeInfo datatypeInfo :: proxy ParamOtherSchema -> DatatypeInfo (Code ParamOtherSchema) | |
FromJSON ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser ParamOtherSchema parseJSONList :: Value -> Parser [ParamOtherSchema] | |
ToJSON ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal toJSON :: ParamOtherSchema -> Value toEncoding :: ParamOtherSchema -> Encoding toJSONList :: [ParamOtherSchema] -> Value toEncodingList :: [ParamOtherSchema] -> Encoding | |
HasSwaggerAesonOptions ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy ParamOtherSchema -> SwaggerAesonOptions Source # aesonDefaults :: Proxy ParamOtherSchema -> POP Maybe (Code ParamOtherSchema) Source # | |
SwaggerMonoid ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal | |
HasIn ParamOtherSchema ParamLocation Source # | |
Defined in Data.Swagger.Lens in_ :: Lens' ParamOtherSchema ParamLocation Source # | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowEmptyValue" k ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(k ~ A_Lens, a ~ ParamLocation, b ~ ParamLocation) => LabelOptic "in" k ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe (SwaggerItems ('SwaggerKindParamOtherSchema :: SwaggerKind Type)), b ~ Maybe (SwaggerItems ('SwaggerKindParamOtherSchema :: SwaggerKind Type))) => LabelOptic "items" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(k ~ A_Lens, a ~ ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type), b ~ ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) => LabelOptic "paramSchema" k ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe (SwaggerType ('SwaggerKindParamOtherSchema :: SwaggerKind Type)), b ~ Maybe (SwaggerType ('SwaggerKindParamOtherSchema :: SwaggerKind Type))) => LabelOptic "type" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens ParamOtherSchema ParamOtherSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx ParamOtherSchema ParamOtherSchema a b | |
HasAllowEmptyValue ParamOtherSchema (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens allowEmptyValue :: Lens' ParamOtherSchema (Maybe Bool) Source # | |
HasDefault ParamOtherSchema (Maybe Value) Source # | |
Defined in Data.Swagger.Lens default_ :: Lens' ParamOtherSchema (Maybe Value) Source # | |
HasParamSchema ParamOtherSchema (ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens | |
HasType ParamOtherSchema (Maybe (SwaggerType ('SwaggerKindParamOtherSchema :: SwaggerKind Type))) Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' ParamOtherSchema (Maybe (SwaggerType 'SwaggerKindParamOtherSchema)) Source # | |
type Rep ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal type Rep ParamOtherSchema = D1 ('MetaData "ParamOtherSchema" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "ParamOtherSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "_paramOtherSchemaIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ParamLocation) :*: (S1 ('MetaSel ('Just "_paramOtherSchemaAllowEmptyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_paramOtherSchemaParamSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)))))) | |
type Code ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal type Code ParamOtherSchema = '['[ParamLocation, Maybe Bool, ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)]] | |
type DatatypeInfoOf ParamOtherSchema Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf ParamOtherSchema = 'ADT "Data.Swagger.Internal" "ParamOtherSchema" '['Record "ParamOtherSchema" '['FieldInfo "_paramOtherSchemaIn", 'FieldInfo "_paramOtherSchemaAllowEmptyValue", 'FieldInfo "_paramOtherSchemaParamSchema"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] |
data ParamLocation Source #
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 |
ParamFormData | Used to describe the payload of an HTTP request when either |
Instances
Data ParamLocation Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal type Rep ParamLocation :: Type -> Type from :: ParamLocation -> Rep ParamLocation x to :: Rep ParamLocation x -> ParamLocation | |
Show ParamLocation Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ParamLocation -> ShowS show :: ParamLocation -> String showList :: [ParamLocation] -> ShowS | |
Eq ParamLocation Source # | |
Defined in Data.Swagger.Internal (==) :: ParamLocation -> ParamLocation -> Bool (/=) :: ParamLocation -> ParamLocation -> Bool | |
FromJSON ParamLocation Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser ParamLocation parseJSONList :: Value -> Parser [ParamLocation] | |
ToJSON ParamLocation Source # | |
Defined in Data.Swagger.Internal toJSON :: ParamLocation -> Value toEncoding :: ParamLocation -> Encoding toJSONList :: [ParamLocation] -> Value toEncodingList :: [ParamLocation] -> Encoding | |
AesonDefaultValue ParamLocation Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe ParamLocation Source # | |
SwaggerMonoid ParamLocation Source # | |
Defined in Data.Swagger.Internal | |
HasIn ParamOtherSchema ParamLocation Source # | |
Defined in Data.Swagger.Lens in_ :: Lens' ParamOtherSchema ParamLocation Source # | |
type Rep ParamLocation Source # | |
Defined in Data.Swagger.Internal type Rep ParamLocation = D1 ('MetaData "ParamLocation" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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 "ParamFormData" 'PrefixI 'False) (U1 :: Type -> Type))) |
Header | |
|
Instances
Data Header Source # | |
Defined in Data.Swagger.Internal 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 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 # | |
Show Header Source # | |
Eq Header Source # | |
Generic Header Source # | |
HasDatatypeInfo Header Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Header :: DatatypeInfo datatypeInfo :: proxy Header -> DatatypeInfo (Code Header) | |
FromJSON Header Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Header parseJSONList :: Value -> Parser [Header] | |
ToJSON Header Source # | |
Defined in Data.Swagger.Internal toEncoding :: Header -> Encoding toJSONList :: [Header] -> Value toEncodingList :: [Header] -> Encoding | |
HasSwaggerAesonOptions Header Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Header -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Header -> POP Maybe (Code Header) Source # | |
(a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Header Header a b | |
(a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe (SwaggerItems ('SwaggerKindNormal Header)), b ~ Maybe (SwaggerItems ('SwaggerKindNormal Header))) => LabelOptic "items" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(k ~ A_Lens, a ~ ParamSchema ('SwaggerKindNormal Header), b ~ ParamSchema ('SwaggerKindNormal Header)) => LabelOptic "paramSchema" k Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Header Header a b | |
(a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe (SwaggerType ('SwaggerKindNormal Header)), b ~ Maybe (SwaggerType ('SwaggerKindNormal Header))) => LabelOptic "type" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens Header Header a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Header Header a b | |
HasDefault Header (Maybe Value) Source # | |
Defined in Data.Swagger.Lens | |
HasDescription Header (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' Header (Maybe Text) Source # | |
HasParamSchema Header (ParamSchema ('SwaggerKindNormal Header)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' Header (ParamSchema ('SwaggerKindNormal Header)) Source # | |
HasType Header (Maybe (SwaggerType ('SwaggerKindNormal Header))) Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' Header (Maybe (SwaggerType ('SwaggerKindNormal Header))) Source # | |
HasHeaders Response (InsOrdHashMap HeaderName Header) Source # | |
Defined in Data.Swagger.Lens | |
type Rep Header Source # | |
Defined in Data.Swagger.Internal type Rep Header = D1 ('MetaData "Header" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "Header" 'PrefixI 'True) (S1 ('MetaSel ('Just "_headerDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_headerParamSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParamSchema ('SwaggerKindNormal Header))))) | |
type Code Header Source # | |
Defined in Data.Swagger.Internal | |
type DatatypeInfoOf Header Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Header = 'ADT "Data.Swagger.Internal" "Header" '['Record "Header" '['FieldInfo "_headerDescription", 'FieldInfo "_headerParamSchema"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] |
type HeaderName = Text Source #
Example | |
|
Instances
Data Example Source # | |
Defined in Data.Swagger.Internal 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 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 | |
Monoid Example Source # | |
Semigroup Example Source # | |
Generic Example Source # | |
Show Example Source # | |
Eq Example Source # | |
FromJSON Example Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Example parseJSONList :: Value -> Parser [Example] | |
ToJSON Example Source # | |
Defined in Data.Swagger.Internal toEncoding :: Example -> Encoding toJSONList :: [Example] -> Value toEncodingList :: [Example] -> Encoding | |
HasExamples Response (Maybe Example) Source # | |
type Rep Example Source # | |
Defined in Data.Swagger.Internal type Rep Example = D1 ('MetaData "Example" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "Example" 'PrefixI 'True) (S1 ('MetaSel ('Just "getExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map MediaType Value)))) |
Schemas
data ParamSchema (t :: SwaggerKind *) Source #
ParamSchema | |
|
Instances
(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe (SwaggerItems t), b ~ Maybe (SwaggerItems t)) => LabelOptic "items" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Pattern, b ~ Maybe Pattern) => LabelOptic "pattern" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe (SwaggerType t), b ~ Maybe (SwaggerType t)) => LabelOptic "type" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" k (ParamSchema t) (ParamSchema t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx (ParamSchema t) (ParamSchema t) a b | |
HasParamSchema Header (ParamSchema ('SwaggerKindNormal Header)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' Header (ParamSchema ('SwaggerKindNormal Header)) Source # | |
HasParamSchema NamedSchema (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' NamedSchema (ParamSchema 'SwaggerKindSchema) Source # | |
HasParamSchema ParamOtherSchema (ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens | |
HasParamSchema Schema (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' Schema (ParamSchema 'SwaggerKindSchema) Source # | |
(Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k) Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParamSchema k -> c (ParamSchema k) gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (ParamSchema k) toConstr :: ParamSchema k -> Constr dataTypeOf :: ParamSchema k -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (ParamSchema k)) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (ParamSchema k)) gmapT :: (forall b. Data b => b -> b) -> ParamSchema k -> ParamSchema k gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParamSchema k -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParamSchema k -> r gmapQ :: (forall d. Data d => d -> u) -> ParamSchema k -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> ParamSchema k -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParamSchema k -> m (ParamSchema k) gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamSchema k -> m (ParamSchema k) gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParamSchema k -> m (ParamSchema k) | |
Monoid (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal mempty :: ParamSchema t mappend :: ParamSchema t -> ParamSchema t -> ParamSchema t mconcat :: [ParamSchema t] -> ParamSchema t | |
Semigroup (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal (<>) :: ParamSchema t -> ParamSchema t -> ParamSchema t sconcat :: NonEmpty (ParamSchema t) -> ParamSchema t stimes :: Integral b => b -> ParamSchema t -> ParamSchema t | |
Generic (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal type Rep (ParamSchema t) :: Type -> Type from :: ParamSchema t -> Rep (ParamSchema t) x to :: Rep (ParamSchema t) x -> ParamSchema t | |
Show (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ParamSchema t -> ShowS show :: ParamSchema t -> String showList :: [ParamSchema t] -> ShowS | |
Eq (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal (==) :: ParamSchema t -> ParamSchema t -> Bool (/=) :: ParamSchema t -> ParamSchema t -> Bool | |
Generic (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal type Code (ParamSchema t) :: [[Type]] from :: ParamSchema t -> Rep (ParamSchema t) to :: Rep (ParamSchema t) -> ParamSchema t | |
HasDatatypeInfo (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf (ParamSchema t) :: DatatypeInfo datatypeInfo :: proxy (ParamSchema t) -> DatatypeInfo (Code (ParamSchema t)) | |
(FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (ParamSchema ('SwaggerKindNormal t)) parseJSONList :: Value -> Parser [ParamSchema ('SwaggerKindNormal t)] | |
FromJSON (ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (ParamSchema 'SwaggerKindParamOtherSchema) parseJSONList :: Value -> Parser [ParamSchema 'SwaggerKindParamOtherSchema] | |
FromJSON (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (ParamSchema 'SwaggerKindSchema) parseJSONList :: Value -> Parser [ParamSchema 'SwaggerKindSchema] | |
ToJSON (ParamSchema k) Source # | |
Defined in Data.Swagger.Internal toJSON :: ParamSchema k -> Value toEncoding :: ParamSchema k -> Encoding toJSONList :: [ParamSchema k] -> Value toEncodingList :: [ParamSchema k] -> Encoding | |
AesonDefaultValue (ParamSchema s) Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe (ParamSchema s) Source # | |
HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy (ParamSchema ('SwaggerKindNormal t)) -> SwaggerAesonOptions Source # aesonDefaults :: Proxy (ParamSchema ('SwaggerKindNormal t)) -> POP Maybe (Code (ParamSchema ('SwaggerKindNormal t))) Source # | |
HasSwaggerAesonOptions (ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy (ParamSchema 'SwaggerKindParamOtherSchema) -> SwaggerAesonOptions Source # aesonDefaults :: Proxy (ParamSchema 'SwaggerKindParamOtherSchema) -> POP Maybe (Code (ParamSchema 'SwaggerKindParamOtherSchema)) Source # | |
HasSwaggerAesonOptions (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy (ParamSchema 'SwaggerKindSchema) -> SwaggerAesonOptions Source # aesonDefaults :: Proxy (ParamSchema 'SwaggerKindSchema) -> POP Maybe (Code (ParamSchema 'SwaggerKindSchema)) Source # | |
SwaggerMonoid (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal swaggerMempty :: ParamSchema t Source # swaggerMappend :: ParamSchema t -> ParamSchema t -> ParamSchema t Source # | |
HasDefault (ParamSchema t) (Maybe Value) Source # | |
Defined in Data.Swagger.Lens default_ :: Lens' (ParamSchema t) (Maybe Value) Source # | |
HasEnum (ParamSchema t) (Maybe [Value]) Source # | |
Defined in Data.Swagger.Lens enum_ :: Lens' (ParamSchema t) (Maybe [Value]) Source # | |
HasExclusiveMaximum (ParamSchema t) (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens exclusiveMaximum :: Lens' (ParamSchema t) (Maybe Bool) Source # | |
HasExclusiveMinimum (ParamSchema t) (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens exclusiveMinimum :: Lens' (ParamSchema t) (Maybe Bool) Source # | |
HasFormat (ParamSchema t) (Maybe Format) Source # | |
Defined in Data.Swagger.Lens format :: Lens' (ParamSchema t) (Maybe Format) Source # | |
HasItems (ParamSchema t) (Maybe (SwaggerItems t)) Source # | |
Defined in Data.Swagger.Lens items :: Lens' (ParamSchema t) (Maybe (SwaggerItems t)) Source # | |
HasMaxItems (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens maxItems :: Lens' (ParamSchema t) (Maybe Integer) Source # | |
HasMaxLength (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens maxLength :: Lens' (ParamSchema t) (Maybe Integer) Source # | |
HasMaximum (ParamSchema t) (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens maximum_ :: Lens' (ParamSchema t) (Maybe Scientific) Source # | |
HasMinItems (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens minItems :: Lens' (ParamSchema t) (Maybe Integer) Source # | |
HasMinLength (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens minLength :: Lens' (ParamSchema t) (Maybe Integer) Source # | |
HasMinimum (ParamSchema t) (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens minimum_ :: Lens' (ParamSchema t) (Maybe Scientific) Source # | |
HasMultipleOf (ParamSchema t) (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens multipleOf :: Lens' (ParamSchema t) (Maybe Scientific) Source # | |
HasPattern (ParamSchema t) (Maybe Pattern) Source # | |
Defined in Data.Swagger.Lens pattern :: Lens' (ParamSchema t) (Maybe Pattern) Source # | |
HasType (ParamSchema t) (Maybe (SwaggerType t)) Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' (ParamSchema t) (Maybe (SwaggerType t)) Source # | |
HasUniqueItems (ParamSchema t) (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens uniqueItems :: Lens' (ParamSchema t) (Maybe Bool) Source # | |
type Rep (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal type Rep (ParamSchema t) = D1 ('MetaData "ParamSchema" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "ParamSchema" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "_paramSchemaDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_paramSchemaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (SwaggerType t)))) :*: (S1 ('MetaSel ('Just "_paramSchemaFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Format)) :*: S1 ('MetaSel ('Just "_paramSchemaItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (SwaggerItems t))))) :*: ((S1 ('MetaSel ('Just "_paramSchemaMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)) :*: S1 ('MetaSel ('Just "_paramSchemaExclusiveMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "_paramSchemaMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)) :*: S1 ('MetaSel ('Just "_paramSchemaExclusiveMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "_paramSchemaMaxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_paramSchemaMinLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_paramSchemaPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pattern)) :*: S1 ('MetaSel ('Just "_paramSchemaMaxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "_paramSchemaMinItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_paramSchemaUniqueItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "_paramSchemaEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Value])) :*: S1 ('MetaSel ('Just "_paramSchemaMultipleOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific))))))) | |
type Code (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal type Code (ParamSchema t) = '['[Maybe Value, Maybe (SwaggerType t), Maybe Format, Maybe (SwaggerItems t), 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 (ParamSchema t) Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf (ParamSchema t) = 'ADT "Data.Swagger.Internal" "ParamSchema" '['Record "ParamSchema" '['FieldInfo "_paramSchemaDefault", 'FieldInfo "_paramSchemaType", 'FieldInfo "_paramSchemaFormat", 'FieldInfo "_paramSchemaItems", 'FieldInfo "_paramSchemaMaximum", 'FieldInfo "_paramSchemaExclusiveMaximum", 'FieldInfo "_paramSchemaMinimum", 'FieldInfo "_paramSchemaExclusiveMinimum", 'FieldInfo "_paramSchemaMaxLength", 'FieldInfo "_paramSchemaMinLength", 'FieldInfo "_paramSchemaPattern", 'FieldInfo "_paramSchemaMaxItems", 'FieldInfo "_paramSchemaMinItems", 'FieldInfo "_paramSchemaUniqueItems", 'FieldInfo "_paramSchemaEnum", 'FieldInfo "_paramSchemaMultipleOf"]] '['['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]] |
Schema | |
|
Instances
Data Schema Source # | |
Defined in Data.Swagger.Internal 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 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 # | |
Show Schema Source # | |
Eq Schema Source # | |
Generic Schema Source # | |
HasDatatypeInfo Schema Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Schema :: DatatypeInfo datatypeInfo :: proxy Schema -> DatatypeInfo (Code Schema) | |
FromJSON Schema Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Schema parseJSONList :: Value -> Parser [Schema] | |
ToJSON Schema Source # | |
Defined in Data.Swagger.Internal toEncoding :: Schema -> Encoding toJSONList :: [Schema] -> Value toEncodingList :: [Schema] -> Encoding | |
HasSwaggerAesonOptions Schema Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Schema -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Schema -> POP Maybe (Code Schema) Source # | |
SwaggerMonoid Schema Source # | |
Defined in Data.Swagger.Internal | |
HasSchema NamedSchema Schema Source # | |
Defined in Data.Swagger.Lens schema :: Lens' NamedSchema Schema Source # | |
(k ~ A_Lens, a ~ Maybe AdditionalProperties, b ~ Maybe AdditionalProperties) => LabelOptic "additionalProperties" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "allOf" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "discriminator" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)), b ~ Maybe (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type))) => LabelOptic "items" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxProperties" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minProperties" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ ParamSchema ('SwaggerKindSchema :: SwaggerKind Type), b ~ ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) => LabelOptic "paramSchema" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Schema), b ~ InsOrdHashMap Text (Referenced Schema)) => LabelOptic "properties" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "readOnly" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ [ParamName], b ~ [ParamName]) => LabelOptic "required" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "title" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
(a ~ Maybe (SwaggerType ('SwaggerKindSchema :: SwaggerKind Type)), b ~ Maybe (SwaggerType ('SwaggerKindSchema :: SwaggerKind Type))) => LabelOptic "type" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx Schema Schema a b | |
(k ~ A_Lens, a ~ Maybe Xml, b ~ Maybe Xml) => LabelOptic "xml" k Schema Schema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Schema Schema a b | |
HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # | |
Defined in Data.Swagger.Lens additionalProperties :: Lens' Schema (Maybe AdditionalProperties) Source # | |
HasAllOf Schema (Maybe [Referenced Schema]) Source # | |
Defined in Data.Swagger.Lens | |
HasDefault Schema (Maybe Value) Source # | |
Defined in Data.Swagger.Lens | |
HasDefinitions Swagger (Definitions Schema) Source # | |
Defined in Data.Swagger.Lens definitions :: Lens' Swagger (Definitions Schema) Source # | |
HasDescription Schema (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' Schema (Maybe Text) Source # | |
HasDiscriminator Schema (Maybe Text) Source # | |
Defined in Data.Swagger.Lens discriminator :: Lens' Schema (Maybe Text) Source # | |
HasExample Schema (Maybe Value) Source # | |
Defined in Data.Swagger.Lens | |
HasExternalDocs Schema (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Schema (Maybe ExternalDocs) Source # | |
HasMaxProperties Schema (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens maxProperties :: Lens' Schema (Maybe Integer) Source # | |
HasMinProperties Schema (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens minProperties :: Lens' Schema (Maybe Integer) Source # | |
HasParamSchema Schema (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' Schema (ParamSchema 'SwaggerKindSchema) Source # | |
HasReadOnly Schema (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens | |
HasRequired Schema [ParamName] Source # | |
HasSchema Response (Maybe (Referenced Schema)) Source # | |
Defined in Data.Swagger.Lens | |
HasTitle Schema (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasType Schema (Maybe (SwaggerType ('SwaggerKindSchema :: SwaggerKind Type))) Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' Schema (Maybe (SwaggerType 'SwaggerKindSchema)) Source # | |
HasXml Schema (Maybe Xml) Source # | |
HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
Defined in Data.Swagger.Lens properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
FromJSON (Referenced Schema) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (Referenced Schema) parseJSONList :: Value -> Parser [Referenced Schema] | |
ToJSON (Referenced Schema) Source # | |
Defined in Data.Swagger.Internal toJSON :: Referenced Schema -> Value toEncoding :: Referenced Schema -> Encoding toJSONList :: [Referenced Schema] -> Value toEncodingList :: [Referenced Schema] -> Encoding | |
type Rep Schema Source # | |
Defined in Data.Swagger.Internal type Rep Schema = D1 ('MetaData "Schema" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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 "_schemaAllOf") '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 Text))))) :*: ((S1 ('MetaSel ('Just "_schemaReadOnly") '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 "_schemaMaxProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaMinProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaParamSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)))))))) | |
type Code Schema Source # | |
Defined in Data.Swagger.Internal type Code Schema = '['[Maybe Text, Maybe Text, [ParamName], Maybe [Referenced Schema], InsOrdHashMap Text (Referenced Schema), Maybe AdditionalProperties, Maybe Text, Maybe Bool, Maybe Xml, Maybe ExternalDocs, Maybe Value, Maybe Integer, Maybe Integer, ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)]] | |
type DatatypeInfoOf Schema Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Schema = 'ADT "Data.Swagger.Internal" "Schema" '['Record "Schema" '['FieldInfo "_schemaTitle", 'FieldInfo "_schemaDescription", 'FieldInfo "_schemaRequired", 'FieldInfo "_schemaAllOf", 'FieldInfo "_schemaProperties", 'FieldInfo "_schemaAdditionalProperties", 'FieldInfo "_schemaDiscriminator", 'FieldInfo "_schemaReadOnly", 'FieldInfo "_schemaXml", 'FieldInfo "_schemaExternalDocs", 'FieldInfo "_schemaExample", 'FieldInfo "_schemaMaxProperties", 'FieldInfo "_schemaMinProperties", 'FieldInfo "_schemaParamSchema"]] '['['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 NamedSchema Source #
A
with an optional name.
This name can be used in references.Schema
NamedSchema | |
|
Instances
Data NamedSchema Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal type Rep NamedSchema :: Type -> Type from :: NamedSchema -> Rep NamedSchema x to :: Rep NamedSchema x -> NamedSchema | |
Show NamedSchema Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> NamedSchema -> ShowS show :: NamedSchema -> String showList :: [NamedSchema] -> ShowS | |
Eq NamedSchema Source # | |
Defined in Data.Swagger.Internal (==) :: NamedSchema -> NamedSchema -> Bool (/=) :: NamedSchema -> NamedSchema -> Bool | |
HasSchema NamedSchema Schema Source # | |
Defined in Data.Swagger.Lens schema :: Lens' NamedSchema Schema Source # | |
(a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)), b ~ Maybe (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type))) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics 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 | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx NamedSchema NamedSchema a b | |
(a ~ ParamSchema ('SwaggerKindSchema :: SwaggerKind Type), b ~ ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) => LabelOptic "paramSchema" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(k ~ A_Lens, a ~ Schema, b ~ Schema) => LabelOptic "schema" k NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe (SwaggerType ('SwaggerKindSchema :: SwaggerKind Type)), b ~ Maybe (SwaggerType ('SwaggerKindSchema :: SwaggerKind Type))) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b | |
HasName NamedSchema (Maybe Text) Source # | |
Defined in Data.Swagger.Lens name :: Lens' NamedSchema (Maybe Text) Source # | |
HasParamSchema NamedSchema (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' NamedSchema (ParamSchema 'SwaggerKindSchema) Source # | |
HasType NamedSchema (Maybe (SwaggerType ('SwaggerKindSchema :: SwaggerKind Type))) Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' NamedSchema (Maybe (SwaggerType 'SwaggerKindSchema)) Source # | |
type Rep NamedSchema Source # | |
Defined in Data.Swagger.Internal type Rep NamedSchema = D1 ('MetaData "NamedSchema" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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))) |
data SwaggerItems (t :: SwaggerKind *) where Source #
Items for
schemas.SwaggerArray
should be used only for query params, headers and path pieces.
The SwaggerItemsPrimitive
parameter specifies how elements of an array should be displayed.
Note that CollectionFormat
tfmt
in
specifies format for elements of type SwaggerItemsPrimitive
fmt schemaschema
.
This is different from the original Swagger's Items Object.
should be used to specify homogenous array SwaggerItemsObject
s.Schema
should be used to specify tuple SwaggerItemsArray
s.Schema
SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k -> SwaggerItems k | |
SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema | |
SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema |
Instances
(a ~ [Referenced Schema], b ~ [Referenced Schema]) => LabelOptic "_SwaggerItemsArray" A_Review (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)) (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Review NoIx (SwaggerItems 'SwaggerKindSchema) (SwaggerItems 'SwaggerKindSchema) a b | |
(a ~ Referenced Schema, b ~ Referenced Schema) => LabelOptic "_SwaggerItemsObject" A_Review (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)) (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Review NoIx (SwaggerItems 'SwaggerKindSchema) (SwaggerItems 'SwaggerKindSchema) a b | |
(a ~ (Maybe (CollectionFormat t), ParamSchema t), b ~ (Maybe (CollectionFormat t), ParamSchema t)) => LabelOptic "_SwaggerItemsPrimitive" A_Review (SwaggerItems t) (SwaggerItems t) a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic A_Review NoIx (SwaggerItems t) (SwaggerItems t) a b | |
HasParamSchema s (ParamSchema t) => HasItems s (Maybe (SwaggerItems t)) Source # | |
Defined in Data.Swagger.Lens items :: Lens' s (Maybe (SwaggerItems t)) Source # | |
Data t => Data (SwaggerItems ('SwaggerKindNormal t)) Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwaggerItems ('SwaggerKindNormal t) -> c (SwaggerItems ('SwaggerKindNormal t)) gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SwaggerItems ('SwaggerKindNormal t)) toConstr :: SwaggerItems ('SwaggerKindNormal t) -> Constr dataTypeOf :: SwaggerItems ('SwaggerKindNormal t) -> DataType dataCast1 :: Typeable t0 => (forall d. Data d => c (t0 d)) -> Maybe (c (SwaggerItems ('SwaggerKindNormal t))) dataCast2 :: Typeable t0 => (forall d e. (Data d, Data e) => c (t0 d e)) -> Maybe (c (SwaggerItems ('SwaggerKindNormal t))) gmapT :: (forall b. Data b => b -> b) -> SwaggerItems ('SwaggerKindNormal t) -> SwaggerItems ('SwaggerKindNormal t) gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems ('SwaggerKindNormal t) -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems ('SwaggerKindNormal t) -> r gmapQ :: (forall d. Data d => d -> u) -> SwaggerItems ('SwaggerKindNormal t) -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerItems ('SwaggerKindNormal t) -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerItems ('SwaggerKindNormal t) -> m (SwaggerItems ('SwaggerKindNormal t)) gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems ('SwaggerKindNormal t) -> m (SwaggerItems ('SwaggerKindNormal t)) gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems ('SwaggerKindNormal t) -> m (SwaggerItems ('SwaggerKindNormal t)) | |
Data (SwaggerItems ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwaggerItems 'SwaggerKindParamOtherSchema -> c (SwaggerItems 'SwaggerKindParamOtherSchema) gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SwaggerItems 'SwaggerKindParamOtherSchema) toConstr :: SwaggerItems 'SwaggerKindParamOtherSchema -> Constr dataTypeOf :: SwaggerItems 'SwaggerKindParamOtherSchema -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (SwaggerItems 'SwaggerKindParamOtherSchema)) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SwaggerItems 'SwaggerKindParamOtherSchema)) gmapT :: (forall b. Data b => b -> b) -> SwaggerItems 'SwaggerKindParamOtherSchema -> SwaggerItems 'SwaggerKindParamOtherSchema gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems 'SwaggerKindParamOtherSchema -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems 'SwaggerKindParamOtherSchema -> r gmapQ :: (forall d. Data d => d -> u) -> SwaggerItems 'SwaggerKindParamOtherSchema -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerItems 'SwaggerKindParamOtherSchema -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerItems 'SwaggerKindParamOtherSchema -> m (SwaggerItems 'SwaggerKindParamOtherSchema) gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems 'SwaggerKindParamOtherSchema -> m (SwaggerItems 'SwaggerKindParamOtherSchema) gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems 'SwaggerKindParamOtherSchema -> m (SwaggerItems 'SwaggerKindParamOtherSchema) | |
Data (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwaggerItems 'SwaggerKindSchema -> c (SwaggerItems 'SwaggerKindSchema) gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SwaggerItems 'SwaggerKindSchema) toConstr :: SwaggerItems 'SwaggerKindSchema -> Constr dataTypeOf :: SwaggerItems 'SwaggerKindSchema -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (SwaggerItems 'SwaggerKindSchema)) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SwaggerItems 'SwaggerKindSchema)) gmapT :: (forall b. Data b => b -> b) -> SwaggerItems 'SwaggerKindSchema -> SwaggerItems 'SwaggerKindSchema gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems 'SwaggerKindSchema -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems 'SwaggerKindSchema -> r gmapQ :: (forall d. Data d => d -> u) -> SwaggerItems 'SwaggerKindSchema -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerItems 'SwaggerKindSchema -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerItems 'SwaggerKindSchema -> m (SwaggerItems 'SwaggerKindSchema) gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems 'SwaggerKindSchema -> m (SwaggerItems 'SwaggerKindSchema) gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems 'SwaggerKindSchema -> m (SwaggerItems 'SwaggerKindSchema) | |
Show (SwaggerItems t) Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> SwaggerItems t -> ShowS show :: SwaggerItems t -> String showList :: [SwaggerItems t] -> ShowS | |
Eq (SwaggerItems t) Source # | |
Defined in Data.Swagger.Internal (==) :: SwaggerItems t -> SwaggerItems t -> Bool (/=) :: SwaggerItems t -> SwaggerItems t -> Bool | |
(FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (SwaggerItems ('SwaggerKindNormal t)) parseJSONList :: Value -> Parser [SwaggerItems ('SwaggerKindNormal t)] | |
FromJSON (SwaggerItems ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (SwaggerItems 'SwaggerKindParamOtherSchema) parseJSONList :: Value -> Parser [SwaggerItems 'SwaggerKindParamOtherSchema] | |
FromJSON (SwaggerItems ('SwaggerKindSchema :: SwaggerKind Type)) Source # |
|
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (SwaggerItems 'SwaggerKindSchema) parseJSONList :: Value -> Parser [SwaggerItems 'SwaggerKindSchema] | |
ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) Source # | As for nullary schema for 0-arity type constructors, see https://github.com/GetShopTV/swagger2/issues/167.
|
Defined in Data.Swagger.Internal toJSON :: SwaggerItems t -> Value toEncoding :: SwaggerItems t -> Encoding toJSONList :: [SwaggerItems t] -> Value toEncodingList :: [SwaggerItems t] -> Encoding | |
HasItems (ParamSchema t) (Maybe (SwaggerItems t)) Source # | |
Defined in Data.Swagger.Lens items :: Lens' (ParamSchema t) (Maybe (SwaggerItems t)) Source # |
Xml | |
|
Instances
Data Xml Source # | |
Defined in Data.Swagger.Internal 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 # | |
Show Xml Source # | |
Eq Xml Source # | |
FromJSON Xml Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Xml parseJSONList :: Value -> Parser [Xml] | |
ToJSON Xml Source # | |
Defined in Data.Swagger.Internal | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "attribute" k Xml Xml a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Xml Xml a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k Xml Xml a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Xml Xml a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "namespace" k Xml Xml a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Xml Xml a b | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "prefix" k Xml Xml a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Xml Xml a b | |
(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "wrapped" k Xml Xml a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Xml Xml a b | |
HasAttribute Xml (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens | |
HasName Xml (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasNamespace Xml (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasPrefix Xml (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasWrapped Xml (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens | |
HasXml Schema (Maybe Xml) Source # | |
type Rep Xml Source # | |
Defined in Data.Swagger.Internal type Rep Xml = D1 ('MetaData "Xml" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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)))))) |
data AdditionalProperties Source #
Instances
Responses
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.
Responses | |
|
Instances
Data Responses Source # | |
Defined in Data.Swagger.Internal 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 # | |
Show Responses Source # | |
Eq Responses Source # | |
Generic Responses Source # | |
HasDatatypeInfo Responses Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Responses :: DatatypeInfo datatypeInfo :: proxy Responses -> DatatypeInfo (Code Responses) | |
At Responses | |
Defined in Data.Swagger.Lens | |
Ixed Responses | |
Defined in Data.Swagger.Lens | |
At Responses | |
Defined in Data.Swagger.Optics | |
Ixed Responses | |
FromJSON Responses Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Responses parseJSONList :: Value -> Parser [Responses] | |
ToJSON Responses Source # | |
Defined in Data.Swagger.Internal toEncoding :: Responses -> Encoding toJSONList :: [Responses] -> Value toEncodingList :: [Responses] -> Encoding | |
AesonDefaultValue Responses Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe Responses Source # | |
HasSwaggerAesonOptions Responses Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Responses -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Responses -> POP Maybe (Code Responses) Source # | |
SwaggerMonoid Responses Source # | |
Defined in Data.Swagger.Internal swaggerMempty :: Responses Source # swaggerMappend :: Responses -> Responses -> Responses Source # | |
HasResponses Operation Responses Source # | |
(k ~ A_Lens, a ~ Maybe (Referenced Response), b ~ Maybe (Referenced Response)) => LabelOptic "default" k Responses Responses a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Responses Responses a b | |
(k ~ A_Lens, a ~ InsOrdHashMap HttpStatusCode (Referenced Response), b ~ InsOrdHashMap HttpStatusCode (Referenced Response)) => LabelOptic "responses" k Responses Responses a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Responses Responses a b | |
HasDefault Responses (Maybe (Referenced Response)) Source # | |
Defined in Data.Swagger.Lens | |
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
Defined in Data.Swagger.Lens responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
type Rep Responses Source # | |
Defined in Data.Swagger.Internal type Rep Responses = D1 ('MetaData "Responses" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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.Swagger.Internal type Code Responses = '['[Maybe (Referenced Response), InsOrdHashMap HttpStatusCode (Referenced Response)]] | |
type DatatypeInfoOf Responses Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Responses = 'ADT "Data.Swagger.Internal" "Responses" '['Record "Responses" '['FieldInfo "_responsesDefault", 'FieldInfo "_responsesResponses"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] | |
type Index Responses | |
Defined in Data.Swagger.Lens | |
type IxValue Responses | |
Defined in Data.Swagger.Lens | |
type Index Responses | |
Defined in Data.Swagger.Optics | |
type IxKind Responses | |
Defined in Data.Swagger.Optics type IxKind Responses = An_AffineTraversal | |
type IxValue Responses | |
Defined in Data.Swagger.Optics |
Describes a single response from an API Operation.
Response | |
|
Instances
Data Response Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal fromString :: String -> Response | |
Monoid Response Source # | |
Semigroup Response Source # | |
Generic Response Source # | |
Show Response Source # | |
Eq Response Source # | |
Generic Response Source # | |
HasDatatypeInfo Response Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Response :: DatatypeInfo datatypeInfo :: proxy Response -> DatatypeInfo (Code Response) | |
FromJSON Response Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Response parseJSONList :: Value -> Parser [Response] | |
ToJSON Response Source # | |
Defined in Data.Swagger.Internal toEncoding :: Response -> Encoding toJSONList :: [Response] -> Value toEncodingList :: [Response] -> Encoding | |
HasSwaggerAesonOptions Response Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy Response -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Response -> POP Maybe (Code Response) Source # | |
SwaggerMonoid Response Source # | |
Defined in Data.Swagger.Internal | |
HasDescription Response Text Source # | |
Defined in Data.Swagger.Lens description :: Lens' Response Text Source # | |
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "description" k Response Response a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Response Response a b | |
(k ~ A_Lens, a ~ Maybe Example, b ~ Maybe Example) => LabelOptic "examples" k Response Response a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Response Response a b | |
(k ~ A_Lens, a ~ InsOrdHashMap HeaderName Header, b ~ InsOrdHashMap HeaderName Header) => LabelOptic "headers" k Response Response a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Response Response a b | |
(k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k Response Response a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx Response Response a b | |
HasDefault Responses (Maybe (Referenced Response)) Source # | |
Defined in Data.Swagger.Lens | |
HasExamples Response (Maybe Example) Source # | |
HasResponses Swagger (Definitions Response) Source # | |
Defined in Data.Swagger.Lens | |
HasSchema Response (Maybe (Referenced Schema)) Source # | |
Defined in Data.Swagger.Lens | |
HasHeaders Response (InsOrdHashMap HeaderName Header) Source # | |
Defined in Data.Swagger.Lens | |
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
Defined in Data.Swagger.Lens responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
FromJSON (Referenced Response) Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser (Referenced Response) parseJSONList :: Value -> Parser [Referenced Response] | |
ToJSON (Referenced Response) Source # | |
Defined in Data.Swagger.Internal toJSON :: Referenced Response -> Value toEncoding :: Referenced Response -> Encoding toJSONList :: [Referenced Response] -> Value toEncodingList :: [Referenced Response] -> Encoding | |
type Rep Response Source # | |
Defined in Data.Swagger.Internal type Rep Response = D1 ('MetaData "Response" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "Response" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_responseDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_responseSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema)))) :*: (S1 ('MetaSel ('Just "_responseHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HeaderName Header)) :*: S1 ('MetaSel ('Just "_responseExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Example))))) | |
type Code Response Source # | |
Defined in Data.Swagger.Internal type Code Response = '['[Text, Maybe (Referenced Schema), InsOrdHashMap HeaderName Header, Maybe Example]] | |
type DatatypeInfoOf Response Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf Response = 'ADT "Data.Swagger.Internal" "Response" '['Record "Response" '['FieldInfo "_responseDescription", 'FieldInfo "_responseSchema", 'FieldInfo "_responseHeaders", 'FieldInfo "_responseExamples"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] |
type HttpStatusCode = Int Source #
Security
data SecurityScheme Source #
SecurityScheme | |
|
Instances
Data SecurityScheme Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal (<>) :: SecurityScheme -> SecurityScheme -> SecurityScheme sconcat :: NonEmpty SecurityScheme -> SecurityScheme stimes :: Integral b => b -> SecurityScheme -> SecurityScheme | |
Generic SecurityScheme Source # | |
Defined in Data.Swagger.Internal type Rep SecurityScheme :: Type -> Type from :: SecurityScheme -> Rep SecurityScheme x to :: Rep SecurityScheme x -> SecurityScheme | |
Show SecurityScheme Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> SecurityScheme -> ShowS show :: SecurityScheme -> String showList :: [SecurityScheme] -> ShowS | |
Eq SecurityScheme Source # | |
Defined in Data.Swagger.Internal (==) :: SecurityScheme -> SecurityScheme -> Bool (/=) :: SecurityScheme -> SecurityScheme -> Bool | |
Generic SecurityScheme Source # | |
Defined in Data.Swagger.Internal type Code SecurityScheme :: [[Type]] from :: SecurityScheme -> Rep SecurityScheme to :: Rep SecurityScheme -> SecurityScheme | |
HasDatatypeInfo SecurityScheme Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf SecurityScheme :: DatatypeInfo datatypeInfo :: proxy SecurityScheme -> DatatypeInfo (Code SecurityScheme) | |
FromJSON SecurityScheme Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser SecurityScheme parseJSONList :: Value -> Parser [SecurityScheme] | |
ToJSON SecurityScheme Source # | |
Defined in Data.Swagger.Internal toJSON :: SecurityScheme -> Value toEncoding :: SecurityScheme -> Encoding toJSONList :: [SecurityScheme] -> Value toEncodingList :: [SecurityScheme] -> Encoding | |
HasSwaggerAesonOptions SecurityScheme Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy SecurityScheme -> SwaggerAesonOptions Source # aesonDefaults :: Proxy SecurityScheme -> POP Maybe (Code SecurityScheme) Source # | |
HasType SecurityScheme SecuritySchemeType Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' SecurityScheme SecuritySchemeType Source # | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k SecurityScheme SecurityScheme a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b | |
(k ~ A_Lens, a ~ SecuritySchemeType, b ~ SecuritySchemeType) => LabelOptic "type" k SecurityScheme SecurityScheme a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b | |
HasDescription SecurityScheme (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' SecurityScheme (Maybe Text) Source # | |
type Rep SecurityScheme Source # | |
Defined in Data.Swagger.Internal type Rep SecurityScheme = D1 ('MetaData "SecurityScheme" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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.Swagger.Internal | |
type DatatypeInfoOf SecurityScheme Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf SecurityScheme = 'ADT "Data.Swagger.Internal" "SecurityScheme" '['Record "SecurityScheme" '['FieldInfo "_securitySchemeType", 'FieldInfo "_securitySchemeDescription"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] |
data SecuritySchemeType Source #
Instances
Data SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal type Rep SecuritySchemeType :: Type -> Type from :: SecuritySchemeType -> Rep SecuritySchemeType x to :: Rep SecuritySchemeType x -> SecuritySchemeType | |
Show SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> SecuritySchemeType -> ShowS show :: SecuritySchemeType -> String showList :: [SecuritySchemeType] -> ShowS | |
Eq SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal (==) :: SecuritySchemeType -> SecuritySchemeType -> Bool (/=) :: SecuritySchemeType -> SecuritySchemeType -> Bool | |
FromJSON SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser SecuritySchemeType parseJSONList :: Value -> Parser [SecuritySchemeType] | |
ToJSON SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal toJSON :: SecuritySchemeType -> Value toEncoding :: SecuritySchemeType -> Encoding toJSONList :: [SecuritySchemeType] -> Value toEncodingList :: [SecuritySchemeType] -> Encoding | |
AesonDefaultValue SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe SecuritySchemeType Source # | |
HasType SecurityScheme SecuritySchemeType Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' SecurityScheme SecuritySchemeType Source # | |
(k ~ A_Prism, a ~ ApiKeyParams, b ~ ApiKeyParams) => LabelOptic "_SecuritySchemeApiKey" k SecuritySchemeType SecuritySchemeType a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b | |
(k ~ A_Prism, a ~ (), b ~ ()) => LabelOptic "_SecuritySchemeBasic" k SecuritySchemeType SecuritySchemeType a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b | |
(k ~ A_Prism, a ~ OAuth2Params, b ~ OAuth2Params) => LabelOptic "_SecuritySchemeOAuth2" k SecuritySchemeType SecuritySchemeType a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b | |
type Rep SecuritySchemeType Source # | |
Defined in Data.Swagger.Internal type Rep SecuritySchemeType = D1 ('MetaData "SecuritySchemeType" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "SecuritySchemeBasic" 'PrefixI 'False) (U1 :: Type -> Type) :+: (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 OAuth2Params)))) |
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).
SecurityRequirement | |
|
Instances
newtype SecurityDefinitions Source #
Instances
API key
data ApiKeyParams Source #
ApiKeyParams | |
|
Instances
Data ApiKeyParams Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal type Rep ApiKeyParams :: Type -> Type from :: ApiKeyParams -> Rep ApiKeyParams x to :: Rep ApiKeyParams x -> ApiKeyParams | |
Show ApiKeyParams Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ApiKeyParams -> ShowS show :: ApiKeyParams -> String showList :: [ApiKeyParams] -> ShowS | |
Eq ApiKeyParams Source # | |
Defined in Data.Swagger.Internal (==) :: ApiKeyParams -> ApiKeyParams -> Bool (/=) :: ApiKeyParams -> ApiKeyParams -> Bool | |
FromJSON ApiKeyParams Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser ApiKeyParams parseJSONList :: Value -> Parser [ApiKeyParams] | |
ToJSON ApiKeyParams Source # | |
Defined in Data.Swagger.Internal toJSON :: ApiKeyParams -> Value toEncoding :: ApiKeyParams -> Encoding toJSONList :: [ApiKeyParams] -> Value toEncodingList :: [ApiKeyParams] -> Encoding | |
type Rep ApiKeyParams Source # | |
Defined in Data.Swagger.Internal type Rep ApiKeyParams = D1 ('MetaData "ApiKeyParams" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "ApiKeyParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "_apiKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_apiKeyIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiKeyLocation))) |
data ApiKeyLocation Source #
The location of the API key.
Instances
Data ApiKeyLocation Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal type Rep ApiKeyLocation :: Type -> Type from :: ApiKeyLocation -> Rep ApiKeyLocation x to :: Rep ApiKeyLocation x -> ApiKeyLocation | |
Show ApiKeyLocation Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ApiKeyLocation -> ShowS show :: ApiKeyLocation -> String showList :: [ApiKeyLocation] -> ShowS | |
Eq ApiKeyLocation Source # | |
Defined in Data.Swagger.Internal (==) :: ApiKeyLocation -> ApiKeyLocation -> Bool (/=) :: ApiKeyLocation -> ApiKeyLocation -> Bool | |
FromJSON ApiKeyLocation Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser ApiKeyLocation parseJSONList :: Value -> Parser [ApiKeyLocation] | |
ToJSON ApiKeyLocation Source # | |
Defined in Data.Swagger.Internal toJSON :: ApiKeyLocation -> Value toEncoding :: ApiKeyLocation -> Encoding toJSONList :: [ApiKeyLocation] -> Value toEncodingList :: [ApiKeyLocation] -> Encoding | |
type Rep ApiKeyLocation Source # | |
Defined in Data.Swagger.Internal type Rep ApiKeyLocation = D1 ('MetaData "ApiKeyLocation" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "ApiKeyQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ApiKeyHeader" 'PrefixI 'False) (U1 :: Type -> Type)) |
OAuth2
data OAuth2Params Source #
OAuth2Params | |
|
Instances
Data OAuth2Params Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2Params -> c OAuth2Params gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2Params toConstr :: OAuth2Params -> Constr dataTypeOf :: OAuth2Params -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2Params) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2Params) gmapT :: (forall b. Data b => b -> b) -> OAuth2Params -> OAuth2Params gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Params -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Params -> r gmapQ :: (forall d. Data d => d -> u) -> OAuth2Params -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2Params -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2Params -> m OAuth2Params gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Params -> m OAuth2Params gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Params -> m OAuth2Params | |
Generic OAuth2Params Source # | |
Defined in Data.Swagger.Internal type Rep OAuth2Params :: Type -> Type from :: OAuth2Params -> Rep OAuth2Params x to :: Rep OAuth2Params x -> OAuth2Params | |
Show OAuth2Params Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> OAuth2Params -> ShowS show :: OAuth2Params -> String showList :: [OAuth2Params] -> ShowS | |
Eq OAuth2Params Source # | |
Defined in Data.Swagger.Internal (==) :: OAuth2Params -> OAuth2Params -> Bool (/=) :: OAuth2Params -> OAuth2Params -> Bool | |
Generic OAuth2Params Source # | |
Defined in Data.Swagger.Internal type Code OAuth2Params :: [[Type]] from :: OAuth2Params -> Rep OAuth2Params to :: Rep OAuth2Params -> OAuth2Params | |
HasDatatypeInfo OAuth2Params Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf OAuth2Params :: DatatypeInfo datatypeInfo :: proxy OAuth2Params -> DatatypeInfo (Code OAuth2Params) | |
FromJSON OAuth2Params Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser OAuth2Params parseJSONList :: Value -> Parser [OAuth2Params] | |
ToJSON OAuth2Params Source # | |
Defined in Data.Swagger.Internal toJSON :: OAuth2Params -> Value toEncoding :: OAuth2Params -> Encoding toJSONList :: [OAuth2Params] -> Value toEncodingList :: [OAuth2Params] -> Encoding | |
HasSwaggerAesonOptions OAuth2Params Source # | |
Defined in Data.Swagger.Internal swaggerAesonOptions :: Proxy OAuth2Params -> SwaggerAesonOptions Source # aesonDefaults :: Proxy OAuth2Params -> POP Maybe (Code OAuth2Params) Source # | |
type Rep OAuth2Params Source # | |
Defined in Data.Swagger.Internal type Rep OAuth2Params = D1 ('MetaData "OAuth2Params" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) (C1 ('MetaCons "OAuth2Params" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oauth2Flow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2Flow) :*: S1 ('MetaSel ('Just "_oauth2Scopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Text)))) | |
type Code OAuth2Params Source # | |
Defined in Data.Swagger.Internal | |
type DatatypeInfoOf OAuth2Params Source # | |
Defined in Data.Swagger.Internal type DatatypeInfoOf OAuth2Params = 'ADT "Data.Swagger.Internal" "OAuth2Params" '['Record "OAuth2Params" '['FieldInfo "_oauth2Flow", 'FieldInfo "_oauth2Scopes"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]] |
data OAuth2Flow Source #
OAuth2Implicit AuthorizationURL | |
OAuth2Password TokenURL | |
OAuth2Application TokenURL | |
OAuth2AccessCode AuthorizationURL TokenURL |
Instances
Data OAuth2Flow Source # | |
Defined in Data.Swagger.Internal gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2Flow -> c OAuth2Flow gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth2Flow toConstr :: OAuth2Flow -> Constr dataTypeOf :: OAuth2Flow -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth2Flow) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth2Flow) gmapT :: (forall b. Data b => b -> b) -> OAuth2Flow -> OAuth2Flow gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flow -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flow -> r gmapQ :: (forall d. Data d => d -> u) -> OAuth2Flow -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2Flow -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2Flow -> m OAuth2Flow gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flow -> m OAuth2Flow gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flow -> m OAuth2Flow | |
Generic OAuth2Flow Source # | |
Defined in Data.Swagger.Internal type Rep OAuth2Flow :: Type -> Type from :: OAuth2Flow -> Rep OAuth2Flow x to :: Rep OAuth2Flow x -> OAuth2Flow | |
Show OAuth2Flow Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> OAuth2Flow -> ShowS show :: OAuth2Flow -> String showList :: [OAuth2Flow] -> ShowS | |
Eq OAuth2Flow Source # | |
Defined in Data.Swagger.Internal (==) :: OAuth2Flow -> OAuth2Flow -> Bool (/=) :: OAuth2Flow -> OAuth2Flow -> Bool | |
FromJSON OAuth2Flow Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser OAuth2Flow parseJSONList :: Value -> Parser [OAuth2Flow] | |
ToJSON OAuth2Flow Source # | |
Defined in Data.Swagger.Internal toJSON :: OAuth2Flow -> Value toEncoding :: OAuth2Flow -> Encoding toJSONList :: [OAuth2Flow] -> Value toEncodingList :: [OAuth2Flow] -> Encoding | |
AesonDefaultValue OAuth2Flow Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe OAuth2Flow Source # | |
type Rep OAuth2Flow Source # | |
Defined in Data.Swagger.Internal type Rep OAuth2Flow = D1 ('MetaData "OAuth2Flow" "Data.Swagger.Internal" "swagger2-2.8-inplace" 'False) ((C1 ('MetaCons "OAuth2Implicit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL)) :+: C1 ('MetaCons "OAuth2Password" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL))) :+: (C1 ('MetaCons "OAuth2Application" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)) :+: C1 ('MetaCons "OAuth2AccessCode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)))) |
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.
External documentation
data ExternalDocs Source #
Allows referencing an external resource for extended documentation.
ExternalDocs | |
|
Instances
Data ExternalDocs Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal mappend :: ExternalDocs -> ExternalDocs -> ExternalDocs mconcat :: [ExternalDocs] -> ExternalDocs | |
Semigroup ExternalDocs Source # | |
Defined in Data.Swagger.Internal (<>) :: ExternalDocs -> ExternalDocs -> ExternalDocs sconcat :: NonEmpty ExternalDocs -> ExternalDocs stimes :: Integral b => b -> ExternalDocs -> ExternalDocs | |
Generic ExternalDocs Source # | |
Defined in Data.Swagger.Internal type Rep ExternalDocs :: Type -> Type from :: ExternalDocs -> Rep ExternalDocs x to :: Rep ExternalDocs x -> ExternalDocs | |
Show ExternalDocs Source # | |
Defined in Data.Swagger.Internal showsPrec :: Int -> ExternalDocs -> ShowS show :: ExternalDocs -> String showList :: [ExternalDocs] -> ShowS | |
Eq ExternalDocs Source # | |
Defined in Data.Swagger.Internal (==) :: ExternalDocs -> ExternalDocs -> Bool (/=) :: ExternalDocs -> ExternalDocs -> Bool | |
Ord ExternalDocs Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal hashWithSalt :: Int -> ExternalDocs -> Int hash :: ExternalDocs -> Int | |
FromJSON ExternalDocs Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser ExternalDocs parseJSONList :: Value -> Parser [ExternalDocs] | |
ToJSON ExternalDocs Source # | |
Defined in Data.Swagger.Internal toJSON :: ExternalDocs -> Value toEncoding :: ExternalDocs -> Encoding toJSONList :: [ExternalDocs] -> Value toEncodingList :: [ExternalDocs] -> Encoding | |
SwaggerMonoid ExternalDocs Source # | |
Defined in Data.Swagger.Internal | |
HasUrl ExternalDocs URL Source # | |
Defined in Data.Swagger.Lens url :: Lens' ExternalDocs URL Source # | |
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k ExternalDocs ExternalDocs a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b | |
(k ~ A_Lens, a ~ URL, b ~ URL) => LabelOptic "url" k ExternalDocs ExternalDocs a b | |
Defined in Data.Swagger.Optics labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b | |
HasDescription ExternalDocs (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' ExternalDocs (Maybe Text) Source # | |
HasExternalDocs Operation (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Operation (Maybe ExternalDocs) Source # | |
HasExternalDocs Schema (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Schema (Maybe ExternalDocs) Source # | |
HasExternalDocs Swagger (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source # | |
HasExternalDocs Tag (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Tag (Maybe ExternalDocs) Source # | |
type Rep ExternalDocs Source # | |
Defined in Data.Swagger.Internal type Rep ExternalDocs = D1 ('MetaData "ExternalDocs" "Data.Swagger.Internal" "swagger2-2.8-inplace" '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))) |
References
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.
Reference | |
|
Instances
Data Reference Source # | |
Defined in Data.Swagger.Internal 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 # | |
FromJSON Reference Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser Reference parseJSONList :: Value -> Parser [Reference] | |
ToJSON Reference Source # | |
Defined in Data.Swagger.Internal toEncoding :: Reference -> Encoding toJSONList :: [Reference] -> Value toEncodingList :: [Reference] -> Encoding |
data Referenced a Source #
Instances
Miscellaneous
MimeList | |
|
Instances
Data MimeList Source # | |
Defined in Data.Swagger.Internal 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 # | |
FromJSON MimeList Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser MimeList parseJSONList :: Value -> Parser [MimeList] | |
ToJSON MimeList Source # | |
Defined in Data.Swagger.Internal toEncoding :: MimeList -> Encoding toJSONList :: [MimeList] -> Value toEncodingList :: [MimeList] -> Encoding | |
AesonDefaultValue MimeList Source # | |
Defined in Data.Swagger.Internal defaultValue :: Maybe MimeList Source # | |
SwaggerMonoid MimeList Source # | |
Defined in Data.Swagger.Internal | |
HasConsumes Swagger MimeList Source # | |
HasProduces Swagger MimeList Source # | |
HasConsumes Operation (Maybe MimeList) Source # | |
HasProduces Operation (Maybe MimeList) Source # | |
Instances
Data URL Source # | |
Defined in Data.Swagger.Internal 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.Swagger.Internal hashWithSalt :: Int -> URL -> Int | |
FromJSON URL Source # | |
Defined in Data.Swagger.Internal parseJSON :: Value -> Parser URL parseJSONList :: Value -> Parser [URL] | |
ToJSON URL Source # | |
Defined in Data.Swagger.Internal | |
SwaggerMonoid URL Source # | |
Defined in Data.Swagger.Internal swaggerMempty :: URL Source # | |
HasUrl ExternalDocs URL Source # | |
Defined in Data.Swagger.Lens url :: Lens' ExternalDocs URL Source # | |
HasUrl Contact (Maybe URL) Source # | |
HasUrl License (Maybe URL) Source # | |