Maintainer	Nickolay Kudasov <nickolay@getshoptv.com>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Data.Swagger

Contents

How to use this library
Re-exports
Swagger specification

Description

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

How to use this library

This section explains how to use this library to work with Swagger specification.

`Monoid` instances

Virtually all types representing Swagger specification have Monoid instances. The Monoid type class provides two methods — mempty and mappend.

In this library you can use mempty for a default/empty value. For instance:

>>> encode (mempty :: Swagger)
"{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"}}"

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" }
"{\"version\":\"1.0\",\"title\":\"Todo API\"}"

You can merge two values using mappend or its infix version (<>):

>>> encode $ mempty { _infoTitle = "Todo API" } <> mempty { _infoVersion = "1.0" }
"{\"version\":\"1.0\",\"title\":\"Todo API\"}"

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

Since Swagger has a fairly complex structure, lenses and prisms are used to work comfortably with it. In combination with Monoid instances, lenses make it fairly simple to construct/modify any part of the specification:

>>> :{
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\":{\"version\":\"\",\"title\":\"\"},\"paths\":{\"/user\":{\"get\":{\"produces\":[\"application/json\"],\"responses\":{\"404\":{\"description\":\"User info not found\"},\"200\":{\"schema\":{\"$ref\":\"#/definitions/User\"},\"description\":\"OK\"}}}}},\"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 definitions property of swagger specification. Alternatively it may respond with code 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 description. Many components of a Swagger specification can have descriptions, and you can use the same name for them:

>>> 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\"}"

ParamSchema is basically the base schema specification and many types contain it (see HasParamSchema). So for convenience, all ParamSchema fields are transitively made fields of the type that has it. For example, you can use type_ to access SwaggerType of Header schema without having to use paramSchema:

>>> encode $ (mempty :: Header) & type_ .~ SwaggerNumber
"{\"type\":\"number\"}"

Additionally, to simplify working with Response, both Operation and Responses have direct access to it via at code. Example:

>>> :{
encode $ (mempty :: Operation)
  & at 404 ?~ "Not found"
:}
"{\"responses\":{\"404\":{\"description\":\"Not found\"}}}"

You might've noticed that type_ has an extra underscore in its name compared to, say, description field accessor. This is because type is a keyword in Haskell. A few other field accessors are modified in this way:

in_, type_, default_ (as keywords);
maximum_, minimum_, head_ (as conflicting with Prelude);
enum_ (as conflicting with Control.Lens).

Schema specification

ParamSchema and Schema are the two core types for data model specification.

ParamSchema t specifies all the common properties, available for every data schema. The t parameter imposes some restrictions on type and items properties (see SwaggerType and SwaggerItems).

Schema is used for request and response bodies and allows specifying objects with properties in addition to what ParamSchema provides.

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.

ToParamSchema 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 ToHttpApiData (from http-api-data package).

ToSchema 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 ToJSON (from aeson package).

While lenses and prisms make it easy to define schemas, it might be that you don't need to: ToSchema and ToParamSchema classes both have default Generic-based implementations!

ToSchema default implementation is also aligned with ToJSON default implementation with the only difference being for sum encoding. ToJSON defaults sum encoding to defaultTaggedObject, while ToSchema defaults to something which corresponds to ObjectWithSingleField. This is due to defaultTaggedObject behavior being hard to specify in Swagger.

Here's an example showing ToJSON–ToSchema correspondance:

>>> 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 bad schema

>>> data BadMixedType = ChoiceBool Bool | JustTag deriving Generic
>>> instance ToSchema BadMixedType
>>> instance ToJSON BadMixedType

This is due to the fact that ToJSON encodes empty constructors with an empty list which can not be described in a swagger schema.

Manipulation

Sometimes you have to work with an imported or generated Swagger. For instance, http://hackage.haskell.org/package/servant-swagger generates basic Swagger for a type-level servant API.

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 ToParamSchema and ToSchema provide means to easily obtain schemas for Haskell types, there is no static mechanism to ensure those instances correspond to the ToHttpApiData or ToJSON instances.

Data.Swagger.Schema.Validation addresses ToJSON/ToSchema validation.

Re-exports

module Data.Swagger.Lens

module Data.Swagger.Operation

module Data.Swagger.ParamSchema

module Data.Swagger.Schema

module Data.Swagger.Schema.Validation

Swagger specification

data Swagger Source #

This is the root document object for the API specification.

Constructors

Swagger

Fields

_swaggerInfo :: Info
Provides metadata about the API. The metadata can be used by the clients if needed.
_swaggerHost :: Maybe Host
The host (name or ip) serving the API. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port).
_swaggerBasePath :: Maybe FilePath
The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/).
_swaggerSchemes :: Maybe [Scheme]
The transfer protocol of the API. If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
_swaggerConsumes :: MimeList
A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls.
_swaggerProduces :: MimeList
A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls.
_swaggerPaths :: InsOrdHashMap FilePath PathItem
The available paths and operations for the API. Holds the relative paths to the individual endpoints. The path is appended to the basePath in order to construct the full URL.
_swaggerDefinitions :: Definitions Schema
An object to hold data types produced and consumed by operations.
_swaggerParameters :: Definitions Param
An object to hold parameters that can be used across operations. This property does not define global parameters for all operations.
_swaggerResponses :: Definitions Response
An object to hold responses that can be used across operations. This property does not define global responses for all operations.
_swaggerSecurityDefinitions :: Definitions SecurityScheme
Security scheme definitions that can be used across the specification.
_swaggerSecurity :: [SecurityRequirement]
A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.
_swaggerTags :: Set Tag
A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared may be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
_swaggerExternalDocs :: Maybe ExternalDocs
Additional external documentation.

Instances

Eq Swagger Source #
Methods (==) :: Swagger -> Swagger -> Bool # (/=) :: Swagger -> Swagger -> Bool #
Data Swagger Source #
Methods 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 # toConstr :: Swagger -> Constr # 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 :: (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 #
Show Swagger Source #
Methods showsPrec :: Int -> Swagger -> ShowS # show :: Swagger -> String # showList :: [Swagger] -> ShowS #
Generic Swagger Source #
Associated Types type Rep Swagger :: * -> * # Methods from :: Swagger -> Rep Swagger x # to :: Rep Swagger x -> Swagger #
Monoid Swagger Source #
Methods mempty :: Swagger # mappend :: Swagger -> Swagger -> Swagger # mconcat :: [Swagger] -> Swagger #
ToJSON Swagger Source #
Methods toJSON :: Swagger -> Value # toEncoding :: Swagger -> Encoding # toJSONList :: [Swagger] -> Value # toEncodingList :: [Swagger] -> Encoding #
FromJSON Swagger Source #
Methods parseJSON :: Value -> Parser Swagger # parseJSONList :: Value -> Parser [Swagger] #
Generic Swagger Source #
Associated Types type Code Swagger :: [[*]] # Methods from :: Swagger -> Rep Swagger # to :: Rep Swagger -> Swagger #
HasDatatypeInfo Swagger Source #
Methods datatypeInfo :: proxy Swagger -> DatatypeInfo (Code Swagger) #
HasSwaggerAesonOptions Swagger Source #
Methods swaggerAesonOptions :: proxy Swagger -> SwaggerAesonOptions Source # aesonDefaults :: proxy Swagger -> POP * Maybe (Code Swagger) Source #
HasProduces Swagger MimeList Source #
Methods produces :: Lens' Swagger MimeList Source #
HasInfo Swagger Info Source #
Methods info :: Lens' Swagger Info Source #
HasConsumes Swagger MimeList Source #
Methods consumes :: Lens' Swagger MimeList Source #
HasTags Swagger (Set Tag) Source #
Methods tags :: Lens' Swagger (Set Tag) Source #
HasSecurityDefinitions Swagger (Definitions SecurityScheme) Source #
Methods securityDefinitions :: Lens' Swagger (Definitions SecurityScheme) Source #
HasSecurity Swagger [SecurityRequirement] Source #
Methods security :: Lens' Swagger [SecurityRequirement] Source #
HasSchemes Swagger (Maybe [Scheme]) Source #
Methods schemes :: Lens' Swagger (Maybe [Scheme]) Source #
HasResponses Swagger (Definitions Response) Source #
Methods responses :: Lens' Swagger (Definitions Response) Source #
HasParameters Swagger (Definitions Param) Source #
Methods parameters :: Lens' Swagger (Definitions Param) Source #
HasHost Swagger (Maybe Host) Source #
Methods host :: Lens' Swagger (Maybe Host) Source #
HasExternalDocs Swagger (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source #
HasDefinitions Swagger (Definitions Schema) Source #
Methods definitions :: Lens' Swagger (Definitions Schema) Source #
HasBasePath Swagger (Maybe FilePath) Source #
Methods basePath :: Lens' Swagger (Maybe FilePath) Source #
HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source #
Methods paths :: Lens' Swagger (InsOrdHashMap FilePath PathItem) Source #
type Rep Swagger Source #
type Rep Swagger = D1 (MetaData "Swagger" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Swagger" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_swaggerInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Info)) ((::) (S1 (MetaSel (Just Symbol "_swaggerHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Host))) (S1 (MetaSel (Just Symbol "_swaggerBasePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_swaggerSchemes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Scheme]))) (S1 (MetaSel (Just Symbol "_swaggerConsumes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MimeList))) ((::) (S1 (MetaSel (Just Symbol "_swaggerProduces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MimeList)) (S1 (MetaSel (Just Symbol "_swaggerPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap FilePath PathItem)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_swaggerDefinitions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions Schema))) ((::) (S1 (MetaSel (Just Symbol "_swaggerParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions Param))) (S1 (MetaSel (Just Symbol "_swaggerResponses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions Response))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_swaggerSecurityDefinitions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions SecurityScheme))) (S1 (MetaSel (Just Symbol "_swaggerSecurity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SecurityRequirement]))) ((:*:) (S1 (MetaSel (Just Symbol "_swaggerTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Tag))) (S1 (MetaSel (Just Symbol "_swaggerExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs))))))))
type Code Swagger Source #
type Code Swagger = (:) [] ((:) Info ((:) * (Maybe Host) ((:) * (Maybe FilePath) ((:) * (Maybe [Scheme]) ((:) * MimeList ((:) * MimeList ((:) * (InsOrdHashMap FilePath PathItem) ((:) * (Definitions Schema) ((:) * (Definitions Param) ((:) * (Definitions Response) ((:) * (Definitions SecurityScheme) ((:) * [SecurityRequirement] ((:) * (Set Tag) ((:) * (Maybe ExternalDocs) ([] ))))))))))))))) ([] [])

data Host Source #

The host (name or ip) serving the API. It MAY include a port.

Constructors

Host
Fields _hostName :: HostName Host name. _hostPort :: Maybe PortNumber Optional port.

Instances

Eq Host Source #
Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
Data Host Source #
Methods 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 # toConstr :: Host -> Constr # 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 :: (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 #
Show Host Source #
Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #
IsString Host Source #
Methods fromString :: String -> Host #
Generic Host Source #
Associated Types type Rep Host :: * -> * # Methods from :: Host -> Rep Host x # to :: Rep Host x -> Host #
ToJSON Host Source #
Methods toJSON :: Host -> Value # toEncoding :: Host -> Encoding # toJSONList :: [Host] -> Value # toEncodingList :: [Host] -> Encoding #
FromJSON Host Source #
Methods parseJSON :: Value -> Parser Host # parseJSONList :: Value -> Parser [Host] #
HasName Host HostName Source #
Methods name :: Lens' Host HostName Source #
HasHost Swagger (Maybe Host) Source #
Methods host :: Lens' Swagger (Maybe Host) Source #
HasPort Host (Maybe PortNumber) Source #
Methods port :: Lens' Host (Maybe PortNumber) Source #
type Rep Host Source #
type Rep Host = D1 (MetaData "Host" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Host" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_hostName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HostName)) (S1 (MetaSel (Just Symbol "_hostPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PortNumber)))))

data Scheme Source #

The transfer protocol of the API.

Constructors

Http
Https
Ws
Wss

Instances

Eq Scheme Source #
Methods (==) :: Scheme -> Scheme -> Bool # (/=) :: Scheme -> Scheme -> Bool #
Data Scheme Source #
Methods 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 # toConstr :: Scheme -> Constr # 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 :: (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 #
Show Scheme Source #
Methods showsPrec :: Int -> Scheme -> ShowS # show :: Scheme -> String # showList :: [Scheme] -> ShowS #
Generic Scheme Source #
Associated Types type Rep Scheme :: * -> * # Methods from :: Scheme -> Rep Scheme x # to :: Rep Scheme x -> Scheme #
ToJSON Scheme Source #
Methods toJSON :: Scheme -> Value # toEncoding :: Scheme -> Encoding # toJSONList :: [Scheme] -> Value # toEncodingList :: [Scheme] -> Encoding #
FromJSON Scheme Source #
Methods parseJSON :: Value -> Parser Scheme # parseJSONList :: Value -> Parser [Scheme] #
HasSchemes Operation (Maybe [Scheme]) Source #
Methods schemes :: Lens' Operation (Maybe [Scheme]) Source #
HasSchemes Swagger (Maybe [Scheme]) Source #
Methods schemes :: Lens' Swagger (Maybe [Scheme]) Source #
type Rep Scheme Source #
type Rep Scheme = D1 (MetaData "Scheme" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) ((:+:) ((:+:) (C1 (MetaCons "Http" PrefixI False) U1) (C1 (MetaCons "Https" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Ws" PrefixI False) U1) (C1 (MetaCons "Wss" PrefixI False) U1)))

Info types

data Info Source #

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.

Constructors

Info

Fields

_infoTitle :: Text
The title of the application.
_infoDescription :: Maybe Text
A short description of the application. GFM syntax can be used for rich text representation.
_infoTermsOfService :: Maybe Text
The Terms of Service for the API.
_infoContact :: Maybe Contact
The contact information for the exposed API.
_infoLicense :: Maybe License
The license information for the exposed API.
_infoVersion :: Text
Provides the version of the application API (not to be confused with the specification version).

Instances

Eq Info Source #
Methods (==) :: Info -> Info -> Bool # (/=) :: Info -> Info -> Bool #
Data Info Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Info -> c Info # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Info # toConstr :: Info -> Constr # dataTypeOf :: Info -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Info) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Info) # gmapT :: (forall b. Data b => b -> b) -> Info -> Info # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Info -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Info -> r # gmapQ :: (forall d. Data d => d -> u) -> Info -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Info -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Info -> m Info # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Info -> m Info # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Info -> m Info #
Show Info Source #
Methods showsPrec :: Int -> Info -> ShowS # show :: Info -> String # showList :: [Info] -> ShowS #
Generic Info Source #
Associated Types type Rep Info :: * -> * # Methods from :: Info -> Rep Info x # to :: Rep Info x -> Info #
Monoid Info Source #
Methods mempty :: Info # mappend :: Info -> Info -> Info # mconcat :: [Info] -> Info #
ToJSON Info Source #
Methods toJSON :: Info -> Value # toEncoding :: Info -> Encoding # toJSONList :: [Info] -> Value # toEncodingList :: [Info] -> Encoding #
FromJSON Info Source #
Methods parseJSON :: Value -> Parser Info # parseJSONList :: Value -> Parser [Info] #
SwaggerMonoid Info Source #
Methods swaggerMempty :: Info Source # swaggerMappend :: Info -> Info -> Info Source #
AesonDefaultValue Info Source #
Methods defaultValue :: Maybe Info Source #
HasInfo Swagger Info Source #
Methods info :: Lens' Swagger Info Source #
HasVersion Info Text Source #
Methods version :: Lens' Info Text Source #
HasTitle Info Text Source #
Methods title :: Lens' Info Text Source #
HasTermsOfService Info (Maybe Text) Source #
Methods termsOfService :: Lens' Info (Maybe Text) Source #
HasLicense Info (Maybe License) Source #
Methods license :: Lens' Info (Maybe License) Source #
HasDescription Info (Maybe Text) Source #
Methods description :: Lens' Info (Maybe Text) Source #
HasContact Info (Maybe Contact) Source #
Methods contact :: Lens' Info (Maybe Contact) Source #
type Rep Info Source #
type Rep Info = D1 (MetaData "Info" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Info" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_infoTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) ((::) (S1 (MetaSel (Just Symbol "_infoDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_infoTermsOfService") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) ((::) (S1 (MetaSel (Just Symbol "_infoContact") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Contact))) ((:*:) (S1 (MetaSel (Just Symbol "_infoLicense") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe License))) (S1 (MetaSel (Just Symbol "_infoVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

data Contact Source #

Contact information for the exposed API.

Constructors

Contact
Fields _contactName :: Maybe Text The identifying name of the contact person/organization. _contactUrl :: Maybe URL The URL pointing to the contact information. _contactEmail :: Maybe Text The email address of the contact person/organization.

Instances

Eq Contact Source #
Methods (==) :: Contact -> Contact -> Bool # (/=) :: Contact -> Contact -> Bool #
Data Contact Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Contact -> c Contact # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Contact # toConstr :: Contact -> Constr # dataTypeOf :: Contact -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Contact) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Contact) # gmapT :: (forall b. Data b => b -> b) -> Contact -> Contact # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Contact -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Contact -> r # gmapQ :: (forall d. Data d => d -> u) -> Contact -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Contact -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Contact -> m Contact # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Contact -> m Contact # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Contact -> m Contact #
Show Contact Source #
Methods showsPrec :: Int -> Contact -> ShowS # show :: Contact -> String # showList :: [Contact] -> ShowS #
Generic Contact Source #
Associated Types type Rep Contact :: * -> * # Methods from :: Contact -> Rep Contact x # to :: Rep Contact x -> Contact #
Monoid Contact Source #
Methods mempty :: Contact # mappend :: Contact -> Contact -> Contact # mconcat :: [Contact] -> Contact #
ToJSON Contact Source #
Methods toJSON :: Contact -> Value # toEncoding :: Contact -> Encoding # toJSONList :: [Contact] -> Value # toEncodingList :: [Contact] -> Encoding #
FromJSON Contact Source #
Methods parseJSON :: Value -> Parser Contact # parseJSONList :: Value -> Parser [Contact] #
HasName Contact (Maybe Text) Source #
Methods name :: Lens' Contact (Maybe Text) Source #
HasContact Info (Maybe Contact) Source #
Methods contact :: Lens' Info (Maybe Contact) Source #
HasUrl Contact (Maybe URL) Source #
Methods url :: Lens' Contact (Maybe URL) Source #
HasEmail Contact (Maybe Text) Source #
Methods email :: Lens' Contact (Maybe Text) Source #
type Rep Contact Source #
type Rep Contact = D1 (MetaData "Contact" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Contact" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_contactName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_contactUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URL))) (S1 (MetaSel (Just Symbol "_contactEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))))

data License Source #

License information for the exposed API.

Constructors

License
Fields _licenseName :: Text The license name used for the API. _licenseUrl :: Maybe URL A URL to the license used for the API.

Instances

Eq License Source #
Methods (==) :: License -> License -> Bool # (/=) :: License -> License -> Bool #
Data License Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License # toConstr :: License -> Constr # dataTypeOf :: License -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c License) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) # gmapT :: (forall b. Data b => b -> b) -> License -> License # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r # gmapQ :: (forall d. Data d => d -> u) -> License -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License #
Show License Source #
Methods showsPrec :: Int -> License -> ShowS # show :: License -> String # showList :: [License] -> ShowS #
IsString License Source #
Methods fromString :: String -> License #
Generic License Source #
Associated Types type Rep License :: * -> * # Methods from :: License -> Rep License x # to :: Rep License x -> License #
ToJSON License Source #
Methods toJSON :: License -> Value # toEncoding :: License -> Encoding # toJSONList :: [License] -> Value # toEncodingList :: [License] -> Encoding #
FromJSON License Source #
Methods parseJSON :: Value -> Parser License # parseJSONList :: Value -> Parser [License] #
HasName License Text Source #
Methods name :: Lens' License Text Source #
HasLicense Info (Maybe License) Source #
Methods license :: Lens' Info (Maybe License) Source #
HasUrl License (Maybe URL) Source #
Methods url :: Lens' License (Maybe URL) Source #
type Rep License Source #
type Rep License = D1 (MetaData "License" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "License" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_licenseName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_licenseUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URL)))))

PathItem

data PathItem Source #

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

Constructors

PathItem

Fields

_pathItemGet :: Maybe Operation
A definition of a GET operation on this path.
_pathItemPut :: Maybe Operation
A definition of a PUT operation on this path.
_pathItemPost :: Maybe Operation
A definition of a POST operation on this path.
_pathItemDelete :: Maybe Operation
A definition of a DELETE operation on this path.
_pathItemOptions :: Maybe Operation
A definition of a OPTIONS operation on this path.
_pathItemHead :: Maybe Operation
A definition of a HEAD operation on this path.
_pathItemPatch :: Maybe Operation
A definition of a PATCH operation on this path.
_pathItemParameters :: [Referenced Param]
A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

Instances

Eq PathItem Source #
Methods (==) :: PathItem -> PathItem -> Bool # (/=) :: PathItem -> PathItem -> Bool #
Data PathItem Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PathItem -> c PathItem # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PathItem # toConstr :: PathItem -> Constr # dataTypeOf :: PathItem -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c PathItem) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PathItem) # gmapT :: (forall b. Data b => b -> b) -> PathItem -> PathItem # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PathItem -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PathItem -> r # gmapQ :: (forall d. Data d => d -> u) -> PathItem -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PathItem -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PathItem -> m PathItem # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PathItem -> m PathItem # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PathItem -> m PathItem #
Show PathItem Source #
Methods showsPrec :: Int -> PathItem -> ShowS # show :: PathItem -> String # showList :: [PathItem] -> ShowS #
Generic PathItem Source #
Associated Types type Rep PathItem :: * -> * # Methods from :: PathItem -> Rep PathItem x # to :: Rep PathItem x -> PathItem #
Monoid PathItem Source #
Methods mempty :: PathItem # mappend :: PathItem -> PathItem -> PathItem # mconcat :: [PathItem] -> PathItem #
ToJSON PathItem Source #
Methods toJSON :: PathItem -> Value # toEncoding :: PathItem -> Encoding # toJSONList :: [PathItem] -> Value # toEncodingList :: [PathItem] -> Encoding #
FromJSON PathItem Source #
Methods parseJSON :: Value -> Parser PathItem # parseJSONList :: Value -> Parser [PathItem] #
Generic PathItem Source #
Associated Types type Code PathItem :: [[*]] # Methods from :: PathItem -> Rep PathItem # to :: Rep PathItem -> PathItem #
HasDatatypeInfo PathItem Source #
Methods datatypeInfo :: proxy PathItem -> DatatypeInfo (Code PathItem) #
SwaggerMonoid PathItem Source #
Methods swaggerMempty :: PathItem Source # swaggerMappend :: PathItem -> PathItem -> PathItem Source #
HasSwaggerAesonOptions PathItem Source #
Methods swaggerAesonOptions :: proxy PathItem -> SwaggerAesonOptions Source # aesonDefaults :: proxy PathItem -> POP * Maybe (Code PathItem) Source #
HasParameters PathItem [Referenced Param] Source #
Methods parameters :: Lens' PathItem [Referenced Param] Source #
HasPut PathItem (Maybe Operation) Source #
Methods put :: Lens' PathItem (Maybe Operation) Source #
HasPost PathItem (Maybe Operation) Source #
Methods post :: Lens' PathItem (Maybe Operation) Source #
HasPatch PathItem (Maybe Operation) Source #
Methods patch :: Lens' PathItem (Maybe Operation) Source #
HasOptions PathItem (Maybe Operation) Source #
Methods options :: Lens' PathItem (Maybe Operation) Source #
HasHead PathItem (Maybe Operation) Source #
Methods head_ :: Lens' PathItem (Maybe Operation) Source #
HasGet PathItem (Maybe Operation) Source #
Methods get :: Lens' PathItem (Maybe Operation) Source #
HasDelete PathItem (Maybe Operation) Source #
Methods delete :: Lens' PathItem (Maybe Operation) Source #
HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source #
Methods paths :: Lens' Swagger (InsOrdHashMap FilePath PathItem) Source #
SwaggerMonoid (InsOrdHashMap FilePath PathItem) Source #
Methods swaggerMempty :: InsOrdHashMap FilePath PathItem Source # swaggerMappend :: InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem Source #
type Rep PathItem Source #
type Rep PathItem = D1 (MetaData "PathItem" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "PathItem" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_pathItemGet") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation))) (S1 (MetaSel (Just Symbol "_pathItemPut") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation)))) ((::) (S1 (MetaSel (Just Symbol "_pathItemPost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation))) (S1 (MetaSel (Just Symbol "_pathItemDelete") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_pathItemOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation))) (S1 (MetaSel (Just Symbol "_pathItemHead") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation)))) ((:*:) (S1 (MetaSel (Just Symbol "_pathItemPatch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Operation))) (S1 (MetaSel (Just Symbol "_pathItemParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Referenced Param]))))))
type Code PathItem Source #
type Code PathItem = (:) [] ((:) (Maybe Operation) ((:) * (Maybe Operation) ((:) * (Maybe Operation) ((:) * (Maybe Operation) ((:) * (Maybe Operation) ((:) * (Maybe Operation) ((:) * (Maybe Operation) ((:) * [Referenced Param] ([] ))))))))) ([] [])

Operations

data Operation Source #

Describes a single API operation on a path.

Constructors

Operation

Fields

_operationTags :: Set TagName
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
_operationSummary :: Maybe Text
A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
_operationDescription :: Maybe Text
A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
_operationExternalDocs :: Maybe ExternalDocs
Additional external documentation for this operation.
_operationOperationId :: Maybe Text
Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the it to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
_operationConsumes :: Maybe MimeList
A list of MIME types the operation can consume. This overrides the consumes. Just [] MAY be used to clear the global definition.
_operationProduces :: Maybe MimeList
A list of MIME types the operation can produce. This overrides the produces. Just [] MAY be used to clear the global definition.
_operationParameters :: [Referenced Param]
A list of parameters that are applicable for this operation. If a parameter is already defined at the PathItem, the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.
_operationResponses :: Responses
The list of possible responses as they are returned from executing this operation.
_operationSchemes :: Maybe [Scheme]
The transfer protocol for the operation. The value overrides schemes.
_operationDeprecated :: Maybe Bool
Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is False.
_operationSecurity :: [SecurityRequirement]
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, Just [] can be used.

Instances

Eq Operation Source #
Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #
Data Operation Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Operation -> c Operation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Operation # toConstr :: Operation -> Constr # dataTypeOf :: Operation -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Operation) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Operation) # gmapT :: (forall b. Data b => b -> b) -> Operation -> Operation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r # gmapQ :: (forall d. Data d => d -> u) -> Operation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Operation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Operation -> m Operation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation #
Show Operation Source #
Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
Generic Operation Source #
Associated Types type Rep Operation :: * -> * # Methods from :: Operation -> Rep Operation x # to :: Rep Operation x -> Operation #
Monoid Operation Source #
Methods mempty :: Operation # mappend :: Operation -> Operation -> Operation # mconcat :: [Operation] -> Operation #
ToJSON Operation Source #
Methods toJSON :: Operation -> Value # toEncoding :: Operation -> Encoding # toJSONList :: [Operation] -> Value # toEncodingList :: [Operation] -> Encoding #
FromJSON Operation Source #
Methods parseJSON :: Value -> Parser Operation # parseJSONList :: Value -> Parser [Operation] #
Generic Operation Source #
Associated Types type Code Operation :: [[*]] # Methods from :: Operation -> Rep Operation # to :: Rep Operation -> Operation #
HasDatatypeInfo Operation Source #
Methods datatypeInfo :: proxy Operation -> DatatypeInfo (Code Operation) #
SwaggerMonoid Operation Source #
Methods swaggerMempty :: Operation Source # swaggerMappend :: Operation -> Operation -> Operation Source #
HasSwaggerAesonOptions Operation Source #
Methods swaggerAesonOptions :: proxy Operation -> SwaggerAesonOptions Source # aesonDefaults :: proxy Operation -> POP * Maybe (Code Operation) Source #
HasResponses Operation Responses Source #
Methods responses :: Lens' Operation Responses Source #
HasTags Operation (Set TagName) Source #
Methods tags :: Lens' Operation (Set TagName) Source #
HasSecurity Operation [SecurityRequirement] Source #
Methods security :: Lens' Operation [SecurityRequirement] Source #
HasSchemes Operation (Maybe [Scheme]) Source #
Methods schemes :: Lens' Operation (Maybe [Scheme]) Source #
HasProduces Operation (Maybe MimeList) Source #
Methods produces :: Lens' Operation (Maybe MimeList) Source #
HasParameters Operation [Referenced Param] Source #
Methods parameters :: Lens' Operation [Referenced Param] Source #
HasExternalDocs Operation (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Operation (Maybe ExternalDocs) Source #
HasConsumes Operation (Maybe MimeList) Source #
Methods consumes :: Lens' Operation (Maybe MimeList) Source #
HasDescription Operation (Maybe Text) Source #
Methods description :: Lens' Operation (Maybe Text) Source #
HasPut PathItem (Maybe Operation) Source #
Methods put :: Lens' PathItem (Maybe Operation) Source #
HasPost PathItem (Maybe Operation) Source #
Methods post :: Lens' PathItem (Maybe Operation) Source #
HasPatch PathItem (Maybe Operation) Source #
Methods patch :: Lens' PathItem (Maybe Operation) Source #
HasOptions PathItem (Maybe Operation) Source #
Methods options :: Lens' PathItem (Maybe Operation) Source #
HasHead PathItem (Maybe Operation) Source #
Methods head_ :: Lens' PathItem (Maybe Operation) Source #
HasGet PathItem (Maybe Operation) Source #
Methods get :: Lens' PathItem (Maybe Operation) Source #
HasDelete PathItem (Maybe Operation) Source #
Methods delete :: Lens' PathItem (Maybe Operation) Source #
HasSummary Operation (Maybe Text) Source #
Methods summary :: Lens' Operation (Maybe Text) Source #
HasOperationId Operation (Maybe Text) Source #
Methods operationId :: Lens' Operation (Maybe Text) Source #
HasDeprecated Operation (Maybe Bool) Source #
Methods deprecated :: Lens' Operation (Maybe Bool) Source #
type Rep Operation Source #
type Rep Operation = D1 (MetaData "Operation" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Operation" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_operationTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set TagName))) ((::) (S1 (MetaSel (Just Symbol "_operationSummary") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_operationDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) ((::) (S1 (MetaSel (Just Symbol "_operationExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs))) ((::) (S1 (MetaSel (Just Symbol "_operationOperationId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_operationConsumes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MimeList)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_operationProduces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MimeList))) ((::) (S1 (MetaSel (Just Symbol "_operationParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Referenced Param])) (S1 (MetaSel (Just Symbol "_operationResponses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Responses)))) ((::) (S1 (MetaSel (Just Symbol "_operationSchemes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Scheme]))) ((:*:) (S1 (MetaSel (Just Symbol "_operationDeprecated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_operationSecurity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SecurityRequirement])))))))
type Code Operation Source #
type Code Operation = (:) [] ((:) (Set TagName) ((:) * (Maybe Text) ((:) * (Maybe Text) ((:) * (Maybe ExternalDocs) ((:) * (Maybe Text) ((:) * (Maybe MimeList) ((:) * (Maybe MimeList) ((:) * [Referenced Param] ((:) * Responses ((:) * (Maybe [Scheme]) ((:) * (Maybe Bool) ((:) * [SecurityRequirement] ([] ))))))))))))) ([] [])
type Index Operation #
type Index Operation = HttpStatusCode
type IxValue Operation #
type IxValue Operation = Referenced Response

data Tag Source #

Allows adding meta data to a single tag that is used by Operation. It is not mandatory to have a Tag per tag used there.

Constructors

Tag
Fields _tagName :: TagName The name of the tag. _tagDescription :: Maybe Text A short description for the tag. GFM syntax can be used for rich text representation. _tagExternalDocs :: Maybe ExternalDocs Additional external documentation for this tag.

Instances

Eq Tag Source #
Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Data Tag Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # toConstr :: Tag -> Constr # 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 :: (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 #
Ord Tag Source #
Methods compare :: Tag -> Tag -> Ordering # (<) :: Tag -> Tag -> Bool # (<=) :: Tag -> Tag -> Bool # (>) :: Tag -> Tag -> Bool # (>=) :: Tag -> Tag -> Bool # max :: Tag -> Tag -> Tag # min :: Tag -> Tag -> Tag #
Show Tag Source #
Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
IsString Tag Source #
Methods fromString :: String -> Tag #
Generic Tag Source #
Associated Types type Rep Tag :: * -> * # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
ToJSON Tag Source #
Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #
HasName Tag TagName Source #
Methods name :: Lens' Tag TagName Source #
HasTags Swagger (Set Tag) Source #
Methods tags :: Lens' Swagger (Set Tag) Source #
HasExternalDocs Tag (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Tag (Maybe ExternalDocs) Source #
HasDescription Tag (Maybe Text) Source #
Methods description :: Lens' Tag (Maybe Text) Source #
type Rep Tag Source #
type Rep Tag = D1 (MetaData "Tag" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Tag" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_tagName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TagName)) ((::) (S1 (MetaSel (Just Symbol "_tagDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tagExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs))))))

type TagName = Text Source #

Tag name.

Types and formats

data SwaggerType t where Source #

Constructors

SwaggerString :: SwaggerType t
SwaggerNumber :: SwaggerType t
SwaggerInteger :: SwaggerType t
SwaggerBoolean :: SwaggerType t
SwaggerArray :: SwaggerType t
SwaggerFile :: SwaggerType SwaggerKindParamOtherSchema
SwaggerNull :: SwaggerType SwaggerKindSchema
SwaggerObject :: SwaggerType SwaggerKindSchema

Instances

HasType Header (SwaggerType (SwaggerKindNormal * Header)) Source #
Methods type_ :: Lens' Header (SwaggerType (SwaggerKindNormal * Header)) Source #
HasType NamedSchema (SwaggerType (SwaggerKindSchema *)) Source #
Methods type_ :: Lens' NamedSchema (SwaggerType (SwaggerKindSchema *)) Source #
HasType Schema (SwaggerType (SwaggerKindSchema *)) Source #
Methods type_ :: Lens' Schema (SwaggerType (SwaggerKindSchema *)) Source #
HasType ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema *)) Source #
Methods type_ :: Lens' ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema *)) Source #
Eq (SwaggerType t) Source #
Methods (==) :: SwaggerType t -> SwaggerType t -> Bool # (/=) :: SwaggerType t -> SwaggerType t -> Bool #
Typeable * t => Data (SwaggerType (SwaggerKindNormal * t)) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwaggerType (SwaggerKindNormal * t) -> c (SwaggerType (SwaggerKindNormal * t)) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SwaggerType (SwaggerKindNormal * t)) # toConstr :: SwaggerType (SwaggerKindNormal * t) -> Constr # dataTypeOf :: SwaggerType (SwaggerKindNormal * t) -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (SwaggerType (SwaggerKindNormal t))) # dataCast2 :: Typeable (* -> * -> ) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SwaggerType (SwaggerKindNormal t))) # gmapT :: (forall b. Data b => b -> b) -> SwaggerType (SwaggerKindNormal * t) -> SwaggerType (SwaggerKindNormal * t) # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerType (SwaggerKindNormal * t) -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerType (SwaggerKindNormal * t) -> r # gmapQ :: (forall d. Data d => d -> u) -> SwaggerType (SwaggerKindNormal * t) -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerType (SwaggerKindNormal * t) -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindNormal * t) -> m (SwaggerType (SwaggerKindNormal * t)) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindNormal * t) -> m (SwaggerType (SwaggerKindNormal * t)) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindNormal * t) -> m (SwaggerType (SwaggerKindNormal * t)) #
Data (SwaggerType (SwaggerKindParamOtherSchema *)) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwaggerType (SwaggerKindParamOtherSchema ) -> c (SwaggerType (SwaggerKindParamOtherSchema )) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SwaggerType (SwaggerKindParamOtherSchema )) # toConstr :: SwaggerType (SwaggerKindParamOtherSchema ) -> Constr # dataTypeOf :: SwaggerType (SwaggerKindParamOtherSchema ) -> DataType # dataCast1 :: Typeable ( -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (SwaggerType (SwaggerKindParamOtherSchema ))) # dataCast2 :: Typeable (* -> * -> ) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SwaggerType (SwaggerKindParamOtherSchema ))) # gmapT :: (forall b. Data b => b -> b) -> SwaggerType (SwaggerKindParamOtherSchema ) -> SwaggerType (SwaggerKindParamOtherSchema ) # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerType (SwaggerKindParamOtherSchema ) -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerType (SwaggerKindParamOtherSchema ) -> r # gmapQ :: (forall d. Data d => d -> u) -> SwaggerType (SwaggerKindParamOtherSchema ) -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerType (SwaggerKindParamOtherSchema ) -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindParamOtherSchema ) -> m (SwaggerType (SwaggerKindParamOtherSchema )) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindParamOtherSchema ) -> m (SwaggerType (SwaggerKindParamOtherSchema )) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindParamOtherSchema ) -> m (SwaggerType (SwaggerKindParamOtherSchema )) #
Data (SwaggerType (SwaggerKindSchema *)) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SwaggerType (SwaggerKindSchema ) -> c (SwaggerType (SwaggerKindSchema )) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SwaggerType (SwaggerKindSchema )) # toConstr :: SwaggerType (SwaggerKindSchema ) -> Constr # dataTypeOf :: SwaggerType (SwaggerKindSchema ) -> DataType # dataCast1 :: Typeable ( -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (SwaggerType (SwaggerKindSchema ))) # dataCast2 :: Typeable (* -> * -> ) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SwaggerType (SwaggerKindSchema ))) # gmapT :: (forall b. Data b => b -> b) -> SwaggerType (SwaggerKindSchema ) -> SwaggerType (SwaggerKindSchema ) # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerType (SwaggerKindSchema ) -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerType (SwaggerKindSchema ) -> r # gmapQ :: (forall d. Data d => d -> u) -> SwaggerType (SwaggerKindSchema ) -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerType (SwaggerKindSchema ) -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindSchema ) -> m (SwaggerType (SwaggerKindSchema )) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindSchema ) -> m (SwaggerType (SwaggerKindSchema )) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerType (SwaggerKindSchema ) -> m (SwaggerType (SwaggerKindSchema )) #
Show (SwaggerType t) Source #
Methods showsPrec :: Int -> SwaggerType t -> ShowS # show :: SwaggerType t -> String # showList :: [SwaggerType t] -> ShowS #
ToJSON (SwaggerType t) Source #
Methods toJSON :: SwaggerType t -> Value # toEncoding :: SwaggerType t -> Encoding # toJSONList :: [SwaggerType t] -> Value # toEncodingList :: [SwaggerType t] -> Encoding #
FromJSON (SwaggerType (SwaggerKindNormal * t)) Source #
Methods parseJSON :: Value -> Parser (SwaggerType (SwaggerKindNormal * t)) # parseJSONList :: Value -> Parser [SwaggerType (SwaggerKindNormal * t)] #
FromJSON (SwaggerType (SwaggerKindParamOtherSchema *)) Source #
Methods parseJSON :: Value -> Parser (SwaggerType (SwaggerKindParamOtherSchema )) # parseJSONList :: Value -> Parser [SwaggerType (SwaggerKindParamOtherSchema )] #
FromJSON (SwaggerType (SwaggerKindSchema *)) Source #
Methods parseJSON :: Value -> Parser (SwaggerType (SwaggerKindSchema )) # parseJSONList :: Value -> Parser [SwaggerType (SwaggerKindSchema )] #
SwaggerMonoid (SwaggerType t) Source #
Methods swaggerMempty :: SwaggerType t Source # swaggerMappend :: SwaggerType t -> SwaggerType t -> SwaggerType t Source #
AesonDefaultValue (SwaggerType a) Source #
Methods defaultValue :: Maybe (SwaggerType a) Source #
HasType (ParamSchema t0) (SwaggerType t0) Source #
Methods type_ :: Lens' (ParamSchema t0) (SwaggerType t0) Source #

type Format = Text Source #

type Definitions = InsOrdHashMap Text Source #

A list of definitions that can be used in references.

data CollectionFormat t where Source #

Determines the format of the array.

Constructors

CollectionCSV :: CollectionFormat t
CollectionSSV :: CollectionFormat t
CollectionTSV :: CollectionFormat t
CollectionPipes :: CollectionFormat t
CollectionMulti :: CollectionFormat SwaggerKindParamOtherSchema

Instances

Eq (CollectionFormat t) Source #
Methods (==) :: CollectionFormat t -> CollectionFormat t -> Bool # (/=) :: CollectionFormat t -> CollectionFormat t -> Bool #
Data t => Data (CollectionFormat (SwaggerKindNormal * t)) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CollectionFormat (SwaggerKindNormal * t) -> c (CollectionFormat (SwaggerKindNormal * t)) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (CollectionFormat (SwaggerKindNormal * t)) # toConstr :: CollectionFormat (SwaggerKindNormal * t) -> Constr # dataTypeOf :: CollectionFormat (SwaggerKindNormal * t) -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (CollectionFormat (SwaggerKindNormal t))) # dataCast2 :: Typeable (* -> * -> ) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (CollectionFormat (SwaggerKindNormal t))) # gmapT :: (forall b. Data b => b -> b) -> CollectionFormat (SwaggerKindNormal * t) -> CollectionFormat (SwaggerKindNormal * t) # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CollectionFormat (SwaggerKindNormal * t) -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CollectionFormat (SwaggerKindNormal * t) -> r # gmapQ :: (forall d. Data d => d -> u) -> CollectionFormat (SwaggerKindNormal * t) -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CollectionFormat (SwaggerKindNormal * t) -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CollectionFormat (SwaggerKindNormal * t) -> m (CollectionFormat (SwaggerKindNormal * t)) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CollectionFormat (SwaggerKindNormal * t) -> m (CollectionFormat (SwaggerKindNormal * t)) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CollectionFormat (SwaggerKindNormal * t) -> m (CollectionFormat (SwaggerKindNormal * t)) #
Data (CollectionFormat (SwaggerKindParamOtherSchema *)) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> c (CollectionFormat (SwaggerKindParamOtherSchema )) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (CollectionFormat (SwaggerKindParamOtherSchema )) # toConstr :: CollectionFormat (SwaggerKindParamOtherSchema ) -> Constr # dataTypeOf :: CollectionFormat (SwaggerKindParamOtherSchema ) -> DataType # dataCast1 :: Typeable ( -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (CollectionFormat (SwaggerKindParamOtherSchema ))) # dataCast2 :: Typeable (* -> * -> ) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (CollectionFormat (SwaggerKindParamOtherSchema ))) # gmapT :: (forall b. Data b => b -> b) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> CollectionFormat (SwaggerKindParamOtherSchema ) # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CollectionFormat (SwaggerKindParamOtherSchema ) -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CollectionFormat (SwaggerKindParamOtherSchema ) -> r # gmapQ :: (forall d. Data d => d -> u) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> m (CollectionFormat (SwaggerKindParamOtherSchema )) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> m (CollectionFormat (SwaggerKindParamOtherSchema )) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CollectionFormat (SwaggerKindParamOtherSchema ) -> m (CollectionFormat (SwaggerKindParamOtherSchema )) #
Show (CollectionFormat t) Source #
Methods showsPrec :: Int -> CollectionFormat t -> ShowS # show :: CollectionFormat t -> String # showList :: [CollectionFormat t] -> ShowS #
ToJSON (CollectionFormat t) Source #
Methods toJSON :: CollectionFormat t -> Value # toEncoding :: CollectionFormat t -> Encoding # toJSONList :: [CollectionFormat t] -> Value # toEncodingList :: [CollectionFormat t] -> Encoding #
FromJSON (CollectionFormat (SwaggerKindNormal * t)) Source #
Methods parseJSON :: Value -> Parser (CollectionFormat (SwaggerKindNormal * t)) # parseJSONList :: Value -> Parser [CollectionFormat (SwaggerKindNormal * t)] #
FromJSON (CollectionFormat (SwaggerKindParamOtherSchema *)) Source #
Methods parseJSON :: Value -> Parser (CollectionFormat (SwaggerKindParamOtherSchema )) # parseJSONList :: Value -> Parser [CollectionFormat (SwaggerKindParamOtherSchema )] #

Parameters

data Param Source #

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

Constructors

Param

Fields

_paramName :: Text
The name of the parameter. Parameter names are case sensitive.
_paramDescription :: Maybe Text
A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.
_paramRequired :: Maybe Bool
Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is False.
_paramSchema :: ParamAnySchema
Parameter schema.

Instances

Eq Param Source #
Methods (==) :: Param -> Param -> Bool # (/=) :: Param -> Param -> Bool #
Data Param Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Param -> c Param # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Param # toConstr :: Param -> Constr # dataTypeOf :: Param -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Param) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Param) # gmapT :: (forall b. Data b => b -> b) -> Param -> Param # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Param -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Param -> r # gmapQ :: (forall d. Data d => d -> u) -> Param -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Param -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Param -> m Param # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Param -> m Param # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Param -> m Param #
Show Param Source #
Methods showsPrec :: Int -> Param -> ShowS # show :: Param -> String # showList :: [Param] -> ShowS #
Generic Param Source #
Associated Types type Rep Param :: * -> * # Methods from :: Param -> Rep Param x # to :: Rep Param x -> Param #
Monoid Param Source #
Methods mempty :: Param # mappend :: Param -> Param -> Param # mconcat :: [Param] -> Param #
ToJSON Param Source #
Methods toJSON :: Param -> Value # toEncoding :: Param -> Encoding # toJSONList :: [Param] -> Value # toEncodingList :: [Param] -> Encoding #
FromJSON Param Source #
Methods parseJSON :: Value -> Parser Param # parseJSONList :: Value -> Parser [Param] #
Generic Param Source #
Associated Types type Code Param :: [[*]] # Methods from :: Param -> Rep Param # to :: Rep Param -> Param #
HasDatatypeInfo Param Source #
Methods datatypeInfo :: proxy Param -> DatatypeInfo (Code Param) #
SwaggerMonoid Param Source #
Methods swaggerMempty :: Param Source # swaggerMappend :: Param -> Param -> Param Source #
HasSwaggerAesonOptions Param Source #
Methods swaggerAesonOptions :: proxy Param -> SwaggerAesonOptions Source # aesonDefaults :: proxy Param -> POP * Maybe (Code Param) Source #
HasName Param Text Source #
Methods name :: Lens' Param Text Source #
HasSchema Param ParamAnySchema Source #
Methods schema :: Lens' Param ParamAnySchema Source #
HasParameters Operation [Referenced Param] Source #
Methods parameters :: Lens' Operation [Referenced Param] Source #
HasParameters PathItem [Referenced Param] Source #
Methods parameters :: Lens' PathItem [Referenced Param] Source #
HasParameters Swagger (Definitions Param) Source #
Methods parameters :: Lens' Swagger (Definitions Param) Source #
HasDescription Param (Maybe Text) Source #
Methods description :: Lens' Param (Maybe Text) Source #
HasRequired Param (Maybe Bool) Source #
Methods required :: Lens' Param (Maybe Bool) Source #
ToJSON (Referenced Param) Source #
Methods toJSON :: Referenced Param -> Value # toEncoding :: Referenced Param -> Encoding # toJSONList :: [Referenced Param] -> Value # toEncodingList :: [Referenced Param] -> Encoding #
FromJSON (Referenced Param) Source #
Methods parseJSON :: Value -> Parser (Referenced Param) # parseJSONList :: Value -> Parser [Referenced Param] #
type Rep Param Source #
type Rep Param = D1 (MetaData "Param" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Param" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_paramName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_paramDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_paramRequired") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_paramSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamAnySchema)))))
type Code Param Source #
type Code Param = (:) [] ((:) Text ((:) * (Maybe Text) ((:) * (Maybe Bool) ((:) * ParamAnySchema ([] ))))) ([] [])

data ParamAnySchema Source #

Constructors

ParamBody (Referenced Schema)
ParamOther ParamOtherSchema

Instances

Eq ParamAnySchema Source #
Methods (==) :: ParamAnySchema -> ParamAnySchema -> Bool # (/=) :: ParamAnySchema -> ParamAnySchema -> Bool #
Data ParamAnySchema Source #
Methods 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 :: (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 #
Show ParamAnySchema Source #
Methods showsPrec :: Int -> ParamAnySchema -> ShowS # show :: ParamAnySchema -> String # showList :: [ParamAnySchema] -> ShowS #
Generic ParamAnySchema Source #
Associated Types type Rep ParamAnySchema :: * -> * # Methods from :: ParamAnySchema -> Rep ParamAnySchema x # to :: Rep ParamAnySchema x -> ParamAnySchema #
ToJSON ParamAnySchema Source #
Methods toJSON :: ParamAnySchema -> Value # toEncoding :: ParamAnySchema -> Encoding # toJSONList :: [ParamAnySchema] -> Value # toEncodingList :: [ParamAnySchema] -> Encoding #
FromJSON ParamAnySchema Source #
Methods parseJSON :: Value -> Parser ParamAnySchema # parseJSONList :: Value -> Parser [ParamAnySchema] #
SwaggerMonoid ParamAnySchema Source #
Methods swaggerMempty :: ParamAnySchema Source # swaggerMappend :: ParamAnySchema -> ParamAnySchema -> ParamAnySchema Source #
AesonDefaultValue ParamAnySchema Source #
Methods defaultValue :: Maybe ParamAnySchema Source #
HasSchema Param ParamAnySchema Source #
Methods schema :: Lens' Param ParamAnySchema Source #
type Rep ParamAnySchema Source #
type Rep ParamAnySchema = D1 (MetaData "ParamAnySchema" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) ((:+:) (C1 (MetaCons "ParamBody" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Referenced Schema)))) (C1 (MetaCons "ParamOther" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamOtherSchema))))

data ParamOtherSchema Source #

Constructors

ParamOtherSchema

Fields

_paramOtherSchemaIn :: ParamLocation
The location of the parameter.
_paramOtherSchemaAllowEmptyValue :: Maybe Bool
Sets the ability to pass empty-valued parameters. This is valid only for either ParamQuery or ParamFormData and allows you to send a parameter with a name only or an empty value. Default value is False.
_paramOtherSchemaParamSchema :: ParamSchema SwaggerKindParamOtherSchema

Instances

Eq ParamOtherSchema Source #
Methods (==) :: ParamOtherSchema -> ParamOtherSchema -> Bool # (/=) :: ParamOtherSchema -> ParamOtherSchema -> Bool #
Data ParamOtherSchema Source #
Methods 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 :: (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 #
Show ParamOtherSchema Source #
Methods showsPrec :: Int -> ParamOtherSchema -> ShowS # show :: ParamOtherSchema -> String # showList :: [ParamOtherSchema] -> ShowS #
Generic ParamOtherSchema Source #
Associated Types type Rep ParamOtherSchema :: * -> * # Methods from :: ParamOtherSchema -> Rep ParamOtherSchema x # to :: Rep ParamOtherSchema x -> ParamOtherSchema #
Monoid ParamOtherSchema Source #
Methods mempty :: ParamOtherSchema # mappend :: ParamOtherSchema -> ParamOtherSchema -> ParamOtherSchema # mconcat :: [ParamOtherSchema] -> ParamOtherSchema #
ToJSON ParamOtherSchema Source #
Methods toJSON :: ParamOtherSchema -> Value # toEncoding :: ParamOtherSchema -> Encoding # toJSONList :: [ParamOtherSchema] -> Value # toEncodingList :: [ParamOtherSchema] -> Encoding #
FromJSON ParamOtherSchema Source #
Methods parseJSON :: Value -> Parser ParamOtherSchema # parseJSONList :: Value -> Parser [ParamOtherSchema] #
Generic ParamOtherSchema Source #
Associated Types type Code ParamOtherSchema :: [[*]] # Methods from :: ParamOtherSchema -> Rep ParamOtherSchema # to :: Rep ParamOtherSchema -> ParamOtherSchema #
HasDatatypeInfo ParamOtherSchema Source #
Methods datatypeInfo :: proxy ParamOtherSchema -> DatatypeInfo (Code ParamOtherSchema) #
SwaggerMonoid ParamOtherSchema Source #
Methods swaggerMempty :: ParamOtherSchema Source # swaggerMappend :: ParamOtherSchema -> ParamOtherSchema -> ParamOtherSchema Source #
HasSwaggerAesonOptions ParamOtherSchema Source #
Methods swaggerAesonOptions :: proxy ParamOtherSchema -> SwaggerAesonOptions Source # aesonDefaults :: proxy ParamOtherSchema -> POP * Maybe (Code ParamOtherSchema) Source #
HasIn ParamOtherSchema ParamLocation Source #
Methods in_ :: Lens' ParamOtherSchema ParamLocation Source #
HasParamSchema ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema Type)) Source #
Methods paramSchema :: Lens' ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema Type)) Source #
HasAllowEmptyValue ParamOtherSchema (Maybe Bool) Source #
Methods allowEmptyValue :: Lens' ParamOtherSchema (Maybe Bool) Source #
HasType ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema *)) Source #
Methods type_ :: Lens' ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema *)) Source #
HasDefault ParamOtherSchema (Maybe Value) Source #
Methods default_ :: Lens' ParamOtherSchema (Maybe Value) Source #
type Rep ParamOtherSchema Source #
type Rep ParamOtherSchema = D1 (MetaData "ParamOtherSchema" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "ParamOtherSchema" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_paramOtherSchemaIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamLocation)) ((::) (S1 (MetaSel (Just Symbol "_paramOtherSchemaAllowEmptyValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_paramOtherSchemaParamSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParamSchema (SwaggerKindParamOtherSchema *)))))))
type Code ParamOtherSchema Source #
type Code ParamOtherSchema = (:) [] ((:) ParamLocation ((:) * (Maybe Bool) ((:) * (ParamSchema (SwaggerKindParamOtherSchema Type)) ([] )))) ([] [])

data ParamLocation Source #

Constructors

ParamQuery	Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`.
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 `items{itemId}`, the path parameter is `itemId`.
ParamFormData	Used to describe the payload of an HTTP request when either `application/x-www-form-urlencoded` or `multipart/form-data` are used as the content type of the request (in Swagger's definition, the `consumes` property of an operation). This is the only parameter type that can be used to send files, thus supporting the `ParamFile` type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form parameters have a different format based on the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4).

Instances

Eq ParamLocation Source #
Methods (==) :: ParamLocation -> ParamLocation -> Bool # (/=) :: ParamLocation -> ParamLocation -> Bool #
Data ParamLocation Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParamLocation -> c ParamLocation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParamLocation # toConstr :: ParamLocation -> Constr # dataTypeOf :: ParamLocation -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ParamLocation) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParamLocation) # gmapT :: (forall b. Data b => b -> b) -> ParamLocation -> ParamLocation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParamLocation -> r # gmapQr :: (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 #
Show ParamLocation Source #
Methods showsPrec :: Int -> ParamLocation -> ShowS # show :: ParamLocation -> String # showList :: [ParamLocation] -> ShowS #
Generic ParamLocation Source #
Associated Types type Rep ParamLocation :: * -> * # Methods from :: ParamLocation -> Rep ParamLocation x # to :: Rep ParamLocation x -> ParamLocation #
ToJSON ParamLocation Source #
Methods toJSON :: ParamLocation -> Value # toEncoding :: ParamLocation -> Encoding # toJSONList :: [ParamLocation] -> Value # toEncodingList :: [ParamLocation] -> Encoding #
FromJSON ParamLocation Source #
Methods parseJSON :: Value -> Parser ParamLocation # parseJSONList :: Value -> Parser [ParamLocation] #
SwaggerMonoid ParamLocation Source #
Methods swaggerMempty :: ParamLocation Source # swaggerMappend :: ParamLocation -> ParamLocation -> ParamLocation Source #
AesonDefaultValue ParamLocation Source #
Methods defaultValue :: Maybe ParamLocation Source #
HasIn ParamOtherSchema ParamLocation Source #
Methods in_ :: Lens' ParamOtherSchema ParamLocation Source #
type Rep ParamLocation Source #
type Rep ParamLocation = D1 (MetaData "ParamLocation" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) ((:+:) ((:+:) (C1 (MetaCons "ParamQuery" PrefixI False) U1) (C1 (MetaCons "ParamHeader" PrefixI False) U1)) ((:+:) (C1 (MetaCons "ParamPath" PrefixI False) U1) (C1 (MetaCons "ParamFormData" PrefixI False) U1)))

type ParamName = Text Source #

data Header Source #

Constructors

Header
Fields _headerDescription :: Maybe Text A short description of the header. _headerParamSchema :: ParamSchema (SwaggerKindNormal Header)

type HeaderName = Text Source #

data Example Source #

Constructors

Example
Fields getExample :: Map MediaType Value

Instances

Eq Example Source #
Methods (==) :: Example -> Example -> Bool # (/=) :: Example -> Example -> Bool #
Data Example Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Example -> c Example # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Example # toConstr :: Example -> Constr # dataTypeOf :: Example -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Example) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Example) # gmapT :: (forall b. Data b => b -> b) -> Example -> Example # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Example -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Example -> r # gmapQ :: (forall d. Data d => d -> u) -> Example -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Example -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Example -> m Example # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Example -> m Example # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Example -> m Example #
Show Example Source #
Methods showsPrec :: Int -> Example -> ShowS # show :: Example -> String # showList :: [Example] -> ShowS #
Generic Example Source #
Associated Types type Rep Example :: * -> * # Methods from :: Example -> Rep Example x # to :: Rep Example x -> Example #
Monoid Example Source #
Methods mempty :: Example # mappend :: Example -> Example -> Example # mconcat :: [Example] -> Example #
ToJSON Example Source #
Methods toJSON :: Example -> Value # toEncoding :: Example -> Encoding # toJSONList :: [Example] -> Value # toEncodingList :: [Example] -> Encoding #
FromJSON Example Source #
Methods parseJSON :: Value -> Parser Example # parseJSONList :: Value -> Parser [Example] #
HasExamples Response (Maybe Example) Source #
Methods examples :: Lens' Response (Maybe Example) Source #
type Rep Example Source #
type Rep Example = D1 (MetaData "Example" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Example" PrefixI True) (S1 (MetaSel (Just Symbol "getExample") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map MediaType Value))))

Schemas

data ParamSchema t Source #

Constructors

ParamSchema

Fields

_paramSchemaDefault :: Maybe Value
Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) Unlike JSON Schema this value MUST conform to the defined type for this parameter.
_paramSchemaType :: 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

Instances

HasParamSchema Header (ParamSchema (SwaggerKindNormal * Header)) Source #
Methods paramSchema :: Lens' Header (ParamSchema (SwaggerKindNormal * Header)) Source #
HasParamSchema NamedSchema (ParamSchema (SwaggerKindSchema *)) Source #
Methods paramSchema :: Lens' NamedSchema (ParamSchema (SwaggerKindSchema *)) Source #
HasParamSchema Schema (ParamSchema (SwaggerKindSchema Type)) Source #
Methods paramSchema :: Lens' Schema (ParamSchema (SwaggerKindSchema Type)) Source #
HasParamSchema ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema Type)) Source #
Methods paramSchema :: Lens' ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema Type)) Source #
Eq (ParamSchema t) Source #
Methods (==) :: ParamSchema t -> ParamSchema t -> Bool # (/=) :: ParamSchema t -> ParamSchema t -> Bool #
(Typeable (SwaggerKind *) k, Data (SwaggerType k), Data (SwaggerItems k)) => Data (ParamSchema k) Source #
Methods 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 :: (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) #
Show (ParamSchema t) Source #
Methods showsPrec :: Int -> ParamSchema t -> ShowS # show :: ParamSchema t -> String # showList :: [ParamSchema t] -> ShowS #
Generic (ParamSchema t) Source #
Associated Types type Rep (ParamSchema t) :: * -> * # Methods from :: ParamSchema t -> Rep (ParamSchema t) x # to :: Rep (ParamSchema t) x -> ParamSchema t #
Monoid (ParamSchema t) Source #
Methods mempty :: ParamSchema t # mappend :: ParamSchema t -> ParamSchema t -> ParamSchema t # mconcat :: [ParamSchema t] -> ParamSchema t #
ToJSON (ParamSchema k) Source #
Methods toJSON :: ParamSchema k -> Value # toEncoding :: ParamSchema k -> Encoding # toJSONList :: [ParamSchema k] -> Value # toEncodingList :: [ParamSchema k] -> Encoding #
(FromJSON (SwaggerType (SwaggerKindNormal * t)), FromJSON (SwaggerItems (SwaggerKindNormal * t))) => FromJSON (ParamSchema (SwaggerKindNormal * t)) Source #
Methods parseJSON :: Value -> Parser (ParamSchema (SwaggerKindNormal * t)) # parseJSONList :: Value -> Parser [ParamSchema (SwaggerKindNormal * t)] #
FromJSON (ParamSchema (SwaggerKindParamOtherSchema *)) Source #
Methods parseJSON :: Value -> Parser (ParamSchema (SwaggerKindParamOtherSchema )) # parseJSONList :: Value -> Parser [ParamSchema (SwaggerKindParamOtherSchema )] #
FromJSON (ParamSchema (SwaggerKindSchema *)) Source #
Methods parseJSON :: Value -> Parser (ParamSchema (SwaggerKindSchema )) # parseJSONList :: Value -> Parser [ParamSchema (SwaggerKindSchema )] #
Generic (ParamSchema t0) Source #
Associated Types type Code (ParamSchema t0) :: [[*]] # Methods from :: ParamSchema t0 -> Rep (ParamSchema t0) # to :: Rep (ParamSchema t0) -> ParamSchema t0 #
HasDatatypeInfo (ParamSchema t0) Source #
Methods datatypeInfo :: proxy (ParamSchema t0) -> DatatypeInfo (Code (ParamSchema t0)) #
SwaggerMonoid (ParamSchema t) Source #
Methods swaggerMempty :: ParamSchema t Source # swaggerMappend :: ParamSchema t -> ParamSchema t -> ParamSchema t Source #
AesonDefaultValue (ParamSchema s) Source #
Methods defaultValue :: Maybe (ParamSchema s) Source #
HasSwaggerAesonOptions (ParamSchema (SwaggerKindNormal * t)) Source #
Methods swaggerAesonOptions :: proxy (ParamSchema (SwaggerKindNormal * t)) -> SwaggerAesonOptions Source # aesonDefaults :: proxy (ParamSchema (SwaggerKindNormal * t)) -> POP * Maybe (Code (ParamSchema (SwaggerKindNormal * t))) Source #
HasSwaggerAesonOptions (ParamSchema (SwaggerKindParamOtherSchema *)) Source #
Methods swaggerAesonOptions :: proxy (ParamSchema (SwaggerKindParamOtherSchema )) -> SwaggerAesonOptions Source # aesonDefaults :: proxy (ParamSchema (SwaggerKindParamOtherSchema )) -> POP * Maybe (Code (ParamSchema (SwaggerKindParamOtherSchema *))) Source #
HasSwaggerAesonOptions (ParamSchema (SwaggerKindSchema *)) Source #
Methods swaggerAesonOptions :: proxy (ParamSchema (SwaggerKindSchema )) -> SwaggerAesonOptions Source # aesonDefaults :: proxy (ParamSchema (SwaggerKindSchema )) -> POP * Maybe (Code (ParamSchema (SwaggerKindSchema *))) Source #
HasUniqueItems (ParamSchema t0) (Maybe Bool) Source #
Methods uniqueItems :: Lens' (ParamSchema t0) (Maybe Bool) Source #
HasType (ParamSchema t0) (SwaggerType t0) Source #
Methods type_ :: Lens' (ParamSchema t0) (SwaggerType t0) Source #
HasPattern (ParamSchema t0) (Maybe Pattern) Source #
Methods pattern :: Lens' (ParamSchema t0) (Maybe Pattern) Source #
HasMultipleOf (ParamSchema t0) (Maybe Scientific) Source #
Methods multipleOf :: Lens' (ParamSchema t0) (Maybe Scientific) Source #
HasMinimum (ParamSchema t0) (Maybe Scientific) Source #
Methods minimum_ :: Lens' (ParamSchema t0) (Maybe Scientific) Source #
HasMinLength (ParamSchema t0) (Maybe Integer) Source #
Methods minLength :: Lens' (ParamSchema t0) (Maybe Integer) Source #
HasMinItems (ParamSchema t0) (Maybe Integer) Source #
Methods minItems :: Lens' (ParamSchema t0) (Maybe Integer) Source #
HasMaximum (ParamSchema t0) (Maybe Scientific) Source #
Methods maximum_ :: Lens' (ParamSchema t0) (Maybe Scientific) Source #
HasMaxLength (ParamSchema t0) (Maybe Integer) Source #
Methods maxLength :: Lens' (ParamSchema t0) (Maybe Integer) Source #
HasMaxItems (ParamSchema t0) (Maybe Integer) Source #
Methods maxItems :: Lens' (ParamSchema t0) (Maybe Integer) Source #
HasItems (ParamSchema t0) (Maybe (SwaggerItems t0)) Source #
Methods items :: Lens' (ParamSchema t0) (Maybe (SwaggerItems t0)) Source #
HasFormat (ParamSchema t0) (Maybe Format) Source #
Methods format :: Lens' (ParamSchema t0) (Maybe Format) Source #
HasExclusiveMinimum (ParamSchema t0) (Maybe Bool) Source #
Methods exclusiveMinimum :: Lens' (ParamSchema t0) (Maybe Bool) Source #
HasExclusiveMaximum (ParamSchema t0) (Maybe Bool) Source #
Methods exclusiveMaximum :: Lens' (ParamSchema t0) (Maybe Bool) Source #
HasEnum (ParamSchema t0) (Maybe [Value]) Source #
Methods enum_ :: Lens' (ParamSchema t0) (Maybe [Value]) Source #
HasDefault (ParamSchema t0) (Maybe Value) Source #
Methods default_ :: Lens' (ParamSchema t0) (Maybe Value) Source #
type Rep (ParamSchema t) Source #
type Rep (ParamSchema t) = D1 (MetaData "ParamSchema" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "ParamSchema" PrefixI True) ((::) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Value))) (S1 (MetaSel (Just Symbol "_paramSchemaType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (SwaggerType t)))) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaFormat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Format))) (S1 (MetaSel (Just Symbol "_paramSchemaItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (SwaggerItems t)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaMaximum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Scientific))) (S1 (MetaSel (Just Symbol "_paramSchemaExclusiveMaximum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaMinimum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Scientific))) (S1 (MetaSel (Just Symbol "_paramSchemaExclusiveMinimum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))))) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaMaxLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_paramSchemaMinLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)))) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaPattern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Pattern))) (S1 (MetaSel (Just Symbol "_paramSchemaMaxItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_paramSchemaMinItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_paramSchemaUniqueItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_paramSchemaEnum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Value]))) (S1 (MetaSel (Just Symbol "_paramSchemaMultipleOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Scientific))))))))
type Code (ParamSchema t0) Source #
type Code (ParamSchema t0) = (:) [] ((:) (Maybe Value) ((:) * (SwaggerType t0) ((:) * (Maybe Format) ((:) * (Maybe (SwaggerItems t0)) ((:) * (Maybe Scientific) ((:) * (Maybe Bool) ((:) * (Maybe Scientific) ((:) * (Maybe Bool) ((:) * (Maybe Integer) ((:) * (Maybe Integer) ((:) * (Maybe Pattern) ((:) * (Maybe Integer) ((:) * (Maybe Integer) ((:) * (Maybe Bool) ((:) * (Maybe [Value]) ((:) * (Maybe Scientific) ([] ))))))))))))))))) ([] [])

data Schema Source #

Constructors

Schema

Fields

_schemaTitle :: Maybe Text
_schemaDescription :: Maybe Text
_schemaRequired :: [ParamName]
_schemaAllOf :: Maybe [Schema]
_schemaProperties :: InsOrdHashMap Text (Referenced Schema)
_schemaAdditionalProperties :: Maybe (Referenced Schema)
_schemaDiscriminator :: Maybe Text
_schemaReadOnly :: Maybe Bool
_schemaXml :: Maybe Xml
_schemaExternalDocs :: Maybe ExternalDocs
_schemaExample :: Maybe Value
_schemaMaxProperties :: Maybe Integer
_schemaMinProperties :: Maybe Integer
_schemaParamSchema :: ParamSchema SwaggerKindSchema

Instances

Eq Schema Source #
Methods (==) :: Schema -> Schema -> Bool # (/=) :: Schema -> Schema -> Bool #
Data Schema Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Schema -> c Schema # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Schema # toConstr :: Schema -> Constr # dataTypeOf :: Schema -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Schema) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Schema) # gmapT :: (forall b. Data b => b -> b) -> Schema -> Schema # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Schema -> r # gmapQr :: (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 #
Show Schema Source #
Methods showsPrec :: Int -> Schema -> ShowS # show :: Schema -> String # showList :: [Schema] -> ShowS #
Generic Schema Source #
Associated Types type Rep Schema :: * -> * # Methods from :: Schema -> Rep Schema x # to :: Rep Schema x -> Schema #
Monoid Schema Source #
Methods mempty :: Schema # mappend :: Schema -> Schema -> Schema # mconcat :: [Schema] -> Schema #
ToJSON Schema Source #
Methods toJSON :: Schema -> Value # toEncoding :: Schema -> Encoding # toJSONList :: [Schema] -> Value # toEncodingList :: [Schema] -> Encoding #
FromJSON Schema Source #
Methods parseJSON :: Value -> Parser Schema # parseJSONList :: Value -> Parser [Schema] #
Generic Schema Source #
Associated Types type Code Schema :: [[*]] # Methods from :: Schema -> Rep Schema # to :: Rep Schema -> Schema #
HasDatatypeInfo Schema Source #
Methods datatypeInfo :: proxy Schema -> DatatypeInfo (Code Schema) #
SwaggerMonoid Schema Source #
Methods swaggerMempty :: Schema Source # swaggerMappend :: Schema -> Schema -> Schema Source #
HasSwaggerAesonOptions Schema Source #
Methods swaggerAesonOptions :: proxy Schema -> SwaggerAesonOptions Source # aesonDefaults :: proxy Schema -> POP * Maybe (Code Schema) Source #
HasSchema NamedSchema Schema Source #
Methods schema :: Lens' NamedSchema Schema Source #
HasExternalDocs Schema (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Schema (Maybe ExternalDocs) Source #
HasDefinitions Swagger (Definitions Schema) Source #
Methods definitions :: Lens' Swagger (Definitions Schema) Source #
HasTitle Schema (Maybe Text) Source #
Methods title :: Lens' Schema (Maybe Text) Source #
HasDescription Schema (Maybe Text) Source #
Methods description :: Lens' Schema (Maybe Text) Source #
HasSchema Response (Maybe (Referenced Schema)) Source #
Methods schema :: Lens' Response (Maybe (Referenced Schema)) Source #
HasRequired Schema [ParamName] Source #
Methods required :: Lens' Schema [ParamName] Source #
HasParamSchema Schema (ParamSchema (SwaggerKindSchema Type)) Source #
Methods paramSchema :: Lens' Schema (ParamSchema (SwaggerKindSchema Type)) Source #
HasXml Schema (Maybe Xml) Source #
Methods xml :: Lens' Schema (Maybe Xml) Source #
HasReadOnly Schema (Maybe Bool) Source #
Methods readOnly :: Lens' Schema (Maybe Bool) Source #
HasMinProperties Schema (Maybe Integer) Source #
Methods minProperties :: Lens' Schema (Maybe Integer) Source #
HasMaxProperties Schema (Maybe Integer) Source #
Methods maxProperties :: Lens' Schema (Maybe Integer) Source #
HasExample Schema (Maybe Value) Source #
Methods example :: Lens' Schema (Maybe Value) Source #
HasDiscriminator Schema (Maybe Text) Source #
Methods discriminator :: Lens' Schema (Maybe Text) Source #
HasAllOf Schema (Maybe [Schema]) Source #
Methods allOf :: Lens' Schema (Maybe [Schema]) Source #
HasAdditionalProperties Schema (Maybe (Referenced Schema)) Source #
Methods additionalProperties :: Lens' Schema (Maybe (Referenced Schema)) Source #
HasType Schema (SwaggerType (SwaggerKindSchema *)) Source #
Methods type_ :: Lens' Schema (SwaggerType (SwaggerKindSchema *)) Source #
HasDefault Schema (Maybe Value) Source #
Methods default_ :: Lens' Schema (Maybe Value) Source #
HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source #
Methods properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source #
ToJSON (Referenced Schema) Source #
Methods toJSON :: Referenced Schema -> Value # toEncoding :: Referenced Schema -> Encoding # toJSONList :: [Referenced Schema] -> Value # toEncodingList :: [Referenced Schema] -> Encoding #
FromJSON (Referenced Schema) Source #
Methods parseJSON :: Value -> Parser (Referenced Schema) # parseJSONList :: Value -> Parser [Referenced Schema] #
type Rep Schema Source #
type Rep Schema = D1 (MetaData "Schema" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Schema" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_schemaTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_schemaDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_schemaRequired") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ParamName])))) ((::) ((::) (S1 (MetaSel (Just Symbol "_schemaAllOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Schema]))) (S1 (MetaSel (Just Symbol "_schemaProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Schema))))) ((::) (S1 (MetaSel (Just Symbol "_schemaAdditionalProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Referenced Schema)))) (S1 (MetaSel (Just Symbol "_schemaDiscriminator") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_schemaReadOnly") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((::) (S1 (MetaSel (Just Symbol "_schemaXml") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Xml))) (S1 (MetaSel (Just Symbol "_schemaExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_schemaExample") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Value))) (S1 (MetaSel (Just Symbol "_schemaMaxProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)))) ((::) (S1 (MetaSel (Just Symbol "_schemaMinProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_schemaParamSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParamSchema (SwaggerKindSchema )))))))))
type Code Schema Source #
type Code Schema = (:) [] ((:) (Maybe Text) ((:) * (Maybe Text) ((:) * [ParamName] ((:) * (Maybe [Schema]) ((:) * (InsOrdHashMap Text (Referenced Schema)) ((:) * (Maybe (Referenced Schema)) ((:) * (Maybe Text) ((:) * (Maybe Bool) ((:) * (Maybe Xml) ((:) * (Maybe ExternalDocs) ((:) * (Maybe Value) ((:) * (Maybe Integer) ((:) * (Maybe Integer) ((:) * (ParamSchema (SwaggerKindSchema Type)) ([] ))))))))))))))) ([] [])

data NamedSchema Source #

A Schema with an optional name. This name can be used in references.

Constructors

NamedSchema
Fields _namedSchemaName :: Maybe Text _namedSchemaSchema :: Schema

Instances

Eq NamedSchema Source #
Methods (==) :: NamedSchema -> NamedSchema -> Bool # (/=) :: NamedSchema -> NamedSchema -> Bool #
Data NamedSchema Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NamedSchema -> c NamedSchema # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NamedSchema # toConstr :: NamedSchema -> Constr # dataTypeOf :: NamedSchema -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c NamedSchema) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NamedSchema) # gmapT :: (forall b. Data b => b -> b) -> NamedSchema -> NamedSchema # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NamedSchema -> r # gmapQr :: (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 #
Show NamedSchema Source #
Methods showsPrec :: Int -> NamedSchema -> ShowS # show :: NamedSchema -> String # showList :: [NamedSchema] -> ShowS #
Generic NamedSchema Source #
Associated Types type Rep NamedSchema :: * -> * # Methods from :: NamedSchema -> Rep NamedSchema x # to :: Rep NamedSchema x -> NamedSchema #
HasSchema NamedSchema Schema Source #
Methods schema :: Lens' NamedSchema Schema Source #
HasName NamedSchema (Maybe Text) Source #
Methods name :: Lens' NamedSchema (Maybe Text) Source #
HasParamSchema NamedSchema (ParamSchema (SwaggerKindSchema *)) Source #
Methods paramSchema :: Lens' NamedSchema (ParamSchema (SwaggerKindSchema *)) Source #
HasType NamedSchema (SwaggerType (SwaggerKindSchema *)) Source #
Methods type_ :: Lens' NamedSchema (SwaggerType (SwaggerKindSchema *)) Source #
type Rep NamedSchema Source #
type Rep NamedSchema = D1 (MetaData "NamedSchema" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "NamedSchema" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_namedSchemaName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_namedSchemaSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema))))

data SwaggerItems t where Source #

Items for SwaggerArray schemas.

SwaggerItemsPrimitive should be used only for query params, headers and path pieces. The CollectionFormat t parameter specifies how elements of an array should be displayed. Note that fmt in SwaggerItemsPrimitive fmt schema specifies format for elements of type schema. This is different from the original Swagger's Items Object.

SwaggerItemsObject should be used to specify homogenous array Schemas.

SwaggerItemsArray should be used to specify tuple Schemas.

Constructors

SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k -> SwaggerItems k
SwaggerItemsObject :: Referenced Schema -> SwaggerItems SwaggerKindSchema
SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems SwaggerKindSchema

Instances

HasParamSchema s (ParamSchema t) => HasItems s (Maybe (SwaggerItems t)) Source #
Methods items :: Lens' s (Maybe (SwaggerItems t)) Source #
Eq (SwaggerItems t) Source #
Methods (==) :: SwaggerItems t -> SwaggerItems t -> Bool # (/=) :: SwaggerItems t -> SwaggerItems t -> Bool #
Data t => Data (SwaggerItems (SwaggerKindNormal * t)) Source #
Methods 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 (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (SwaggerItems (SwaggerKindNormal t))) # dataCast2 :: Typeable (* -> * -> ) t => (forall d e. (Data d, Data e) => c (t 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 :: (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 *)) Source #
Methods 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 :: (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 *)) Source #
Methods 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 :: (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 #
Methods showsPrec :: Int -> SwaggerItems t -> ShowS # show :: SwaggerItems t -> String # showList :: [SwaggerItems t] -> ShowS #
ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) Source #
Methods toJSON :: SwaggerItems t -> Value # toEncoding :: SwaggerItems t -> Encoding # toJSONList :: [SwaggerItems t] -> Value # toEncodingList :: [SwaggerItems t] -> Encoding #
(FromJSON (CollectionFormat (SwaggerKindNormal * t)), FromJSON (ParamSchema (SwaggerKindNormal * t))) => FromJSON (SwaggerItems (SwaggerKindNormal * t)) Source #
Methods parseJSON :: Value -> Parser (SwaggerItems (SwaggerKindNormal * t)) # parseJSONList :: Value -> Parser [SwaggerItems (SwaggerKindNormal * t)] #
FromJSON (SwaggerItems (SwaggerKindParamOtherSchema *)) Source #
Methods parseJSON :: Value -> Parser (SwaggerItems (SwaggerKindParamOtherSchema )) # parseJSONList :: Value -> Parser [SwaggerItems (SwaggerKindParamOtherSchema )] #
FromJSON (SwaggerItems (SwaggerKindSchema *)) Source #
Methods parseJSON :: Value -> Parser (SwaggerItems (SwaggerKindSchema )) # parseJSONList :: Value -> Parser [SwaggerItems (SwaggerKindSchema )] #
HasItems (ParamSchema t0) (Maybe (SwaggerItems t0)) Source #
Methods items :: Lens' (ParamSchema t0) (Maybe (SwaggerItems t0)) Source #

data Xml Source #

Constructors

Xml

Fields

_xmlName :: Maybe Text
Replaces the name of the element/attribute used for the described schema property. When defined within the SwaggerItems (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
_xmlNamespace :: Maybe Text
The URL of the namespace definition. Value SHOULD be in the form of a URL.
_xmlPrefix :: Maybe Text
The prefix to be used for the name.
_xmlAttribute :: Maybe Bool
Declares whether the property definition translates to an attribute instead of an element. Default value is False.
_xmlWrapped :: Maybe Bool
MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book><book></books>) or unwrapped (<book><book>). Default value is False. The definition takes effect only when defined alongside type being array (outside the items).

Instances

Eq Xml Source #
Methods (==) :: Xml -> Xml -> Bool # (/=) :: Xml -> Xml -> Bool #
Data Xml Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Xml -> c Xml # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Xml # toConstr :: Xml -> Constr # 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 :: (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 #
Show Xml Source #
Methods showsPrec :: Int -> Xml -> ShowS # show :: Xml -> String # showList :: [Xml] -> ShowS #
Generic Xml Source #
Associated Types type Rep Xml :: * -> * # Methods from :: Xml -> Rep Xml x # to :: Rep Xml x -> Xml #
ToJSON Xml Source #
Methods toJSON :: Xml -> Value # toEncoding :: Xml -> Encoding # toJSONList :: [Xml] -> Value # toEncodingList :: [Xml] -> Encoding #
FromJSON Xml Source #
Methods parseJSON :: Value -> Parser Xml # parseJSONList :: Value -> Parser [Xml] #
HasName Xml (Maybe Text) Source #
Methods name :: Lens' Xml (Maybe Text) Source #
HasXml Schema (Maybe Xml) Source #
Methods xml :: Lens' Schema (Maybe Xml) Source #
HasWrapped Xml (Maybe Bool) Source #
Methods wrapped :: Lens' Xml (Maybe Bool) Source #
HasPrefix Xml (Maybe Text) Source #
Methods prefix :: Lens' Xml (Maybe Text) Source #
HasNamespace Xml (Maybe Text) Source #
Methods namespace :: Lens' Xml (Maybe Text) Source #
HasAttribute Xml (Maybe Bool) Source #
Methods attribute :: Lens' Xml (Maybe Bool) Source #
type Rep Xml Source #
type Rep Xml = D1 (MetaData "Xml" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Xml" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_xmlName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_xmlNamespace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((::) (S1 (MetaSel (Just Symbol "_xmlPrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_xmlAttribute") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_xmlWrapped") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))))))

type Pattern = Text Source #

Regex pattern for string type.

Responses

data Responses Source #

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.

Constructors

Responses

Fields

_responsesDefault :: Maybe (Referenced Response)
The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses.
_responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
Any HTTP status code can be used as the property name (one property per HTTP status code). Describes the expected response for those HTTP status codes.

Instances

Eq Responses Source #
Methods (==) :: Responses -> Responses -> Bool # (/=) :: Responses -> Responses -> Bool #
Data Responses Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Responses -> c Responses # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Responses # toConstr :: Responses -> Constr # dataTypeOf :: Responses -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Responses) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Responses) # gmapT :: (forall b. Data b => b -> b) -> Responses -> Responses # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Responses -> r # gmapQr :: (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 #
Show Responses Source #
Methods showsPrec :: Int -> Responses -> ShowS # show :: Responses -> String # showList :: [Responses] -> ShowS #
Generic Responses Source #
Associated Types type Rep Responses :: * -> * # Methods from :: Responses -> Rep Responses x # to :: Rep Responses x -> Responses #
Monoid Responses Source #
Methods mempty :: Responses # mappend :: Responses -> Responses -> Responses # mconcat :: [Responses] -> Responses #
ToJSON Responses Source #
Methods toJSON :: Responses -> Value # toEncoding :: Responses -> Encoding # toJSONList :: [Responses] -> Value # toEncodingList :: [Responses] -> Encoding #
FromJSON Responses Source #
Methods parseJSON :: Value -> Parser Responses # parseJSONList :: Value -> Parser [Responses] #
Generic Responses Source #
Associated Types type Code Responses :: [[*]] # Methods from :: Responses -> Rep Responses # to :: Rep Responses -> Responses #
HasDatatypeInfo Responses Source #
Methods datatypeInfo :: proxy Responses -> DatatypeInfo (Code Responses) #
SwaggerMonoid Responses Source #
Methods swaggerMempty :: Responses Source # swaggerMappend :: Responses -> Responses -> Responses Source #
AesonDefaultValue Responses Source #
Methods defaultValue :: Maybe Responses Source #
HasSwaggerAesonOptions Responses Source #
Methods swaggerAesonOptions :: proxy Responses -> SwaggerAesonOptions Source # aesonDefaults :: proxy Responses -> POP * Maybe (Code Responses) Source #
HasResponses Operation Responses Source #
Methods responses :: Lens' Operation Responses Source #
HasDefault Responses (Maybe (Referenced Response)) Source #
Methods default_ :: Lens' Responses (Maybe (Referenced Response)) Source #
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
type Rep Responses Source #
type Rep Responses = D1 (MetaData "Responses" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Responses" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_responsesDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Referenced Response)))) (S1 (MetaSel (Just Symbol "_responsesResponses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap HttpStatusCode (Referenced Response))))))
type Code Responses Source #
type Code Responses = (:) [] ((:) (Maybe (Referenced Response)) ((:) * (InsOrdHashMap HttpStatusCode (Referenced Response)) ([] ))) ([] [])
type Index Responses #
type Index Responses = HttpStatusCode
type IxValue Responses #
type IxValue Responses = Referenced Response

data Response Source #

Describes a single response from an API Operation.

Constructors

Response

Fields

_responseDescription :: Text
A short description of the response. GFM syntax can be used for rich text representation.
_responseSchema :: Maybe (Referenced Schema)
A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be "file". This SHOULD be accompanied by a relevant produces mime-type.
_responseHeaders :: InsOrdHashMap HeaderName Header
A list of headers that are sent with the response.
_responseExamples :: Maybe Example
An example of the response message.

Instances

Eq Response Source #
Methods (==) :: Response -> Response -> Bool # (/=) :: Response -> Response -> Bool #
Data Response Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Response -> c Response # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Response # toConstr :: Response -> Constr # dataTypeOf :: Response -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Response) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Response) # gmapT :: (forall b. Data b => b -> b) -> Response -> Response # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Response -> r # gmapQr :: (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 #
Show Response Source #
Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
IsString Response Source #
Methods fromString :: String -> Response #
Generic Response Source #
Associated Types type Rep Response :: * -> * # Methods from :: Response -> Rep Response x # to :: Rep Response x -> Response #
Monoid Response Source #
Methods mempty :: Response # mappend :: Response -> Response -> Response # mconcat :: [Response] -> Response #
ToJSON Response Source #
Methods toJSON :: Response -> Value # toEncoding :: Response -> Encoding # toJSONList :: [Response] -> Value # toEncodingList :: [Response] -> Encoding #
FromJSON Response Source #
Methods parseJSON :: Value -> Parser Response # parseJSONList :: Value -> Parser [Response] #
Generic Response Source #
Associated Types type Code Response :: [[*]] # Methods from :: Response -> Rep Response # to :: Rep Response -> Response #
HasDatatypeInfo Response Source #
Methods datatypeInfo :: proxy Response -> DatatypeInfo (Code Response) #
SwaggerMonoid Response Source #
Methods swaggerMempty :: Response Source # swaggerMappend :: Response -> Response -> Response Source #
HasSwaggerAesonOptions Response Source #
Methods swaggerAesonOptions :: proxy Response -> SwaggerAesonOptions Source # aesonDefaults :: proxy Response -> POP * Maybe (Code Response) Source #
HasDescription Response Text Source #
Methods description :: Lens' Response Text Source #
HasResponses Swagger (Definitions Response) Source #
Methods responses :: Lens' Swagger (Definitions Response) Source #
HasSchema Response (Maybe (Referenced Schema)) Source #
Methods schema :: Lens' Response (Maybe (Referenced Schema)) Source #
HasDefault Responses (Maybe (Referenced Response)) Source #
Methods default_ :: Lens' Responses (Maybe (Referenced Response)) Source #
HasExamples Response (Maybe Example) Source #
Methods examples :: Lens' Response (Maybe Example) Source #
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
HasHeaders Response (InsOrdHashMap HeaderName Header) Source #
Methods headers :: Lens' Response (InsOrdHashMap HeaderName Header) Source #
ToJSON (Referenced Response) Source #
Methods toJSON :: Referenced Response -> Value # toEncoding :: Referenced Response -> Encoding # toJSONList :: [Referenced Response] -> Value # toEncodingList :: [Referenced Response] -> Encoding #
FromJSON (Referenced Response) Source #
Methods parseJSON :: Value -> Parser (Referenced Response) # parseJSONList :: Value -> Parser [Referenced Response] #
type Rep Response Source #
type Rep Response = D1 (MetaData "Response" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Response" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_responseDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_responseSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Referenced Schema))))) ((:*:) (S1 (MetaSel (Just Symbol "_responseHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap HeaderName Header))) (S1 (MetaSel (Just Symbol "_responseExamples") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Example))))))
type Code Response Source #
type Code Response = (:) [] ((:) Text ((:) * (Maybe (Referenced Schema)) ((:) * (InsOrdHashMap HeaderName Header) ((:) * (Maybe Example) ([] ))))) ([] [])

type HttpStatusCode = Int Source #

Security

data SecurityScheme Source #

Constructors

SecurityScheme
Fields _securitySchemeType :: SecuritySchemeType The type of the security scheme. _securitySchemeDescription :: Maybe Text A short description for security scheme.

Instances

Eq SecurityScheme Source #
Methods (==) :: SecurityScheme -> SecurityScheme -> Bool # (/=) :: SecurityScheme -> SecurityScheme -> Bool #
Data SecurityScheme Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecurityScheme -> c SecurityScheme # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecurityScheme # toConstr :: SecurityScheme -> Constr # dataTypeOf :: SecurityScheme -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SecurityScheme) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecurityScheme) # gmapT :: (forall b. Data b => b -> b) -> SecurityScheme -> SecurityScheme # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecurityScheme -> r # gmapQr :: (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 #
Show SecurityScheme Source #
Methods showsPrec :: Int -> SecurityScheme -> ShowS # show :: SecurityScheme -> String # showList :: [SecurityScheme] -> ShowS #
Generic SecurityScheme Source #
Associated Types type Rep SecurityScheme :: * -> * # Methods from :: SecurityScheme -> Rep SecurityScheme x # to :: Rep SecurityScheme x -> SecurityScheme #
ToJSON SecurityScheme Source #
Methods toJSON :: SecurityScheme -> Value # toEncoding :: SecurityScheme -> Encoding # toJSONList :: [SecurityScheme] -> Value # toEncodingList :: [SecurityScheme] -> Encoding #
FromJSON SecurityScheme Source #
Methods parseJSON :: Value -> Parser SecurityScheme # parseJSONList :: Value -> Parser [SecurityScheme] #
Generic SecurityScheme Source #
Associated Types type Code SecurityScheme :: [[*]] # Methods from :: SecurityScheme -> Rep SecurityScheme # to :: Rep SecurityScheme -> SecurityScheme #
HasDatatypeInfo SecurityScheme Source #
Methods datatypeInfo :: proxy SecurityScheme -> DatatypeInfo (Code SecurityScheme) #
HasSwaggerAesonOptions SecurityScheme Source #
Methods swaggerAesonOptions :: proxy SecurityScheme -> SwaggerAesonOptions Source # aesonDefaults :: proxy SecurityScheme -> POP * Maybe (Code SecurityScheme) Source #
HasType SecurityScheme SecuritySchemeType Source #
Methods type_ :: Lens' SecurityScheme SecuritySchemeType Source #
HasSecurityDefinitions Swagger (Definitions SecurityScheme) Source #
Methods securityDefinitions :: Lens' Swagger (Definitions SecurityScheme) Source #
HasDescription SecurityScheme (Maybe Text) Source #
Methods description :: Lens' SecurityScheme (Maybe Text) Source #
type Rep SecurityScheme Source #
type Rep SecurityScheme = D1 (MetaData "SecurityScheme" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "SecurityScheme" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_securitySchemeType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SecuritySchemeType)) (S1 (MetaSel (Just Symbol "_securitySchemeDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))
type Code SecurityScheme Source #
type Code SecurityScheme = (:) [] ((:) SecuritySchemeType ((:) * (Maybe Text) ([] ))) ([] [])

data SecuritySchemeType Source #

Constructors

SecuritySchemeBasic
SecuritySchemeApiKey ApiKeyParams
SecuritySchemeOAuth2 OAuth2Params

Instances

Eq SecuritySchemeType Source #
Methods (==) :: SecuritySchemeType -> SecuritySchemeType -> Bool # (/=) :: SecuritySchemeType -> SecuritySchemeType -> Bool #
Data SecuritySchemeType Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecuritySchemeType -> c SecuritySchemeType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecuritySchemeType # toConstr :: SecuritySchemeType -> Constr # dataTypeOf :: SecuritySchemeType -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SecuritySchemeType) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecuritySchemeType) # gmapT :: (forall b. Data b => b -> b) -> SecuritySchemeType -> SecuritySchemeType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecuritySchemeType -> r # gmapQr :: (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 #
Show SecuritySchemeType Source #
Methods showsPrec :: Int -> SecuritySchemeType -> ShowS # show :: SecuritySchemeType -> String # showList :: [SecuritySchemeType] -> ShowS #
Generic SecuritySchemeType Source #
Associated Types type Rep SecuritySchemeType :: * -> * # Methods from :: SecuritySchemeType -> Rep SecuritySchemeType x # to :: Rep SecuritySchemeType x -> SecuritySchemeType #
ToJSON SecuritySchemeType Source #
Methods toJSON :: SecuritySchemeType -> Value # toEncoding :: SecuritySchemeType -> Encoding # toJSONList :: [SecuritySchemeType] -> Value # toEncodingList :: [SecuritySchemeType] -> Encoding #
FromJSON SecuritySchemeType Source #
Methods parseJSON :: Value -> Parser SecuritySchemeType # parseJSONList :: Value -> Parser [SecuritySchemeType] #
AesonDefaultValue SecuritySchemeType Source #
Methods defaultValue :: Maybe SecuritySchemeType Source #
HasType SecurityScheme SecuritySchemeType Source #
Methods type_ :: Lens' SecurityScheme SecuritySchemeType Source #
type Rep SecuritySchemeType Source #
type Rep SecuritySchemeType = D1 (MetaData "SecuritySchemeType" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) ((:+:) (C1 (MetaCons "SecuritySchemeBasic" PrefixI False) U1) ((:+:) (C1 (MetaCons "SecuritySchemeApiKey" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ApiKeyParams))) (C1 (MetaCons "SecuritySchemeOAuth2" PrefixI False) (S1 (MetaSel (Nothing 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).

Constructors

SecurityRequirement
Fields getSecurityRequirement :: InsOrdHashMap Text [Text]

Instances

Eq SecurityRequirement Source #
Methods (==) :: SecurityRequirement -> SecurityRequirement -> Bool # (/=) :: SecurityRequirement -> SecurityRequirement -> Bool #
Data SecurityRequirement Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecurityRequirement -> c SecurityRequirement # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecurityRequirement # toConstr :: SecurityRequirement -> Constr # dataTypeOf :: SecurityRequirement -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SecurityRequirement) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecurityRequirement) # gmapT :: (forall b. Data b => b -> b) -> SecurityRequirement -> SecurityRequirement # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecurityRequirement -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecurityRequirement -> r # gmapQ :: (forall d. Data d => d -> u) -> SecurityRequirement -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SecurityRequirement -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement #
Read SecurityRequirement Source #
Methods readsPrec :: Int -> ReadS SecurityRequirement # readList :: ReadS [SecurityRequirement] # readPrec :: ReadPrec SecurityRequirement # readListPrec :: ReadPrec [SecurityRequirement] #
Show SecurityRequirement Source #
Methods showsPrec :: Int -> SecurityRequirement -> ShowS # show :: SecurityRequirement -> String # showList :: [SecurityRequirement] -> ShowS #
Monoid SecurityRequirement Source #
Methods mempty :: SecurityRequirement # mappend :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement # mconcat :: [SecurityRequirement] -> SecurityRequirement #
ToJSON SecurityRequirement Source #
Methods toJSON :: SecurityRequirement -> Value # toEncoding :: SecurityRequirement -> Encoding # toJSONList :: [SecurityRequirement] -> Value # toEncodingList :: [SecurityRequirement] -> Encoding #
FromJSON SecurityRequirement Source #
Methods parseJSON :: Value -> Parser SecurityRequirement # parseJSONList :: Value -> Parser [SecurityRequirement] #
HasSecurity Operation [SecurityRequirement] Source #
Methods security :: Lens' Operation [SecurityRequirement] Source #
HasSecurity Swagger [SecurityRequirement] Source #
Methods security :: Lens' Swagger [SecurityRequirement] Source #

API key

data ApiKeyParams Source #

Constructors

ApiKeyParams
Fields _apiKeyName :: Text The name of the header or query parameter to be used. _apiKeyIn :: ApiKeyLocation The location of the API key.

Instances

Eq ApiKeyParams Source #
Methods (==) :: ApiKeyParams -> ApiKeyParams -> Bool # (/=) :: ApiKeyParams -> ApiKeyParams -> Bool #
Data ApiKeyParams Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApiKeyParams -> c ApiKeyParams # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApiKeyParams # toConstr :: ApiKeyParams -> Constr # dataTypeOf :: ApiKeyParams -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ApiKeyParams) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApiKeyParams) # gmapT :: (forall b. Data b => b -> b) -> ApiKeyParams -> ApiKeyParams # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApiKeyParams -> r # gmapQr :: (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 #
Show ApiKeyParams Source #
Methods showsPrec :: Int -> ApiKeyParams -> ShowS # show :: ApiKeyParams -> String # showList :: [ApiKeyParams] -> ShowS #
Generic ApiKeyParams Source #
Associated Types type Rep ApiKeyParams :: * -> * # Methods from :: ApiKeyParams -> Rep ApiKeyParams x # to :: Rep ApiKeyParams x -> ApiKeyParams #
ToJSON ApiKeyParams Source #
Methods toJSON :: ApiKeyParams -> Value # toEncoding :: ApiKeyParams -> Encoding # toJSONList :: [ApiKeyParams] -> Value # toEncodingList :: [ApiKeyParams] -> Encoding #
FromJSON ApiKeyParams Source #
Methods parseJSON :: Value -> Parser ApiKeyParams # parseJSONList :: Value -> Parser [ApiKeyParams] #
type Rep ApiKeyParams Source #
type Rep ApiKeyParams = D1 (MetaData "ApiKeyParams" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "ApiKeyParams" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_apiKeyName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_apiKeyIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ApiKeyLocation))))

data ApiKeyLocation Source #

The location of the API key.

Constructors

ApiKeyQuery
ApiKeyHeader

Instances

Eq ApiKeyLocation Source #
Methods (==) :: ApiKeyLocation -> ApiKeyLocation -> Bool # (/=) :: ApiKeyLocation -> ApiKeyLocation -> Bool #
Data ApiKeyLocation Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApiKeyLocation -> c ApiKeyLocation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApiKeyLocation # toConstr :: ApiKeyLocation -> Constr # dataTypeOf :: ApiKeyLocation -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ApiKeyLocation) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApiKeyLocation) # gmapT :: (forall b. Data b => b -> b) -> ApiKeyLocation -> ApiKeyLocation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApiKeyLocation -> r # gmapQr :: (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 #
Show ApiKeyLocation Source #
Methods showsPrec :: Int -> ApiKeyLocation -> ShowS # show :: ApiKeyLocation -> String # showList :: [ApiKeyLocation] -> ShowS #
Generic ApiKeyLocation Source #
Associated Types type Rep ApiKeyLocation :: * -> * # Methods from :: ApiKeyLocation -> Rep ApiKeyLocation x # to :: Rep ApiKeyLocation x -> ApiKeyLocation #
ToJSON ApiKeyLocation Source #
Methods toJSON :: ApiKeyLocation -> Value # toEncoding :: ApiKeyLocation -> Encoding # toJSONList :: [ApiKeyLocation] -> Value # toEncodingList :: [ApiKeyLocation] -> Encoding #
FromJSON ApiKeyLocation Source #
Methods parseJSON :: Value -> Parser ApiKeyLocation # parseJSONList :: Value -> Parser [ApiKeyLocation] #
type Rep ApiKeyLocation Source #
type Rep ApiKeyLocation = D1 (MetaData "ApiKeyLocation" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) ((:+:) (C1 (MetaCons "ApiKeyQuery" PrefixI False) U1) (C1 (MetaCons "ApiKeyHeader" PrefixI False) U1))

OAuth2

data OAuth2Params Source #

Constructors

OAuth2Params
Fields _oauth2Flow :: OAuth2Flow The flow used by the OAuth2 security scheme. _oauth2Scopes :: InsOrdHashMap Text Text The available scopes for the OAuth2 security scheme.

Instances

Eq OAuth2Params Source #
Methods (==) :: OAuth2Params -> OAuth2Params -> Bool # (/=) :: OAuth2Params -> OAuth2Params -> Bool #
Data OAuth2Params Source #
Methods 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 :: (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 #
Show OAuth2Params Source #
Methods showsPrec :: Int -> OAuth2Params -> ShowS # show :: OAuth2Params -> String # showList :: [OAuth2Params] -> ShowS #
Generic OAuth2Params Source #
Associated Types type Rep OAuth2Params :: * -> * # Methods from :: OAuth2Params -> Rep OAuth2Params x # to :: Rep OAuth2Params x -> OAuth2Params #
ToJSON OAuth2Params Source #
Methods toJSON :: OAuth2Params -> Value # toEncoding :: OAuth2Params -> Encoding # toJSONList :: [OAuth2Params] -> Value # toEncodingList :: [OAuth2Params] -> Encoding #
FromJSON OAuth2Params Source #
Methods parseJSON :: Value -> Parser OAuth2Params # parseJSONList :: Value -> Parser [OAuth2Params] #
Generic OAuth2Params Source #
Associated Types type Code OAuth2Params :: [[*]] # Methods from :: OAuth2Params -> Rep OAuth2Params # to :: Rep OAuth2Params -> OAuth2Params #
HasDatatypeInfo OAuth2Params Source #
Methods datatypeInfo :: proxy OAuth2Params -> DatatypeInfo (Code OAuth2Params) #
HasSwaggerAesonOptions OAuth2Params Source #
Methods swaggerAesonOptions :: proxy OAuth2Params -> SwaggerAesonOptions Source # aesonDefaults :: proxy OAuth2Params -> POP * Maybe (Code OAuth2Params) Source #
type Rep OAuth2Params Source #
type Rep OAuth2Params = D1 (MetaData "OAuth2Params" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "OAuth2Params" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_oauth2Flow") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OAuth2Flow)) (S1 (MetaSel (Just Symbol "_oauth2Scopes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap Text Text)))))
type Code OAuth2Params Source #
type Code OAuth2Params = (:) [] ((:) OAuth2Flow ((:) * (InsOrdHashMap Text Text) ([] ))) ([] [])

data OAuth2Flow Source #

Constructors

OAuth2Implicit AuthorizationURL
OAuth2Password TokenURL
OAuth2Application TokenURL
OAuth2AccessCode AuthorizationURL TokenURL

Instances

Eq OAuth2Flow Source #
Methods (==) :: OAuth2Flow -> OAuth2Flow -> Bool # (/=) :: OAuth2Flow -> OAuth2Flow -> Bool #
Data OAuth2Flow Source #
Methods 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 :: (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 #
Show OAuth2Flow Source #
Methods showsPrec :: Int -> OAuth2Flow -> ShowS # show :: OAuth2Flow -> String # showList :: [OAuth2Flow] -> ShowS #
Generic OAuth2Flow Source #
Associated Types type Rep OAuth2Flow :: * -> * # Methods from :: OAuth2Flow -> Rep OAuth2Flow x # to :: Rep OAuth2Flow x -> OAuth2Flow #
ToJSON OAuth2Flow Source #
Methods toJSON :: OAuth2Flow -> Value # toEncoding :: OAuth2Flow -> Encoding # toJSONList :: [OAuth2Flow] -> Value # toEncodingList :: [OAuth2Flow] -> Encoding #
FromJSON OAuth2Flow Source #
Methods parseJSON :: Value -> Parser OAuth2Flow # parseJSONList :: Value -> Parser [OAuth2Flow] #
AesonDefaultValue OAuth2Flow Source #
Methods defaultValue :: Maybe OAuth2Flow Source #
type Rep OAuth2Flow Source #
type Rep OAuth2Flow = D1 (MetaData "OAuth2Flow" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) ((:+:) ((:+:) (C1 (MetaCons "OAuth2Implicit" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AuthorizationURL))) (C1 (MetaCons "OAuth2Password" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TokenURL)))) ((:+:) (C1 (MetaCons "OAuth2Application" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TokenURL))) (C1 (MetaCons "OAuth2AccessCode" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AuthorizationURL)) (S1 (MetaSel (Nothing 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.

type TokenURL = Text Source #

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.

Constructors

ExternalDocs
Fields _externalDocsDescription :: Maybe Text A short description of the target documentation. GFM syntax can be used for rich text representation. _externalDocsUrl :: URL The URL for the target documentation.

Instances

Eq ExternalDocs Source #
Methods (==) :: ExternalDocs -> ExternalDocs -> Bool # (/=) :: ExternalDocs -> ExternalDocs -> Bool #
Data ExternalDocs Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExternalDocs -> c ExternalDocs # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExternalDocs # toConstr :: ExternalDocs -> Constr # dataTypeOf :: ExternalDocs -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ExternalDocs) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExternalDocs) # gmapT :: (forall b. Data b => b -> b) -> ExternalDocs -> ExternalDocs # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExternalDocs -> r # gmapQr :: (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 #
Ord ExternalDocs Source #
Methods compare :: ExternalDocs -> ExternalDocs -> Ordering # (<) :: ExternalDocs -> ExternalDocs -> Bool # (<=) :: ExternalDocs -> ExternalDocs -> Bool # (>) :: ExternalDocs -> ExternalDocs -> Bool # (>=) :: ExternalDocs -> ExternalDocs -> Bool # max :: ExternalDocs -> ExternalDocs -> ExternalDocs # min :: ExternalDocs -> ExternalDocs -> ExternalDocs #
Show ExternalDocs Source #
Methods showsPrec :: Int -> ExternalDocs -> ShowS # show :: ExternalDocs -> String # showList :: [ExternalDocs] -> ShowS #
Generic ExternalDocs Source #
Associated Types type Rep ExternalDocs :: * -> * # Methods from :: ExternalDocs -> Rep ExternalDocs x # to :: Rep ExternalDocs x -> ExternalDocs #
Monoid ExternalDocs Source #
Methods mempty :: ExternalDocs # mappend :: ExternalDocs -> ExternalDocs -> ExternalDocs # mconcat :: [ExternalDocs] -> ExternalDocs #
ToJSON ExternalDocs Source #
Methods toJSON :: ExternalDocs -> Value # toEncoding :: ExternalDocs -> Encoding # toJSONList :: [ExternalDocs] -> Value # toEncodingList :: [ExternalDocs] -> Encoding #
FromJSON ExternalDocs Source #
Methods parseJSON :: Value -> Parser ExternalDocs # parseJSONList :: Value -> Parser [ExternalDocs] #
SwaggerMonoid ExternalDocs Source #
Methods swaggerMempty :: ExternalDocs Source # swaggerMappend :: ExternalDocs -> ExternalDocs -> ExternalDocs Source #
HasUrl ExternalDocs URL Source #
Methods url :: Lens' ExternalDocs URL Source #
HasExternalDocs Tag (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Tag (Maybe ExternalDocs) Source #
HasExternalDocs Schema (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Schema (Maybe ExternalDocs) Source #
HasExternalDocs Operation (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Operation (Maybe ExternalDocs) Source #
HasExternalDocs Swagger (Maybe ExternalDocs) Source #
Methods externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source #
HasDescription ExternalDocs (Maybe Text) Source #
Methods description :: Lens' ExternalDocs (Maybe Text) Source #
type Rep ExternalDocs Source #
type Rep ExternalDocs = D1 (MetaData "ExternalDocs" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "ExternalDocs" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_externalDocsDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_externalDocsUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URL))))

References

newtype Reference Source #

A simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse.

Constructors

Reference
Fields getReference :: Text

Instances

Eq Reference Source #
Methods (==) :: Reference -> Reference -> Bool # (/=) :: Reference -> Reference -> Bool #
Data Reference Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Reference -> c Reference # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Reference # toConstr :: Reference -> Constr # dataTypeOf :: Reference -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Reference) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Reference) # gmapT :: (forall b. Data b => b -> b) -> Reference -> Reference # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Reference -> r # gmapQr :: (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 #
Methods showsPrec :: Int -> Reference -> ShowS # show :: Reference -> String # showList :: [Reference] -> ShowS #
ToJSON Reference Source #
Methods toJSON :: Reference -> Value # toEncoding :: Reference -> Encoding # toJSONList :: [Reference] -> Value # toEncodingList :: [Reference] -> Encoding #
FromJSON Reference Source #
Methods parseJSON :: Value -> Parser Reference # parseJSONList :: Value -> Parser [Reference] #

data Referenced a Source #

Constructors

Ref Reference
Inline a

Instances

Functor Referenced Source #
Methods fmap :: (a -> b) -> Referenced a -> Referenced b # (<$) :: a -> Referenced b -> Referenced a #
HasParameters Operation [Referenced Param] Source #
Methods parameters :: Lens' Operation [Referenced Param] Source #
HasParameters PathItem [Referenced Param] Source #
Methods parameters :: Lens' PathItem [Referenced Param] Source #
HasSchema Response (Maybe (Referenced Schema)) Source #
Methods schema :: Lens' Response (Maybe (Referenced Schema)) Source #
HasAdditionalProperties Schema (Maybe (Referenced Schema)) Source #
Methods additionalProperties :: Lens' Schema (Maybe (Referenced Schema)) Source #
HasDefault Responses (Maybe (Referenced Response)) Source #
Methods default_ :: Lens' Responses (Maybe (Referenced Response)) Source #
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source #
Methods properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source #
Eq a => Eq (Referenced a) Source #
Methods (==) :: Referenced a -> Referenced a -> Bool # (/=) :: Referenced a -> Referenced a -> Bool #
Data a => Data (Referenced a) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Referenced a -> c (Referenced a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Referenced a) # toConstr :: Referenced a -> Constr # dataTypeOf :: Referenced a -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (Referenced a)) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Referenced a)) # gmapT :: (forall b. Data b => b -> b) -> Referenced a -> Referenced a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Referenced a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Referenced a -> r # gmapQ :: (forall d. Data d => d -> u) -> Referenced a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Referenced a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a) #
Show a => Show (Referenced a) Source #
Methods showsPrec :: Int -> Referenced a -> ShowS # show :: Referenced a -> String # showList :: [Referenced a] -> ShowS #
IsString a => IsString (Referenced a) Source #
Methods fromString :: String -> Referenced a #
ToJSON (Referenced Response) Source #
Methods toJSON :: Referenced Response -> Value # toEncoding :: Referenced Response -> Encoding # toJSONList :: [Referenced Response] -> Value # toEncodingList :: [Referenced Response] -> Encoding #
ToJSON (Referenced Schema) Source #
Methods toJSON :: Referenced Schema -> Value # toEncoding :: Referenced Schema -> Encoding # toJSONList :: [Referenced Schema] -> Value # toEncodingList :: [Referenced Schema] -> Encoding #
ToJSON (Referenced Param) Source #
Methods toJSON :: Referenced Param -> Value # toEncoding :: Referenced Param -> Encoding # toJSONList :: [Referenced Param] -> Value # toEncodingList :: [Referenced Param] -> Encoding #
FromJSON (Referenced Response) Source #
Methods parseJSON :: Value -> Parser (Referenced Response) # parseJSONList :: Value -> Parser [Referenced Response] #
FromJSON (Referenced Schema) Source #
Methods parseJSON :: Value -> Parser (Referenced Schema) # parseJSONList :: Value -> Parser [Referenced Schema] #
FromJSON (Referenced Param) Source #
Methods parseJSON :: Value -> Parser (Referenced Param) # parseJSONList :: Value -> Parser [Referenced Param] #
Monoid a => SwaggerMonoid (Referenced a) Source #
Methods swaggerMempty :: Referenced a Source # swaggerMappend :: Referenced a -> Referenced a -> Referenced a Source #

Miscellaneous

newtype MimeList Source #

Constructors

MimeList
Fields getMimeList :: [MediaType]

Instances

Eq MimeList Source #
Methods (==) :: MimeList -> MimeList -> Bool # (/=) :: MimeList -> MimeList -> Bool #
Data MimeList Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MimeList -> c MimeList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MimeList # toConstr :: MimeList -> Constr # dataTypeOf :: MimeList -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c MimeList) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MimeList) # gmapT :: (forall b. Data b => b -> b) -> MimeList -> MimeList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MimeList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MimeList -> r # gmapQ :: (forall d. Data d => d -> u) -> MimeList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MimeList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MimeList -> m MimeList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MimeList -> m MimeList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MimeList -> m MimeList #
Show MimeList Source #
Methods showsPrec :: Int -> MimeList -> ShowS # show :: MimeList -> String # showList :: [MimeList] -> ShowS #
Monoid MimeList Source #
Methods mempty :: MimeList # mappend :: MimeList -> MimeList -> MimeList # mconcat :: [MimeList] -> MimeList #
ToJSON MimeList Source #
Methods toJSON :: MimeList -> Value # toEncoding :: MimeList -> Encoding # toJSONList :: [MimeList] -> Value # toEncodingList :: [MimeList] -> Encoding #
FromJSON MimeList Source #
Methods parseJSON :: Value -> Parser MimeList # parseJSONList :: Value -> Parser [MimeList] #
SwaggerMonoid MimeList Source #
Methods swaggerMempty :: MimeList Source # swaggerMappend :: MimeList -> MimeList -> MimeList Source #
AesonDefaultValue MimeList Source #
Methods defaultValue :: Maybe MimeList Source #
HasProduces Swagger MimeList Source #
Methods produces :: Lens' Swagger MimeList Source #
HasConsumes Swagger MimeList Source #
Methods consumes :: Lens' Swagger MimeList Source #
HasProduces Operation (Maybe MimeList) Source #
Methods produces :: Lens' Operation (Maybe MimeList) Source #
HasConsumes Operation (Maybe MimeList) Source #
Methods consumes :: Lens' Operation (Maybe MimeList) Source #

newtype URL Source #

Constructors

URL
Fields getUrl :: Text

Instances

Eq URL Source #
Methods (==) :: URL -> URL -> Bool # (/=) :: URL -> URL -> Bool #
Data URL Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URL -> c URL # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URL # toConstr :: URL -> Constr # 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 :: (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 #
Ord URL Source #
Methods compare :: URL -> URL -> Ordering # (<) :: URL -> URL -> Bool # (<=) :: URL -> URL -> Bool # (>) :: URL -> URL -> Bool # (>=) :: URL -> URL -> Bool # max :: URL -> URL -> URL # min :: URL -> URL -> URL #
Show URL Source #
Methods showsPrec :: Int -> URL -> ShowS # show :: URL -> String # showList :: [URL] -> ShowS #
ToJSON URL Source #
Methods toJSON :: URL -> Value # toEncoding :: URL -> Encoding # toJSONList :: [URL] -> Value # toEncodingList :: [URL] -> Encoding #
FromJSON URL Source #
Methods parseJSON :: Value -> Parser URL # parseJSONList :: Value -> Parser [URL] #
SwaggerMonoid URL Source #
Methods swaggerMempty :: URL Source # swaggerMappend :: URL -> URL -> URL Source #
HasUrl ExternalDocs URL Source #
Methods url :: Lens' ExternalDocs URL Source #
HasUrl License (Maybe URL) Source #
Methods url :: Lens' License (Maybe URL) Source #
HasUrl Contact (Maybe URL) Source #
Methods url :: Lens' Contact (Maybe URL) Source #

Eq Header Source #
Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
Data Header Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Header -> c Header # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Header # toConstr :: Header -> Constr # dataTypeOf :: Header -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Header) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Header) # gmapT :: (forall b. Data b => b -> b) -> Header -> Header # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r # gmapQr :: (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 #
Show Header Source #
Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
Generic Header Source #
Associated Types type Rep Header :: * -> * # Methods from :: Header -> Rep Header x # to :: Rep Header x -> Header #
Monoid Header Source #
Methods mempty :: Header # mappend :: Header -> Header -> Header # mconcat :: [Header] -> Header #
ToJSON Header Source #
Methods toJSON :: Header -> Value # toEncoding :: Header -> Encoding # toJSONList :: [Header] -> Value # toEncodingList :: [Header] -> Encoding #
FromJSON Header Source #
Methods parseJSON :: Value -> Parser Header # parseJSONList :: Value -> Parser [Header] #
Generic Header Source #
Associated Types type Code Header :: [[*]] # Methods from :: Header -> Rep Header # to :: Rep Header -> Header #
HasDatatypeInfo Header Source #
Methods datatypeInfo :: proxy Header -> DatatypeInfo (Code Header) #
HasSwaggerAesonOptions Header Source #
Methods swaggerAesonOptions :: proxy Header -> SwaggerAesonOptions Source # aesonDefaults :: proxy Header -> POP * Maybe (Code Header) Source #
HasDescription Header (Maybe Text) Source #
Methods description :: Lens' Header (Maybe Text) Source #
HasParamSchema Header (ParamSchema (SwaggerKindNormal * Header)) Source #
Methods paramSchema :: Lens' Header (ParamSchema (SwaggerKindNormal * Header)) Source #
HasType Header (SwaggerType (SwaggerKindNormal * Header)) Source #
Methods type_ :: Lens' Header (SwaggerType (SwaggerKindNormal * Header)) Source #
HasDefault Header (Maybe Value) Source #
Methods default_ :: Lens' Header (Maybe Value) Source #
HasHeaders Response (InsOrdHashMap HeaderName Header) Source #
Methods headers :: Lens' Response (InsOrdHashMap HeaderName Header) Source #
type Rep Header Source #
type Rep Header = D1 (MetaData "Header" "Data.Swagger.Internal" "swagger2-2.1.4.1-IB5cgNouzkAL9WkXeV9lhb" False) (C1 (MetaCons "Header" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_headerDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_headerParamSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParamSchema (SwaggerKindNormal Header))))))
type Code Header Source #
type Code Header = (:) [] ((:) (Maybe Text) ((:) * (ParamSchema (SwaggerKindNormal * Header)) ([] ))) ([] [])

How to use this library

Monoid instances

Lenses and prisms

Schema specification

Manipulation

Validation

Re-exports

Swagger specification

Info types

PathItem

Operations

Types and formats

Parameters

Schemas

Responses

Security

API key

OAuth2

External documentation

References

Miscellaneous

`Monoid` instances