swagger2-2.3.1.1: Swagger 2.0 data model

MaintainerNickolay Kudasov <nickolay@getshoptv.com>
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Data.Swagger

Contents

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:

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 ToJSONToSchema 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 type error

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

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 # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Generic Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Swagger :: Type -> Type #

Methods

from :: Swagger -> Rep Swagger x #

to :: Rep Swagger x -> Swagger #

Semigroup Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code Swagger :: [[Type]] #

HasDatatypeInfo Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf Swagger :: DatatypeInfo #

HasSwaggerAesonOptions Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

HasProduces Swagger MimeList Source # 
Instance details

Defined in Data.Swagger.Lens

HasInfo Swagger Info Source # 
Instance details

Defined in Data.Swagger.Lens

HasConsumes Swagger MimeList Source # 
Instance details

Defined in Data.Swagger.Lens

HasTags Swagger (Set Tag) Source # 
Instance details

Defined in Data.Swagger.Lens

HasSecurityDefinitions Swagger (Definitions SecurityScheme) Source # 
Instance details

Defined in Data.Swagger.Lens

HasSecurity Swagger [SecurityRequirement] Source # 
Instance details

Defined in Data.Swagger.Lens

HasSchemes Swagger (Maybe [Scheme]) Source # 
Instance details

Defined in Data.Swagger.Lens

HasResponses Swagger (Definitions Response) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParameters Swagger (Definitions Param) Source # 
Instance details

Defined in Data.Swagger.Lens

HasHost Swagger (Maybe Host) Source # 
Instance details

Defined in Data.Swagger.Lens

HasExternalDocs Swagger (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDefinitions Swagger (Definitions Schema) Source # 
Instance details

Defined in Data.Swagger.Lens

HasBasePath Swagger (Maybe FilePath) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Swagger = D1 (MetaData "Swagger" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Swagger" PrefixI True) (((S1 (MetaSel (Just "_swaggerInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Info) :*: (S1 (MetaSel (Just "_swaggerHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Host)) :*: S1 (MetaSel (Just "_swaggerBasePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) :*: ((S1 (MetaSel (Just "_swaggerSchemes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Scheme])) :*: S1 (MetaSel (Just "_swaggerConsumes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MimeList)) :*: (S1 (MetaSel (Just "_swaggerProduces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MimeList) :*: S1 (MetaSel (Just "_swaggerPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap FilePath PathItem))))) :*: ((S1 (MetaSel (Just "_swaggerDefinitions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions Schema)) :*: (S1 (MetaSel (Just "_swaggerParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions Param)) :*: S1 (MetaSel (Just "_swaggerResponses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions Response)))) :*: ((S1 (MetaSel (Just "_swaggerSecurityDefinitions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Definitions SecurityScheme)) :*: S1 (MetaSel (Just "_swaggerSecurity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SecurityRequirement])) :*: (S1 (MetaSel (Just "_swaggerTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Tag)) :*: S1 (MetaSel (Just "_swaggerExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs)))))))
type Code Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Swagger Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Swagger = ADT "Data.Swagger.Internal" "Swagger" (Record "Swagger" (FieldInfo "_swaggerInfo" ': (FieldInfo "_swaggerHost" ': (FieldInfo "_swaggerBasePath" ': (FieldInfo "_swaggerSchemes" ': (FieldInfo "_swaggerConsumes" ': (FieldInfo "_swaggerProduces" ': (FieldInfo "_swaggerPaths" ': (FieldInfo "_swaggerDefinitions" ': (FieldInfo "_swaggerParameters" ': (FieldInfo "_swaggerResponses" ': (FieldInfo "_swaggerSecurityDefinitions" ': (FieldInfo "_swaggerSecurity" ': (FieldInfo "_swaggerTags" ': (FieldInfo "_swaggerExternalDocs" ': ([] :: [FieldInfo]))))))))))))))) ': ([] :: [ConstructorInfo]))

data Host Source #

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

Constructors

Host 

Fields

Instances
Eq Host Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Host Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Methods

showsPrec :: Int -> Host -> ShowS #

show :: Host -> String #

showList :: [Host] -> ShowS #

IsString Host Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

fromString :: String -> Host #

Generic Host Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Host :: Type -> Type #

Methods

from :: Host -> Rep Host x #

to :: Rep Host x -> Host #

ToJSON Host Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Host Source # 
Instance details

Defined in Data.Swagger.Internal

HasName Host HostName Source # 
Instance details

Defined in Data.Swagger.Lens

HasHost Swagger (Maybe Host) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPort Host (Maybe PortNumber) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Host Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Host = D1 (MetaData "Host" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Host" PrefixI True) (S1 (MetaSel (Just "_hostName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HostName) :*: S1 (MetaSel (Just "_hostPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe PortNumber))))

data Scheme Source #

The transfer protocol of the API.

Constructors

Http 
Https 
Ws 
Wss 
Instances
Eq Scheme Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Scheme Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Generic Scheme Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Scheme :: Type -> Type #

Methods

from :: Scheme -> Rep Scheme x #

to :: Rep Scheme x -> Scheme #

ToJSON Scheme Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Scheme Source # 
Instance details

Defined in Data.Swagger.Internal

HasSchemes Operation (Maybe [Scheme]) Source # 
Instance details

Defined in Data.Swagger.Lens

HasSchemes Swagger (Maybe [Scheme]) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Scheme Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Scheme = D1 (MetaData "Scheme" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) ((C1 (MetaCons "Http" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Https" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Ws" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Wss" PrefixI False) (U1 :: Type -> Type)))

Info types

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

Instances
Eq Info Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Info Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Info -> Constr #

dataTypeOf :: Info -> DataType #

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

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

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

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

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

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

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

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

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

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

Show Info Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

showsPrec :: Int -> Info -> ShowS #

show :: Info -> String #

showList :: [Info] -> ShowS #

Generic Info Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Info :: Type -> Type #

Methods

from :: Info -> Rep Info x #

to :: Rep Info x -> Info #

Semigroup Info Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

sconcat :: NonEmpty Info -> Info #

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

Monoid Info Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

mempty :: Info #

mappend :: Info -> Info -> Info #

mconcat :: [Info] -> Info #

ToJSON Info Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Info Source # 
Instance details

Defined in Data.Swagger.Internal

AesonDefaultValue Info Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid Info Source # 
Instance details

Defined in Data.Swagger.Internal

HasInfo Swagger Info Source # 
Instance details

Defined in Data.Swagger.Lens

HasVersion Info Text Source # 
Instance details

Defined in Data.Swagger.Lens

HasTitle Info Text Source # 
Instance details

Defined in Data.Swagger.Lens

HasTermsOfService Info (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDescription Info (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Info Source # 
Instance details

Defined in Data.Swagger.Internal

data Contact Source #

Contact information for the exposed API.

Constructors

Contact 

Fields

Instances
Eq Contact Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Contact Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Contact -> Constr #

dataTypeOf :: Contact -> DataType #

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

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

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

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

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

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

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

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

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

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

Show Contact Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Contact Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Contact :: Type -> Type #

Methods

from :: Contact -> Rep Contact x #

to :: Rep Contact x -> Contact #

Semigroup Contact Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid Contact Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON Contact Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Contact Source # 
Instance details

Defined in Data.Swagger.Internal

HasName Contact (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.Swagger.Lens

HasUrl Contact (Maybe URL) Source # 
Instance details

Defined in Data.Swagger.Lens

HasEmail Contact (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Contact Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Contact = D1 (MetaData "Contact" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Contact" PrefixI True) (S1 (MetaSel (Just "_contactName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_contactUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URL)) :*: S1 (MetaSel (Just "_contactEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))

data License Source #

License information for the exposed API.

Constructors

License 

Fields

Instances
Eq License Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data License Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: License -> Constr #

dataTypeOf :: License -> DataType #

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

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

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

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

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

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

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

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

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

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

Show License Source # 
Instance details

Defined in Data.Swagger.Internal

IsString License Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

fromString :: String -> License #

Generic License Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep License :: Type -> Type #

Methods

from :: License -> Rep License x #

to :: Rep License x -> License #

ToJSON License Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON License Source # 
Instance details

Defined in Data.Swagger.Internal

HasName License Text Source # 
Instance details

Defined in Data.Swagger.Lens

HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.Swagger.Lens

HasUrl License (Maybe URL) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep License Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep License = D1 (MetaData "License" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "License" PrefixI True) (S1 (MetaSel (Just "_licenseName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "_licenseUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URL))))

PathItem

data PathItem Source #

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

Constructors

PathItem 

Fields

Instances
Eq PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Data PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: PathItem -> Constr #

dataTypeOf :: PathItem -> DataType #

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

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

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

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

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

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

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

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

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

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

Show PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Generic PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep PathItem :: Type -> Type #

Methods

from :: PathItem -> Rep PathItem x #

to :: Rep PathItem x -> PathItem #

Semigroup PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Generic PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code PathItem :: [[Type]] #

HasDatatypeInfo PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf PathItem :: DatatypeInfo #

HasSwaggerAesonOptions PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.Swagger.Lens

HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.Swagger.Lens

SwaggerMonoid (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

type Code PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

type Code PathItem = (Maybe Operation ': (Maybe Operation ': (Maybe Operation ': (Maybe Operation ': (Maybe Operation ': (Maybe Operation ': (Maybe Operation ': ([Referenced Param] ': ([] :: [Type]))))))))) ': ([] :: [[Type]])
type DatatypeInfoOf PathItem Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf PathItem = ADT "Data.Swagger.Internal" "PathItem" (Record "PathItem" (FieldInfo "_pathItemGet" ': (FieldInfo "_pathItemPut" ': (FieldInfo "_pathItemPost" ': (FieldInfo "_pathItemDelete" ': (FieldInfo "_pathItemOptions" ': (FieldInfo "_pathItemHead" ': (FieldInfo "_pathItemPatch" ': (FieldInfo "_pathItemParameters" ': ([] :: [FieldInfo]))))))))) ': ([] :: [ConstructorInfo]))

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 # 
Instance details

Defined in Data.Swagger.Internal

Data Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Operation -> Constr #

dataTypeOf :: Operation -> DataType #

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

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

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

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

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

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

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

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

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

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

Show Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Operation :: Type -> Type #

Semigroup Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid Operation Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON Operation Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code Operation :: [[Type]] #

HasDatatypeInfo Operation Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf Operation :: DatatypeInfo #

Ixed Operation Source # 
Instance details

Defined in Data.Swagger.Lens

At Operation Source # 
Instance details

Defined in Data.Swagger.Lens

HasSwaggerAesonOptions Operation Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid Operation Source # 
Instance details

Defined in Data.Swagger.Internal

HasResponses Operation Responses Source # 
Instance details

Defined in Data.Swagger.Lens

HasTags Operation (Set TagName) Source # 
Instance details

Defined in Data.Swagger.Lens

HasSecurity Operation [SecurityRequirement] Source # 
Instance details

Defined in Data.Swagger.Lens

HasSchemes Operation (Maybe [Scheme]) Source # 
Instance details

Defined in Data.Swagger.Lens

HasProduces Operation (Maybe MimeList) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.Swagger.Lens

HasExternalDocs Operation (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.Swagger.Lens

HasConsumes Operation (Maybe MimeList) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDescription Operation (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.Swagger.Lens

HasSummary Operation (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasOperationId Operation (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDeprecated Operation (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Operation Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Operation = D1 (MetaData "Operation" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Operation" PrefixI True) (((S1 (MetaSel (Just "_operationTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set TagName)) :*: (S1 (MetaSel (Just "_operationSummary") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_operationDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_operationExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs)) :*: (S1 (MetaSel (Just "_operationOperationId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_operationConsumes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MimeList))))) :*: ((S1 (MetaSel (Just "_operationProduces") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MimeList)) :*: (S1 (MetaSel (Just "_operationParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Referenced Param]) :*: S1 (MetaSel (Just "_operationResponses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Responses))) :*: (S1 (MetaSel (Just "_operationSchemes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Scheme])) :*: (S1 (MetaSel (Just "_operationDeprecated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_operationSecurity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SecurityRequirement]))))))
type Code Operation Source # 
Instance details

Defined in Data.Swagger.Internal

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]))))))))))))) ': ([] :: [[Type]])
type DatatypeInfoOf Operation Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Operation = ADT "Data.Swagger.Internal" "Operation" (Record "Operation" (FieldInfo "_operationTags" ': (FieldInfo "_operationSummary" ': (FieldInfo "_operationDescription" ': (FieldInfo "_operationExternalDocs" ': (FieldInfo "_operationOperationId" ': (FieldInfo "_operationConsumes" ': (FieldInfo "_operationProduces" ': (FieldInfo "_operationParameters" ': (FieldInfo "_operationResponses" ': (FieldInfo "_operationSchemes" ': (FieldInfo "_operationDeprecated" ': (FieldInfo "_operationSecurity" ': ([] :: [FieldInfo]))))))))))))) ': ([] :: [ConstructorInfo]))
type Index Operation Source # 
Instance details

Defined in Data.Swagger.Lens

type IxValue Operation Source # 
Instance details

Defined in Data.Swagger.Lens

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

Instances
Eq Tag Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Tag Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

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 # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

IsString Tag Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

fromString :: String -> Tag #

Generic Tag Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

ToJSON Tag Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Tag Source # 
Instance details

Defined in Data.Swagger.Internal

HasName Tag TagName Source # 
Instance details

Defined in Data.Swagger.Lens

HasTags Swagger (Set Tag) Source # 
Instance details

Defined in Data.Swagger.Lens

HasExternalDocs Tag (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDescription Tag (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Tag Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Tag = D1 (MetaData "Tag" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Tag" PrefixI True) (S1 (MetaSel (Just "_tagName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TagName) :*: (S1 (MetaSel (Just "_tagDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tagExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs)))))

type TagName = Text Source #

Tag name.

Types and formats

data SwaggerType t where Source #

Instances
HasType Header (SwaggerType (SwaggerKindNormal Header)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType NamedSchema (SwaggerType (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType Schema (SwaggerType (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

Eq (SwaggerType t) Source # 
Instance details

Defined in Data.Swagger.Internal

Typeable t => Data (SwaggerType (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 t0 => (forall d. Data d => c (t0 d)) -> Maybe (c (SwaggerType (SwaggerKindNormal t))) #

dataCast2 :: Typeable t0 => (forall d e. (Data d, Data e) => c (t0 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 :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

ToJSON (SwaggerType t) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (SwaggerType (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (SwaggerType (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (SwaggerType (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

AesonDefaultValue (SwaggerType a) Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid (SwaggerType t) Source # 
Instance details

Defined in Data.Swagger.Internal

HasType (ParamSchema t) (SwaggerType t) Source # 
Instance details

Defined in Data.Swagger.Lens

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.

Instances
Eq (CollectionFormat t) Source # 
Instance details

Defined in Data.Swagger.Internal

Data t => Data (CollectionFormat (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 t0 => (forall d. Data d => c (t0 d)) -> Maybe (c (CollectionFormat (SwaggerKindNormal t))) #

dataCast2 :: Typeable t0 => (forall d e. (Data d, Data e) => c (t0 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 :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

ToJSON (CollectionFormat t) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (CollectionFormat (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (CollectionFormat (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Param Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Param -> Constr #

dataTypeOf :: Param -> DataType #

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

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

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

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

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

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

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

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

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

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

Show Param Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

showsPrec :: Int -> Param -> ShowS #

show :: Param -> String #

showList :: [Param] -> ShowS #

Generic Param Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Param :: Type -> Type #

Methods

from :: Param -> Rep Param x #

to :: Rep Param x -> Param #

Semigroup Param Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

sconcat :: NonEmpty Param -> Param #

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

Monoid Param Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

mempty :: Param #

mappend :: Param -> Param -> Param #

mconcat :: [Param] -> Param #

ToJSON Param Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Param Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Param Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code Param :: [[Type]] #

Methods

from :: Param -> Rep Param #

to :: Rep Param -> Param #

HasDatatypeInfo Param Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf Param :: DatatypeInfo #

Methods

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

HasSwaggerAesonOptions Param Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid Param Source # 
Instance details

Defined in Data.Swagger.Internal

HasName Param Text Source # 
Instance details

Defined in Data.Swagger.Lens

HasSchema Param ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Lens

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.Swagger.Lens

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.Swagger.Lens

HasParameters Swagger (Definitions Param) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDescription Param (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasRequired Param (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

ToJSON (Referenced Param) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (Referenced Param) Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Param Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Param = D1 (MetaData "Param" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Param" PrefixI True) ((S1 (MetaSel (Just "_paramName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "_paramDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_paramRequired") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_paramSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamAnySchema))))
type Code Param Source # 
Instance details

Defined in Data.Swagger.Internal

type Code Param = (Text ': (Maybe Text ': (Maybe Bool ': (ParamAnySchema ': ([] :: [Type]))))) ': ([] :: [[Type]])
type DatatypeInfoOf Param Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Param = ADT "Data.Swagger.Internal" "Param" (Record "Param" (FieldInfo "_paramName" ': (FieldInfo "_paramDescription" ': (FieldInfo "_paramRequired" ': (FieldInfo "_paramSchema" ': ([] :: [FieldInfo]))))) ': ([] :: [ConstructorInfo]))

data ParamAnySchema Source #

Instances
Eq ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

Data ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Generic ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep ParamAnySchema :: Type -> Type #

ToJSON ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

AesonDefaultValue ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

HasSchema Param ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep ParamAnySchema Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep ParamAnySchema = D1 (MetaData "ParamAnySchema" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "ParamBody" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Referenced Schema))) :+: C1 (MetaCons "ParamOther" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamOtherSchema)))

data ParamOtherSchema Source #

Constructors

ParamOtherSchema 

Fields

Instances
Eq ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Data ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Generic ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep ParamOtherSchema :: Type -> Type #

Semigroup ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Generic ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code ParamOtherSchema :: [[Type]] #

HasDatatypeInfo ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

HasSwaggerAesonOptions ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

HasIn ParamOtherSchema ParamLocation Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasAllowEmptyValue ParamOtherSchema (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDefault ParamOtherSchema (Maybe Value) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep ParamOtherSchema = D1 (MetaData "ParamOtherSchema" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "ParamOtherSchema" PrefixI True) (S1 (MetaSel (Just "_paramOtherSchemaIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamLocation) :*: (S1 (MetaSel (Just "_paramOtherSchemaAllowEmptyValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_paramOtherSchemaParamSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type))))))
type Code ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf ParamOtherSchema Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf ParamOtherSchema = ADT "Data.Swagger.Internal" "ParamOtherSchema" (Record "ParamOtherSchema" (FieldInfo "_paramOtherSchemaIn" ': (FieldInfo "_paramOtherSchemaAllowEmptyValue" ': (FieldInfo "_paramOtherSchemaParamSchema" ': ([] :: [FieldInfo])))) ': ([] :: [ConstructorInfo]))

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 # 
Instance details

Defined in Data.Swagger.Internal

Data ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: ParamLocation -> Constr #

dataTypeOf :: ParamLocation -> DataType #

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

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

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

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

gmapQr :: (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 # 
Instance details

Defined in Data.Swagger.Internal

Generic ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep ParamLocation :: Type -> Type #

ToJSON ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

AesonDefaultValue ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

HasIn ParamOtherSchema ParamLocation Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep ParamLocation Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep ParamLocation = D1 (MetaData "ParamLocation" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) ((C1 (MetaCons "ParamQuery" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ParamHeader" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "ParamPath" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ParamFormData" PrefixI False) (U1 :: Type -> Type)))

data Header Source #

Constructors

Header 

Fields

Instances
Eq Header Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Header Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Header -> Constr #

dataTypeOf :: Header -> DataType #

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

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

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

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

gmapQr :: (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 # 
Instance details

Defined in Data.Swagger.Internal

Generic Header Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Header :: Type -> Type #

Methods

from :: Header -> Rep Header x #

to :: Rep Header x -> Header #

Semigroup Header Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid Header Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON Header Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Header Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Header Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code Header :: [[Type]] #

Methods

from :: Header -> Rep Header #

to :: Rep Header -> Header #

HasDatatypeInfo Header Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf Header :: DatatypeInfo #

HasSwaggerAesonOptions Header Source # 
Instance details

Defined in Data.Swagger.Internal

HasDescription Header (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema Header (ParamSchema (SwaggerKindNormal Header)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType Header (SwaggerType (SwaggerKindNormal Header)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDefault Header (Maybe Value) Source # 
Instance details

Defined in Data.Swagger.Lens

HasHeaders Response (InsOrdHashMap HeaderName Header) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Header Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Header = D1 (MetaData "Header" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Header" PrefixI True) (S1 (MetaSel (Just "_headerDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_headerParamSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParamSchema (SwaggerKindNormal Header)))))
type Code Header Source # 
Instance details

Defined in Data.Swagger.Internal

type Code Header = (Maybe Text ': (ParamSchema (SwaggerKindNormal Header) ': ([] :: [Type]))) ': ([] :: [[Type]])
type DatatypeInfoOf Header Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Header = ADT "Data.Swagger.Internal" "Header" (Record "Header" (FieldInfo "_headerDescription" ': (FieldInfo "_headerParamSchema" ': ([] :: [FieldInfo]))) ': ([] :: [ConstructorInfo]))

data Example Source #

Constructors

Example 
Instances
Eq Example Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Example Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Example -> Constr #

dataTypeOf :: Example -> DataType #

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

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

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

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

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

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

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

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

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

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

Show Example Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Example Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Example :: Type -> Type #

Methods

from :: Example -> Rep Example x #

to :: Rep Example x -> Example #

Semigroup Example Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid Example Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON Example Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Example Source # 
Instance details

Defined in Data.Swagger.Internal

HasExamples Response (Maybe Example) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep Example Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Example = D1 (MetaData "Example" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Example" PrefixI True) (S1 (MetaSel (Just "getExample") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map MediaType Value))))

Schemas

data ParamSchema (t :: SwaggerKind *) Source #

Constructors

ParamSchema 

Fields

Instances
HasParamSchema Header (ParamSchema (SwaggerKindNormal Header)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema NamedSchema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema Schema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

Eq (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

(Typeable k, Data (SwaggerType k), Data (SwaggerItems k)) => Data (ParamSchema k) Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

Generic (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep (ParamSchema t) :: Type -> Type #

Methods

from :: ParamSchema t -> Rep (ParamSchema t) x #

to :: Rep (ParamSchema t) x -> ParamSchema t #

Semigroup (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON (ParamSchema k) Source # 
Instance details

Defined in Data.Swagger.Internal

(FromJSON (SwaggerType (SwaggerKindNormal t)), FromJSON (SwaggerItems (SwaggerKindNormal t))) => FromJSON (ParamSchema (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

Generic (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code (ParamSchema t) :: [[Type]] #

Methods

from :: ParamSchema t -> Rep (ParamSchema t) #

to :: Rep (ParamSchema t) -> ParamSchema t #

HasDatatypeInfo (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf (ParamSchema t) :: DatatypeInfo #

Methods

datatypeInfo :: proxy (ParamSchema t) -> DatatypeInfo (Code (ParamSchema t)) #

AesonDefaultValue (ParamSchema s) Source # 
Instance details

Defined in Data.Swagger.Internal

HasSwaggerAesonOptions (ParamSchema (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

HasSwaggerAesonOptions (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

HasSwaggerAesonOptions (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

HasUniqueItems (ParamSchema t) (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType (ParamSchema t) (SwaggerType t) Source # 
Instance details

Defined in Data.Swagger.Lens

HasPattern (ParamSchema t) (Maybe Pattern) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMultipleOf (ParamSchema t) (Maybe Scientific) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMinimum (ParamSchema t) (Maybe Scientific) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMinLength (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMinItems (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMaximum (ParamSchema t) (Maybe Scientific) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMaxLength (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMaxItems (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

HasItems (ParamSchema t) (Maybe (SwaggerItems t)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasFormat (ParamSchema t) (Maybe Format) Source # 
Instance details

Defined in Data.Swagger.Lens

HasExclusiveMinimum (ParamSchema t) (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

HasExclusiveMaximum (ParamSchema t) (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

HasEnum (ParamSchema t) (Maybe [Value]) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDefault (ParamSchema t) (Maybe Value) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep (ParamSchema t) = D1 (MetaData "ParamSchema" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "ParamSchema" PrefixI True) ((((S1 (MetaSel (Just "_paramSchemaDefault") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Value)) :*: S1 (MetaSel (Just "_paramSchemaType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (SwaggerType t))) :*: (S1 (MetaSel (Just "_paramSchemaFormat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Format)) :*: S1 (MetaSel (Just "_paramSchemaItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (SwaggerItems t))))) :*: ((S1 (MetaSel (Just "_paramSchemaMaximum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Scientific)) :*: S1 (MetaSel (Just "_paramSchemaExclusiveMaximum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_paramSchemaMinimum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Scientific)) :*: S1 (MetaSel (Just "_paramSchemaExclusiveMinimum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))))) :*: (((S1 (MetaSel (Just "_paramSchemaMaxLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_paramSchemaMinLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 (MetaSel (Just "_paramSchemaPattern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Pattern)) :*: S1 (MetaSel (Just "_paramSchemaMaxItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)))) :*: ((S1 (MetaSel (Just "_paramSchemaMinItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_paramSchemaUniqueItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_paramSchemaEnum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Value])) :*: S1 (MetaSel (Just "_paramSchemaMultipleOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Scientific)))))))
type Code (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

type Code (ParamSchema t) = (Maybe Value ': (SwaggerType t ': (Maybe Format ': (Maybe (SwaggerItems t) ': (Maybe Scientific ': (Maybe Bool ': (Maybe Scientific ': (Maybe Bool ': (Maybe Integer ': (Maybe Integer ': (Maybe Pattern ': (Maybe Integer ': (Maybe Integer ': (Maybe Bool ': (Maybe [Value] ': (Maybe Scientific ': ([] :: [Type]))))))))))))))))) ': ([] :: [[Type]])
type DatatypeInfoOf (ParamSchema t) Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf (ParamSchema t) = ADT "Data.Swagger.Internal" "ParamSchema" (Record "ParamSchema" (FieldInfo "_paramSchemaDefault" ': (FieldInfo "_paramSchemaType" ': (FieldInfo "_paramSchemaFormat" ': (FieldInfo "_paramSchemaItems" ': (FieldInfo "_paramSchemaMaximum" ': (FieldInfo "_paramSchemaExclusiveMaximum" ': (FieldInfo "_paramSchemaMinimum" ': (FieldInfo "_paramSchemaExclusiveMinimum" ': (FieldInfo "_paramSchemaMaxLength" ': (FieldInfo "_paramSchemaMinLength" ': (FieldInfo "_paramSchemaPattern" ': (FieldInfo "_paramSchemaMaxItems" ': (FieldInfo "_paramSchemaMinItems" ': (FieldInfo "_paramSchemaUniqueItems" ': (FieldInfo "_paramSchemaEnum" ': (FieldInfo "_paramSchemaMultipleOf" ': ([] :: [FieldInfo]))))))))))))))))) ': ([] :: [ConstructorInfo]))

data Schema Source #

Instances
Eq Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: Schema -> Constr #

dataTypeOf :: Schema -> DataType #

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

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

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

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

gmapQr :: (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 # 
Instance details

Defined in Data.Swagger.Internal

Generic Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Schema :: Type -> Type #

Methods

from :: Schema -> Rep Schema x #

to :: Rep Schema x -> Schema #

Semigroup Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Monoid Schema Source # 
Instance details

Defined in Data.Swagger.Internal

ToJSON Schema Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Generic Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Code Schema :: [[Type]] #

Methods

from :: Schema -> Rep Schema #

to :: Rep Schema -> Schema #

HasDatatypeInfo Schema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type DatatypeInfoOf Schema :: DatatypeInfo #

HasSwaggerAesonOptions Schema Source # 
Instance details

Defined in Data.Swagger.Internal

SwaggerMonoid Schema Source # 
Instance details

Defined in Data.Swagger.Internal

HasSchema NamedSchema Schema Source # 
Instance details

Defined in Data.Swagger.Lens

HasExternalDocs Schema (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDefinitions Swagger (Definitions Schema) Source # 
Instance details

Defined in Data.Swagger.Lens

HasTitle Schema (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDescription Schema (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

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

Defined in Data.Swagger.Lens

HasRequired Schema [ParamName] Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema Schema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasXml Schema (Maybe Xml) Source # 
Instance details

Defined in Data.Swagger.Lens

HasReadOnly Schema (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMinProperties Schema (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

HasMaxProperties Schema (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

HasExample Schema (Maybe Value) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDiscriminator Schema (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasAllOf Schema (Maybe [Referenced Schema]) Source # 
Instance details

Defined in Data.Swagger.Lens

HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType Schema (SwaggerType (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasDefault Schema (Maybe Value) Source # 
Instance details

Defined in Data.Swagger.Lens

HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source # 
Instance details

Defined in Data.Swagger.Lens

ToJSON (Referenced Schema) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (Referenced Schema) Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Schema Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep Schema = D1 (MetaData "Schema" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "Schema" PrefixI True) (((S1 (MetaSel (Just "_schemaTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_schemaDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_schemaRequired") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ParamName]))) :*: ((S1 (MetaSel (Just "_schemaAllOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Referenced Schema])) :*: S1 (MetaSel (Just "_schemaProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Schema)))) :*: (S1 (MetaSel (Just "_schemaAdditionalProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe AdditionalProperties)) :*: S1 (MetaSel (Just "_schemaDiscriminator") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_schemaReadOnly") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_schemaXml") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Xml)) :*: S1 (MetaSel (Just "_schemaExternalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocs)))) :*: ((S1 (MetaSel (Just "_schemaExample") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Value)) :*: S1 (MetaSel (Just "_schemaMaxProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 (MetaSel (Just "_schemaMinProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_schemaParamSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParamSchema (SwaggerKindSchema :: SwaggerKind Type))))))))
type Code Schema Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Schema Source # 
Instance details

Defined in Data.Swagger.Internal

type DatatypeInfoOf Schema = ADT "Data.Swagger.Internal" "Schema" (Record "Schema" (FieldInfo "_schemaTitle" ': (FieldInfo "_schemaDescription" ': (FieldInfo "_schemaRequired" ': (FieldInfo "_schemaAllOf" ': (FieldInfo "_schemaProperties" ': (FieldInfo "_schemaAdditionalProperties" ': (FieldInfo "_schemaDiscriminator" ': (FieldInfo "_schemaReadOnly" ': (FieldInfo "_schemaXml" ': (FieldInfo "_schemaExternalDocs" ': (FieldInfo "_schemaExample" ': (FieldInfo "_schemaMaxProperties" ': (FieldInfo "_schemaMinProperties" ': (FieldInfo "_schemaParamSchema" ': ([] :: [FieldInfo]))))))))))))))) ': ([] :: [ConstructorInfo]))

data NamedSchema Source #

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

Instances
Eq NamedSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Data NamedSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

toConstr :: NamedSchema -> Constr #

dataTypeOf :: NamedSchema -> DataType #

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

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

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

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

gmapQr :: (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 # 
Instance details

Defined in Data.Swagger.Internal

Generic NamedSchema Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep NamedSchema :: Type -> Type #

HasSchema NamedSchema Schema Source # 
Instance details

Defined in Data.Swagger.Lens

HasName NamedSchema (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasParamSchema NamedSchema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

HasType NamedSchema (SwaggerType (SwaggerKindSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Lens

type Rep NamedSchema Source # 
Instance details

Defined in Data.Swagger.Internal

type Rep NamedSchema = D1 (MetaData "NamedSchema" "Data.Swagger.Internal" "swagger2-2.3.1.1-HnOoc3Duc6IA7Ce1Ri8TAc" False) (C1 (MetaCons "NamedSchema" PrefixI True) (S1 (MetaSel (Just "_namedSchemaName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_namedSchemaSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema)))

data SwaggerItems t 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.

Instances
HasParamSchema s (ParamSchema t) => HasItems s (Maybe (SwaggerItems t)) Source # 
Instance details

Defined in Data.Swagger.Lens

Methods

items :: Lens' s (Maybe (SwaggerItems t)) Source #

Eq (SwaggerItems t) Source # 
Instance details

Defined in Data.Swagger.Internal

Data t => Data (SwaggerItems (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 t0 => (forall d. Data d => c (t0 d)) -> Maybe (c (SwaggerItems (SwaggerKindNormal t))) #

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

gmapT :: (forall b. Data b => b -> b) -> SwaggerItems (SwaggerKindNormal t) -> SwaggerItems (SwaggerKindNormal t) #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems (SwaggerKindNormal t) -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SwaggerItems (SwaggerKindNormal t) -> r #

gmapQ :: (forall d. Data d => d -> u) -> SwaggerItems (SwaggerKindNormal t) -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SwaggerItems (SwaggerKindNormal t) -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SwaggerItems (SwaggerKindNormal t) -> m (SwaggerItems (SwaggerKindNormal t)) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems (SwaggerKindNormal t) -> m (SwaggerItems (SwaggerKindNormal t)) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SwaggerItems (SwaggerKindNormal t) -> m (SwaggerItems (SwaggerKindNormal t)) #

Data (SwaggerItems (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

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 # 
Instance details

Defined in Data.Swagger.Internal

ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) Source #

As for nullary schema for 0-arity type constructors, see https://github.com/GetShopTV/swagger2/issues/167.

>>> encode (SwaggerItemsArray [])
"{\"example\":[],\"items\":{},\"maxItems\":0}"
Instance details

Defined in Data.Swagger.Internal

(FromJSON (CollectionFormat (SwaggerKindNormal t)), FromJSON (ParamSchema (SwaggerKindNormal t))) => FromJSON (SwaggerItems (SwaggerKindNormal t)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (SwaggerItems (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON (SwaggerItems (SwaggerKindSchema :: SwaggerKind Type)) Source #
>>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
Just (SwaggerItemsArray [])
>>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
>>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
Instance details

Defined in Data.Swagger.Internal

HasItems (ParamSchema t) (Maybe (SwaggerItems t)) Source # 
Instance details

Defined in Data.Swagger.Lens

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 # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

Data Xml Source # 
Instance details

Defined in Data.Swagger.Internal

Methods

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

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

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 # 
Instance details

Defined in Data.Swagger.Internal

Methods

showsPrec :: Int -> Xml -> ShowS #

show :: Xml -> String #

showList :: [Xml] -> ShowS #

Generic Xml Source # 
Instance details

Defined in Data.Swagger.Internal

Associated Types

type Rep Xml :: Type -> Type #

Methods

from :: Xml -> Rep Xml x #

to :: Rep Xml x -> Xml #

ToJSON Xml Source # 
Instance details

Defined in Data.Swagger.Internal

FromJSON Xml Source # 
Instance details

Defined in Data.Swagger.Internal

HasName Xml (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasXml Schema (Maybe Xml) Source # 
Instance details

Defined in Data.Swagger.Lens

Methods

xml ::