Data.OpenApi

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.

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:

>>> BSL.putStrLn $ encode (mempty :: OpenApi)
{"openapi":"3.0.0","info":{"version":"","title":""},"components":{}}

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:

>>> BSL.putStrLn $ 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 (<>):

>>> BSL.putStrLn $ 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 :: OpenApi

-- /task subAPI specification
taskAPI :: OpenApi

-- while API specification is just a combination
-- of subAPIs' specifications
api :: OpenApi
api = accountAPI <> taskAPI

Lenses and prisms

Note: if you're working with the optics library, take a look at Data.OpenApi.Optics.

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:

>>> :{
BSL.putStrLn $ encode $ (mempty :: OpenApi)
  & components . schemas .~ [ ("User", mempty & type_ ?~ OpenApiString) ]
  & paths .~
    [ ("/user", mempty & get ?~ (mempty
        & at 200 ?~ ("OK" & _Inline.content.at "application/json" ?~ (mempty & schema ?~ Ref (Reference "User")))
        & at 404 ?~ "User info not found")) ]
:}
{"openapi":"3.0.0","info":{"version":"","title":""},"paths":{"/user":{"get":{"responses":{"404":{"description":"User info not found"},"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"}}}}},"components":{"schemas":{"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:

>>> BSL.putStrLn $ encode $ (mempty :: Response) & description .~ "No content"
{"description":"No content"}
>>> :{
BSL.putStrLn $ encode $ (mempty :: Schema)
  & type_       ?~ OpenApiBoolean
  & description ?~ "To be or not to be"
:}
{"type":"boolean","description":"To be or not to be"}

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

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

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

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

Schema specification

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

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

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

In most cases you will have a Haskell data type for which you would like to define a corresponding schema. To facilitate this use case swagger2 provides two classes for schema encoding. Both these classes provide means to encode types as Swagger schemas.

ToParamSchema is intended to be used for primitive API endpoint parameters, such as query parameters, headers and URL path pieces. Its corresponding value-encoding class is ToHttpApiData (from http-api-data package).

ToSchema is used for request and response bodies and mostly differ from primitive parameters by allowing objects/mappings in addition to primitive types and arrays. Its corresponding value-encoding class is ToJSON (from aeson package).

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

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

Here's an example showing ToJSON–ToSchema correspondance:

>>> data Person = Person { name :: String, age :: Integer } deriving Generic
>>> instance ToJSON Person
>>> instance ToSchema Person
>>> BSL.putStrLn $ encode (Person "David" 28)
{"age":28,"name":"David"}
>>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy Person)
{"required":["name","age"],"type":"object","properties":{"age":{"type":"integer"},"name":{"type":"string"}}}

This package implements OpenAPI 3.0 spec, which supports oneOf in schemas, allowing any sum types to be faithfully represented. All sum encodings supported by aeson are supported here as well, with an exception of TwoElemArray, since OpenAPI spec does not support heterogeneous arrays.

An example with TaggedObject encoding:

>>> data Error = ErrorNoUser { userId :: Int } | ErrorAccessDenied { requiredPermission :: String } deriving Generic
>>> instance ToJSON Error
>>> instance ToSchema Error
>>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy Error)
{"oneOf":[{"required":["userId","tag"],"type":"object","properties":{"tag":{"type":"string","enum":["ErrorNoUser"]},"userId":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}},{"required":["requiredPermission","tag"],"type":"object","properties":{"tag":{"type":"string","enum":["ErrorAccessDenied"]},"requiredPermission":{"type":"string"}}}],"type":"object"}

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.OpenApi.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.OpenApi.Schema.Validation addresses ToJSON/ToSchema validation.

Re-exports

module Data.OpenApi.Lens

module Data.OpenApi.Operation

module Data.OpenApi.ParamSchema

module Data.OpenApi.Schema

module Data.OpenApi.Schema.Validation

Swagger specification

data OpenApi

This is the root document object for the API specification.

Constructors

OpenApi

Fields

• _openApiInfo :: Info

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

• _openApiServers :: [Server]

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

• _openApiPaths :: InsOrdHashMap FilePath PathItem

  The available paths and operations for the API.

• _openApiComponents :: Components

  An element to hold various schemas for the specification.

• _openApiSecurity :: [SecurityRequirement]

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

• _openApiTags :: InsOrdHashSet Tag

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

• _openApiExternalDocs :: Maybe ExternalDocs

  Additional external documentation.

Instances

Eq OpenApi

Defined in Data.OpenApi.Internal

Methods

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

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

Data OpenApi

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OpenApi -> Constr

dataTypeOf :: OpenApi -> DataType

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

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

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

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

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

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

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

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

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

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

Show OpenApi

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OpenApi -> ShowS

show :: OpenApi -> String

showList :: [OpenApi] -> ShowS

Generic OpenApi

Defined in Data.OpenApi.Internal

Associated Types

type Rep OpenApi :: Type -> Type

Methods

from :: OpenApi -> Rep OpenApi x

to :: Rep OpenApi x -> OpenApi

Semigroup OpenApi

Defined in Data.OpenApi.Internal

Methods

(<>) :: OpenApi -> OpenApi -> OpenApi

sconcat :: NonEmpty OpenApi -> OpenApi

stimes :: Integral b => b -> OpenApi -> OpenApi

Monoid OpenApi

Defined in Data.OpenApi.Internal

Methods

mempty :: OpenApi

mappend :: OpenApi -> OpenApi -> OpenApi

mconcat :: [OpenApi] -> OpenApi

ToJSON OpenApi

Defined in Data.OpenApi.Internal

Methods

toJSON :: OpenApi -> Value

toEncoding :: OpenApi -> Encoding

toJSONList :: [OpenApi] -> Value

toEncodingList :: [OpenApi] -> Encoding

FromJSON OpenApi

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OpenApi

parseJSONList :: Value -> Parser [OpenApi]

Generic OpenApi

Defined in Data.OpenApi.Internal

Associated Types

type Code OpenApi :: [[Type]]

Methods

from :: OpenApi -> Rep OpenApi

to :: Rep OpenApi -> OpenApi

HasDatatypeInfo OpenApi

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf OpenApi :: DatatypeInfo

Methods

datatypeInfo :: proxy OpenApi -> DatatypeInfo (Code OpenApi)

HasSwaggerAesonOptions OpenApi

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy OpenApi -> SwaggerAesonOptions

aesonDefaults :: Proxy OpenApi -> POP Maybe (Code OpenApi)

HasInfo OpenApi Info

Defined in Data.OpenApi.Lens

Methods

info :: Lens' OpenApi Info

HasComponents OpenApi Components

Defined in Data.OpenApi.Lens

Methods

components :: Lens' OpenApi Components

(k ~ A_Lens, a ~ Components, b ~ Components) => LabelOptic "components" k OpenApi OpenApi a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

(k ~ A_Lens, a ~ Info, b ~ Info) => LabelOptic "info" k OpenApi OpenApi a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OpenApi OpenApi a b

HasTags OpenApi (InsOrdHashSet Tag)

Defined in Data.OpenApi.Lens

Methods

tags :: Lens' OpenApi (InsOrdHashSet Tag)

HasServers OpenApi [Server]

Defined in Data.OpenApi.Lens

Methods

servers :: Lens' OpenApi [Server]

HasSecurity OpenApi [SecurityRequirement]

Defined in Data.OpenApi.Lens

Methods

security :: Lens' OpenApi [SecurityRequirement]

HasExternalDocs OpenApi (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' OpenApi (Maybe ExternalDocs)

HasPaths OpenApi (InsOrdHashMap FilePath PathItem)

Defined in Data.OpenApi.Lens

Methods

paths :: Lens' OpenApi (InsOrdHashMap FilePath PathItem)

type Rep OpenApi

Defined in Data.OpenApi.Internal

type Rep OpenApi = D1 ('MetaData "OpenApi" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "OpenApi" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_openApiInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Info) :*: (S1 ('MetaSel ('Just "_openApiServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Server]) :*: S1 ('MetaSel ('Just "_openApiPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap FilePath PathItem)))) :*: ((S1 ('MetaSel ('Just "_openApiComponents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Components) :*: S1 ('MetaSel ('Just "_openApiSecurity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SecurityRequirement])) :*: (S1 ('MetaSel ('Just "_openApiTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashSet Tag)) :*: S1 ('MetaSel ('Just "_openApiExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs))))))

type Code OpenApi

Defined in Data.OpenApi.Internal

type Code OpenApi = '['[Info, [Server], InsOrdHashMap FilePath PathItem, Components, [SecurityRequirement], InsOrdHashSet Tag, Maybe ExternalDocs]]

type DatatypeInfoOf OpenApi

Defined in Data.OpenApi.Internal

type DatatypeInfoOf OpenApi = 'ADT "Data.OpenApi.Internal" "OpenApi" '['Record "OpenApi" '['FieldInfo "_openApiInfo", 'FieldInfo "_openApiServers", 'FieldInfo "_openApiPaths", 'FieldInfo "_openApiComponents", 'FieldInfo "_openApiSecurity", 'FieldInfo "_openApiTags", 'FieldInfo "_openApiExternalDocs"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data Server

An object representing a Server.

Constructors

Server

Fields

• _serverUrl :: Text

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

• _serverDescription :: Maybe Text

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

• _serverVariables :: InsOrdHashMap Text ServerVariable

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

Instances

Eq Server

Defined in Data.OpenApi.Internal

Methods

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

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

Data Server

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Server -> Constr

dataTypeOf :: Server -> DataType

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

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

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

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

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

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

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

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

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

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

Show Server

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Server -> ShowS

show :: Server -> String

showList :: [Server] -> ShowS

IsString Server

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Server

Generic Server

Defined in Data.OpenApi.Internal

Associated Types

type Rep Server :: Type -> Type

Methods

from :: Server -> Rep Server x

to :: Rep Server x -> Server

ToJSON Server

Defined in Data.OpenApi.Internal

Methods

toJSON :: Server -> Value

toEncoding :: Server -> Encoding

toJSONList :: [Server] -> Value

toEncodingList :: [Server] -> Encoding

FromJSON Server

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Server

parseJSONList :: Value -> Parser [Server]

Generic Server

Defined in Data.OpenApi.Internal

Associated Types

type Code Server :: [[Type]]

Methods

from :: Server -> Rep Server

to :: Rep Server -> Server

HasDatatypeInfo Server

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Server :: DatatypeInfo

Methods

datatypeInfo :: proxy Server -> DatatypeInfo (Code Server)

AesonDefaultValue Server

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Server

HasSwaggerAesonOptions Server

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Server -> SwaggerAesonOptions

aesonDefaults :: Proxy Server -> POP Maybe (Code Server)

HasUrl Server Text

Defined in Data.OpenApi.Lens

Methods

url :: Lens' Server Text

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Server Server a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k Server Server a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Server Server a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Server Server a b

HasServers Operation [Server]

Defined in Data.OpenApi.Lens

Methods

servers :: Lens' Operation [Server]

HasServers PathItem [Server]

Defined in Data.OpenApi.Lens

Methods

servers :: Lens' PathItem [Server]

HasServers OpenApi [Server]

Defined in Data.OpenApi.Lens

Methods

servers :: Lens' OpenApi [Server]

HasDescription Server (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Server (Maybe Text)

HasServer Link (Maybe Server)

Defined in Data.OpenApi.Lens

Methods

server :: Lens' Link (Maybe Server)

HasVariables Server (InsOrdHashMap Text ServerVariable)

Defined in Data.OpenApi.Lens

Methods

variables :: Lens' Server (InsOrdHashMap Text ServerVariable)

type Rep Server

Defined in Data.OpenApi.Internal

type Rep Server = D1 ('MetaData "Server" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Server" 'PrefixI 'True) (S1 ('MetaSel ('Just "_serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_serverDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_serverVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text ServerVariable)))))

type Code Server

Defined in Data.OpenApi.Internal

type Code Server = '['[Text, Maybe Text, InsOrdHashMap Text ServerVariable]]

type DatatypeInfoOf Server

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Server = 'ADT "Data.OpenApi.Internal" "Server" '['Record "Server" '['FieldInfo "_serverUrl", 'FieldInfo "_serverDescription", 'FieldInfo "_serverVariables"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data ServerVariable

Constructors

ServerVariable

Fields

• _serverVariableEnum :: Maybe (InsOrdHashSet Text)

  An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.

• _serverVariableDefault :: Text

  The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the 'Schema Object's treatment of default values, because in those cases parameter values are optional. If the _serverVariableEnum is defined, the value SHOULD exist in the enum's values.

• _serverVariableDescription :: Maybe Text

  An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.

Instances

Eq ServerVariable

Defined in Data.OpenApi.Internal

Methods

(==) :: ServerVariable -> ServerVariable -> Bool

(/=) :: ServerVariable -> ServerVariable -> Bool

Data ServerVariable

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: ServerVariable -> Constr

dataTypeOf :: ServerVariable -> DataType

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

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

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

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

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

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

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

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

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

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

Show ServerVariable

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> ServerVariable -> ShowS

show :: ServerVariable -> String

showList :: [ServerVariable] -> ShowS

Generic ServerVariable

Defined in Data.OpenApi.Internal

Associated Types

type Rep ServerVariable :: Type -> Type

Methods

from :: ServerVariable -> Rep ServerVariable x

to :: Rep ServerVariable x -> ServerVariable

ToJSON ServerVariable

Defined in Data.OpenApi.Internal

Methods

toJSON :: ServerVariable -> Value

toEncoding :: ServerVariable -> Encoding

toJSONList :: [ServerVariable] -> Value

toEncodingList :: [ServerVariable] -> Encoding

FromJSON ServerVariable

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser ServerVariable

parseJSONList :: Value -> Parser [ServerVariable]

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "default" k ServerVariable ServerVariable a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx ServerVariable ServerVariable a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx ServerVariable ServerVariable a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx ServerVariable ServerVariable a b

HasVariables Server (InsOrdHashMap Text ServerVariable)

Defined in Data.OpenApi.Lens

Methods

variables :: Lens' Server (InsOrdHashMap Text ServerVariable)

type Rep ServerVariable

Defined in Data.OpenApi.Internal

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

data Components

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

Constructors

Components

Fields

• _componentsSchemas :: Definitions Schema
• _componentsResponses :: Definitions Response
• _componentsParameters :: Definitions Param
• _componentsExamples :: Definitions Example
• _componentsRequestBodies :: Definitions RequestBody
• _componentsHeaders :: Definitions Header
• _componentsSecuritySchemes :: Definitions SecurityScheme
• _componentsLinks :: Definitions Link
• _componentsCallbacks :: Definitions Callback

Instances

Eq Components

Defined in Data.OpenApi.Internal

Methods

(==) :: Components -> Components -> Bool

(/=) :: Components -> Components -> Bool

Data Components

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Components -> Constr

dataTypeOf :: Components -> DataType

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

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

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

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

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

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

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

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

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

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

Show Components

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Components -> ShowS

show :: Components -> String

showList :: [Components] -> ShowS

Generic Components

Defined in Data.OpenApi.Internal

Associated Types

type Rep Components :: Type -> Type

Methods

from :: Components -> Rep Components x

to :: Rep Components x -> Components

Semigroup Components

Defined in Data.OpenApi.Internal

Methods

(<>) :: Components -> Components -> Components

sconcat :: NonEmpty Components -> Components

stimes :: Integral b => b -> Components -> Components

Monoid Components

Defined in Data.OpenApi.Internal

Methods

mempty :: Components

mappend :: Components -> Components -> Components

mconcat :: [Components] -> Components

ToJSON Components

Defined in Data.OpenApi.Internal

Methods

toJSON :: Components -> Value

toEncoding :: Components -> Encoding

toJSONList :: [Components] -> Value

toEncodingList :: [Components] -> Encoding

FromJSON Components

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Components

parseJSONList :: Value -> Parser [Components]

Generic Components

Defined in Data.OpenApi.Internal

Associated Types

type Code Components :: [[Type]]

Methods

from :: Components -> Rep Components

to :: Rep Components -> Components

HasDatatypeInfo Components

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Components :: DatatypeInfo

Methods

datatypeInfo :: proxy Components -> DatatypeInfo (Code Components)

AesonDefaultValue Components

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Components

HasSwaggerAesonOptions Components

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Components -> SwaggerAesonOptions

aesonDefaults :: Proxy Components -> POP Maybe (Code Components)

SwaggerMonoid Components

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Components

swaggerMappend :: Components -> Components -> Components

HasComponents OpenApi Components

Defined in Data.OpenApi.Lens

Methods

components :: Lens' OpenApi Components

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Components Components a b

HasSecuritySchemes Components (Definitions SecurityScheme)

Defined in Data.OpenApi.Lens

Methods

securitySchemes :: Lens' Components (Definitions SecurityScheme)

HasSchemas Components (Definitions Schema)

Defined in Data.OpenApi.Lens

Methods

schemas :: Lens' Components (Definitions Schema)

HasResponses Components (Definitions Response)

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Components (Definitions Response)

HasRequestBodies Components (Definitions RequestBody)

Defined in Data.OpenApi.Lens

Methods

requestBodies :: Lens' Components (Definitions RequestBody)

HasParameters Components (Definitions Param)

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' Components (Definitions Param)

HasLinks Components (Definitions Link)

Defined in Data.OpenApi.Lens

Methods

links :: Lens' Components (Definitions Link)

HasHeaders Components (Definitions Header)

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Components (Definitions Header)

HasExamples Components (Definitions Example)

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Components (Definitions Example)

HasCallbacks Components (Definitions Callback)

Defined in Data.OpenApi.Lens

Methods

callbacks :: Lens' Components (Definitions Callback)

type Rep Components

Defined in Data.OpenApi.Internal

type Rep Components = D1 ('MetaData "Components" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Components" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_componentsSchemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Schema)) :*: S1 ('MetaSel ('Just "_componentsResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Response))) :*: (S1 ('MetaSel ('Just "_componentsParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Param)) :*: S1 ('MetaSel ('Just "_componentsExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Example)))) :*: ((S1 ('MetaSel ('Just "_componentsRequestBodies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions RequestBody)) :*: S1 ('MetaSel ('Just "_componentsHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Header))) :*: (S1 ('MetaSel ('Just "_componentsSecuritySchemes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions SecurityScheme)) :*: (S1 ('MetaSel ('Just "_componentsLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Link)) :*: S1 ('MetaSel ('Just "_componentsCallbacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions Callback)))))))

type Code Components

Defined in Data.OpenApi.Internal

type Code Components = '['[Definitions Schema, Definitions Response, Definitions Param, Definitions Example, Definitions RequestBody, Definitions Header, Definitions SecurityScheme, Definitions Link, Definitions Callback]]

type DatatypeInfoOf Components

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Components = 'ADT "Data.OpenApi.Internal" "Components" '['Record "Components" '['FieldInfo "_componentsSchemas", 'FieldInfo "_componentsResponses", 'FieldInfo "_componentsParameters", 'FieldInfo "_componentsExamples", 'FieldInfo "_componentsRequestBodies", 'FieldInfo "_componentsHeaders", 'FieldInfo "_componentsSecuritySchemes", 'FieldInfo "_componentsLinks", 'FieldInfo "_componentsCallbacks"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

Info types

data Info

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

Constructors

Info

Fields

• _infoTitle :: Text

  The title of the API.

• _infoDescription :: Maybe Text

  A short description of the API. CommonMark syntax MAY be used for rich text representation.

• _infoTermsOfService :: Maybe Text

  A URL to the Terms of Service for the API. MUST be in the format of a URL.

• _infoContact :: Maybe Contact

  The contact information for the exposed API.

• _infoLicense :: Maybe License

  The license information for the exposed API.

• _infoVersion :: Text

  The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

Instances

Eq Info

Defined in Data.OpenApi.Internal

Methods

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

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

Data Info

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Info -> Constr

dataTypeOf :: Info -> DataType

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

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

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

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

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

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

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

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

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

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

Show Info

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Info -> ShowS

show :: Info -> String

showList :: [Info] -> ShowS

Generic Info

Defined in Data.OpenApi.Internal

Associated Types

type Rep Info :: Type -> Type

Methods

from :: Info -> Rep Info x

to :: Rep Info x -> Info

Semigroup Info

Defined in Data.OpenApi.Internal

Methods

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

sconcat :: NonEmpty Info -> Info

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

Monoid Info

Defined in Data.OpenApi.Internal

Methods

mempty :: Info

mappend :: Info -> Info -> Info

mconcat :: [Info] -> Info

ToJSON Info

Defined in Data.OpenApi.Internal

Methods

toJSON :: Info -> Value

toEncoding :: Info -> Encoding

toJSONList :: [Info] -> Value

toEncodingList :: [Info] -> Encoding

FromJSON Info

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Info

parseJSONList :: Value -> Parser [Info]

AesonDefaultValue Info

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Info

SwaggerMonoid Info

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Info

swaggerMappend :: Info -> Info -> Info

HasInfo OpenApi Info

Defined in Data.OpenApi.Lens

Methods

info :: Lens' OpenApi Info

HasVersion Info Text

Defined in Data.OpenApi.Lens

Methods

version :: Lens' Info Text

HasTitle Info Text

Defined in Data.OpenApi.Lens

Methods

title :: Lens' Info Text

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "title" k Info Info a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "version" k Info Info a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b

HasDescription Info (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Info (Maybe Text)

HasTermsOfService Info (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

termsOfService :: Lens' Info (Maybe Text)

HasLicense Info (Maybe License)

Defined in Data.OpenApi.Lens

Methods

license :: Lens' Info (Maybe License)

HasContact Info (Maybe Contact)

Defined in Data.OpenApi.Lens

Methods

contact :: Lens' Info (Maybe Contact)

type Rep Info

Defined in Data.OpenApi.Internal

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

data Contact

Contact information for the exposed API.

Constructors

Contact

Fields

• _contactName :: Maybe Text

  The identifying name of the contact person/organization.

• _contactUrl :: Maybe URL

  The URL pointing to the contact information.

• _contactEmail :: Maybe Text

  The email address of the contact person/organization.

Instances

Eq Contact

Defined in Data.OpenApi.Internal

Methods

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

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

Data Contact

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Contact -> Constr

dataTypeOf :: Contact -> DataType

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

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

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

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

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

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

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

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

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

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

Show Contact

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Contact -> ShowS

show :: Contact -> String

showList :: [Contact] -> ShowS

Generic Contact

Defined in Data.OpenApi.Internal

Associated Types

type Rep Contact :: Type -> Type

Methods

from :: Contact -> Rep Contact x

to :: Rep Contact x -> Contact

Semigroup Contact

Defined in Data.OpenApi.Internal

Methods

(<>) :: Contact -> Contact -> Contact

sconcat :: NonEmpty Contact -> Contact

stimes :: Integral b => b -> Contact -> Contact

Monoid Contact

Defined in Data.OpenApi.Internal

Methods

mempty :: Contact

mappend :: Contact -> Contact -> Contact

mconcat :: [Contact] -> Contact

ToJSON Contact

Defined in Data.OpenApi.Internal

Methods

toJSON :: Contact -> Value

toEncoding :: Contact -> Encoding

toJSONList :: [Contact] -> Value

toEncodingList :: [Contact] -> Encoding

FromJSON Contact

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Contact

parseJSONList :: Value -> Parser [Contact]

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Contact Contact a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Contact Contact a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Contact Contact a b

HasUrl Contact (Maybe URL)

Defined in Data.OpenApi.Lens

Methods

url :: Lens' Contact (Maybe URL)

HasContact Info (Maybe Contact)

Defined in Data.OpenApi.Lens

Methods

contact :: Lens' Info (Maybe Contact)

HasName Contact (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

name :: Lens' Contact (Maybe Text)

HasEmail Contact (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

email :: Lens' Contact (Maybe Text)

type Rep Contact

Defined in Data.OpenApi.Internal

type Rep Contact = D1 ('MetaData "Contact" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" '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

License information for the exposed API.

Constructors

License

Fields

• _licenseName :: Text

  The license name used for the API.

• _licenseUrl :: Maybe URL

  A URL to the license used for the API.

Instances

Eq License

Defined in Data.OpenApi.Internal

Methods

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

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

Data License

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: License -> Constr

dataTypeOf :: License -> DataType

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

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

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

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

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

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

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

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

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

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

Show License

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> License -> ShowS

show :: License -> String

showList :: [License] -> ShowS

IsString License

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> License

Generic License

Defined in Data.OpenApi.Internal

Associated Types

type Rep License :: Type -> Type

Methods

from :: License -> Rep License x

to :: Rep License x -> License

ToJSON License

Defined in Data.OpenApi.Internal

Methods

toJSON :: License -> Value

toEncoding :: License -> Encoding

toJSONList :: [License] -> Value

toEncodingList :: [License] -> Encoding

FromJSON License

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser License

parseJSONList :: Value -> Parser [License]

HasName License Text

Defined in Data.OpenApi.Lens

Methods

name :: Lens' License Text

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k License License a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx License License a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx License License a b

HasUrl License (Maybe URL)

Defined in Data.OpenApi.Lens

Methods

url :: Lens' License (Maybe URL)

HasLicense Info (Maybe License)

Defined in Data.OpenApi.Lens

Methods

license :: Lens' Info (Maybe License)

type Rep License

Defined in Data.OpenApi.Internal

type Rep License = D1 ('MetaData "License" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" '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

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

• _pathItemSummary :: Maybe Text

  An optional, string summary, intended to apply to all operations in this path.

• _pathItemDescription :: Maybe Text

  An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

• _pathItemGet :: Maybe Operation

  A definition of a GET operation on this path.

• _pathItemPut :: Maybe Operation

  A definition of a PUT operation on this path.

• _pathItemPost :: Maybe Operation

  A definition of a POST operation on this path.

• _pathItemDelete :: Maybe Operation

  A definition of a DELETE operation on this path.

• _pathItemOptions :: Maybe Operation

  A definition of a OPTIONS operation on this path.

• _pathItemHead :: Maybe Operation

  A definition of a HEAD operation on this path.

• _pathItemPatch :: Maybe Operation

  A definition of a PATCH operation on this path.

• _pathItemTrace :: Maybe Operation

  A definition of a TRACE operation on this path.

• _pathItemServers :: [Server]

  An alternative server array to service all operations in this path.

• _pathItemParameters :: [Referenced Param]

  A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

Instances

Eq PathItem

Defined in Data.OpenApi.Internal

Methods

(==) :: PathItem -> PathItem -> Bool

(/=) :: PathItem -> PathItem -> Bool

Data PathItem

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: PathItem -> Constr

dataTypeOf :: PathItem -> DataType

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

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

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

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

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

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

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

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

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

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

Show PathItem

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> PathItem -> ShowS

show :: PathItem -> String

showList :: [PathItem] -> ShowS

Generic PathItem

Defined in Data.OpenApi.Internal

Associated Types

type Rep PathItem :: Type -> Type

Methods

from :: PathItem -> Rep PathItem x

to :: Rep PathItem x -> PathItem

Semigroup PathItem

Defined in Data.OpenApi.Internal

Methods

(<>) :: PathItem -> PathItem -> PathItem

sconcat :: NonEmpty PathItem -> PathItem

stimes :: Integral b => b -> PathItem -> PathItem

Monoid PathItem

Defined in Data.OpenApi.Internal

Methods

mempty :: PathItem

mappend :: PathItem -> PathItem -> PathItem

mconcat :: [PathItem] -> PathItem

ToJSON PathItem

Defined in Data.OpenApi.Internal

Methods

toJSON :: PathItem -> Value

toEncoding :: PathItem -> Encoding

toJSONList :: [PathItem] -> Value

toEncodingList :: [PathItem] -> Encoding

FromJSON PathItem

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser PathItem

parseJSONList :: Value -> Parser [PathItem]

Generic PathItem

Defined in Data.OpenApi.Internal

Associated Types

type Code PathItem :: [[Type]]

Methods

from :: PathItem -> Rep PathItem

to :: Rep PathItem -> PathItem

HasDatatypeInfo PathItem

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf PathItem :: DatatypeInfo

Methods

datatypeInfo :: proxy PathItem -> DatatypeInfo (Code PathItem)

HasSwaggerAesonOptions PathItem

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy PathItem -> SwaggerAesonOptions

aesonDefaults :: Proxy PathItem -> POP Maybe (Code PathItem)

SwaggerMonoid PathItem

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: PathItem

swaggerMappend :: PathItem -> PathItem -> PathItem

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx PathItem PathItem a b

HasServers PathItem [Server]

Defined in Data.OpenApi.Lens

Methods

servers :: Lens' PathItem [Server]

HasParameters PathItem [Referenced Param]

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' PathItem [Referenced Param]

HasDescription PathItem (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' PathItem (Maybe Text)

HasTrace PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

trace :: Lens' PathItem (Maybe Operation)

HasSummary PathItem (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

summary :: Lens' PathItem (Maybe Text)

HasPut PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

put :: Lens' PathItem (Maybe Operation)

HasPost PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

post :: Lens' PathItem (Maybe Operation)

HasPatch PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

patch :: Lens' PathItem (Maybe Operation)

HasOptions PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

options :: Lens' PathItem (Maybe Operation)

HasHead PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

head_ :: Lens' PathItem (Maybe Operation)

HasGet PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

get :: Lens' PathItem (Maybe Operation)

HasDelete PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

delete :: Lens' PathItem (Maybe Operation)

HasPaths OpenApi (InsOrdHashMap FilePath PathItem)

Defined in Data.OpenApi.Lens

Methods

paths :: Lens' OpenApi (InsOrdHashMap FilePath PathItem)

SwaggerMonoid (InsOrdHashMap FilePath PathItem)

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: InsOrdHashMap FilePath PathItem

swaggerMappend :: InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem

type Rep PathItem

Defined in Data.OpenApi.Internal

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

type Code PathItem

Defined in Data.OpenApi.Internal

type Code PathItem = '['[Maybe Text, Maybe Text, Maybe Operation, Maybe Operation, Maybe Operation, Maybe Operation, Maybe Operation, Maybe Operation, Maybe Operation, Maybe Operation, [Server], [Referenced Param]]]

type DatatypeInfoOf PathItem

Defined in Data.OpenApi.Internal

type DatatypeInfoOf PathItem = 'ADT "Data.OpenApi.Internal" "PathItem" '['Record "PathItem" '['FieldInfo "_pathItemSummary", 'FieldInfo "_pathItemDescription", 'FieldInfo "_pathItemGet", 'FieldInfo "_pathItemPut", 'FieldInfo "_pathItemPost", 'FieldInfo "_pathItemDelete", 'FieldInfo "_pathItemOptions", 'FieldInfo "_pathItemHead", 'FieldInfo "_pathItemPatch", 'FieldInfo "_pathItemTrace", 'FieldInfo "_pathItemServers", 'FieldInfo "_pathItemParameters"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

Operations

data Operation

Describes a single API operation on a path.

Constructors

Operation

Fields

• _operationTags :: InsOrdHashSet TagName

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

• _operationSummary :: Maybe Text

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

• _operationDescription :: Maybe Text

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

• _operationExternalDocs :: Maybe ExternalDocs

  Additional external documentation for this operation.

• _operationOperationId :: Maybe Text

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

• _operationParameters :: [Referenced Param]

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

• _operationRequestBody :: Maybe (Referenced RequestBody)

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

• _operationResponses :: Responses

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

• _operationCallbacks :: InsOrdHashMap Text (Referenced Callback)

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

• _operationDeprecated :: Maybe Bool

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

• _operationSecurity :: [SecurityRequirement]

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

• _operationServers :: [Server]

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

Instances

Eq Operation

Defined in Data.OpenApi.Internal

Methods

(==) :: Operation -> Operation -> Bool

(/=) :: Operation -> Operation -> Bool

Data Operation

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Operation -> Constr

dataTypeOf :: Operation -> DataType

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

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

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

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

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

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

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

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

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

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

Show Operation

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

Generic Operation

Defined in Data.OpenApi.Internal

Associated Types

type Rep Operation :: Type -> Type

Methods

from :: Operation -> Rep Operation x

to :: Rep Operation x -> Operation

Semigroup Operation

Defined in Data.OpenApi.Internal

Methods

(<>) :: Operation -> Operation -> Operation

sconcat :: NonEmpty Operation -> Operation

stimes :: Integral b => b -> Operation -> Operation

Monoid Operation

Defined in Data.OpenApi.Internal

Methods

mempty :: Operation

mappend :: Operation -> Operation -> Operation

mconcat :: [Operation] -> Operation

ToJSON Operation

Defined in Data.OpenApi.Internal

Methods

toJSON :: Operation -> Value

toEncoding :: Operation -> Encoding

toJSONList :: [Operation] -> Value

toEncodingList :: [Operation] -> Encoding

FromJSON Operation

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Operation

parseJSONList :: Value -> Parser [Operation]

Generic Operation

Defined in Data.OpenApi.Internal

Associated Types

type Code Operation :: [[Type]]

Methods

from :: Operation -> Rep Operation

to :: Rep Operation -> Operation

HasDatatypeInfo Operation

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Operation :: DatatypeInfo

Methods

datatypeInfo :: proxy Operation -> DatatypeInfo (Code Operation)

Ixed Operation

Defined in Data.OpenApi.Lens

Methods

ix :: Index Operation -> Traversal' Operation (IxValue Operation)

At Operation

Defined in Data.OpenApi.Lens

Methods

at :: Index Operation -> Lens' Operation (Maybe (IxValue Operation))

Ixed Operation

Defined in Data.OpenApi.Optics

Associated Types

type IxKind Operation

Methods

ix :: Index Operation -> Optic' (IxKind Operation) NoIx Operation (IxValue Operation)

At Operation

Defined in Data.OpenApi.Optics

Methods

at :: Index Operation -> Lens' Operation (Maybe (IxValue Operation))

HasSwaggerAesonOptions Operation

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Operation -> SwaggerAesonOptions

aesonDefaults :: Proxy Operation -> POP Maybe (Code Operation)

SwaggerMonoid Operation

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Operation

swaggerMappend :: Operation -> Operation -> Operation

HasResponses Operation Responses

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Operation Responses

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

(k ~ A_Lens, a ~ Responses, b ~ Responses) => LabelOptic "responses" k Operation Operation a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Operation Operation a b

HasTags Operation (InsOrdHashSet TagName)

Defined in Data.OpenApi.Lens

Methods

tags :: Lens' Operation (InsOrdHashSet TagName)

HasServers Operation [Server]

Defined in Data.OpenApi.Lens

Methods

servers :: Lens' Operation [Server]

HasSecurity Operation [SecurityRequirement]

Defined in Data.OpenApi.Lens

Methods

security :: Lens' Operation [SecurityRequirement]

HasExternalDocs Operation (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' Operation (Maybe ExternalDocs)

HasParameters Operation [Referenced Param]

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' Operation [Referenced Param]

HasDescription Operation (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Operation (Maybe Text)

HasTrace PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

trace :: Lens' PathItem (Maybe Operation)

HasSummary Operation (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

summary :: Lens' Operation (Maybe Text)

HasPut PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

put :: Lens' PathItem (Maybe Operation)

HasPost PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

post :: Lens' PathItem (Maybe Operation)

HasPatch PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

patch :: Lens' PathItem (Maybe Operation)

HasOptions PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

options :: Lens' PathItem (Maybe Operation)

HasHead PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

head_ :: Lens' PathItem (Maybe Operation)

HasGet PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

get :: Lens' PathItem (Maybe Operation)

HasDelete PathItem (Maybe Operation)

Defined in Data.OpenApi.Lens

Methods

delete :: Lens' PathItem (Maybe Operation)

HasRequestBody Operation (Maybe (Referenced RequestBody))

Defined in Data.OpenApi.Lens

Methods

requestBody :: Lens' Operation (Maybe (Referenced RequestBody))

HasOperationId Operation (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

operationId :: Lens' Operation (Maybe Text)

HasDeprecated Operation (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

deprecated :: Lens' Operation (Maybe Bool)

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback))

Defined in Data.OpenApi.Lens

Methods

callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback))

type Rep Operation

Defined in Data.OpenApi.Internal

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

type Code Operation

Defined in Data.OpenApi.Internal

type Code Operation = '['[InsOrdHashSet TagName, Maybe Text, Maybe Text, Maybe ExternalDocs, Maybe Text, [Referenced Param], Maybe (Referenced RequestBody), Responses, InsOrdHashMap Text (Referenced Callback), Maybe Bool, [SecurityRequirement], [Server]]]

type DatatypeInfoOf Operation

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Operation = 'ADT "Data.OpenApi.Internal" "Operation" '['Record "Operation" '['FieldInfo "_operationTags", 'FieldInfo "_operationSummary", 'FieldInfo "_operationDescription", 'FieldInfo "_operationExternalDocs", 'FieldInfo "_operationOperationId", 'FieldInfo "_operationParameters", 'FieldInfo "_operationRequestBody", 'FieldInfo "_operationResponses", 'FieldInfo "_operationCallbacks", 'FieldInfo "_operationDeprecated", 'FieldInfo "_operationSecurity", 'FieldInfo "_operationServers"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

type Index Operation

Defined in Data.OpenApi.Lens

type Index Operation = HttpStatusCode

type IxValue Operation

Defined in Data.OpenApi.Lens

type IxValue Operation = Referenced Response

type Index Operation

Defined in Data.OpenApi.Optics

type Index Operation = HttpStatusCode

type IxValue Operation

Defined in Data.OpenApi.Optics

type IxValue Operation = Referenced Response

type IxKind Operation

Defined in Data.OpenApi.Optics

type IxKind Operation = An_AffineTraversal

data Tag

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

Constructors

Tag

Fields

• _tagName :: TagName

  The name of the tag.

• _tagDescription :: Maybe Text

  A short description for the tag. CommonMark syntax MAY be used for rich text representation.

• _tagExternalDocs :: Maybe ExternalDocs

  Additional external documentation for this tag.

Instances

Eq Tag

Defined in Data.OpenApi.Internal

Methods

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

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

Data Tag

Defined in Data.OpenApi.Internal

Methods

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

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

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 :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r

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

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

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

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

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

Ord Tag

Defined in Data.OpenApi.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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

IsString Tag

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Tag

Generic Tag

Defined in Data.OpenApi.Internal

Associated Types

type Rep Tag :: Type -> Type

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

Hashable Tag

Defined in Data.OpenApi.Internal

Methods

hashWithSalt :: Int -> Tag -> Int

hash :: Tag -> Int

ToJSON Tag

Defined in Data.OpenApi.Internal

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

FromJSON Tag

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

HasName Tag TagName

Defined in Data.OpenApi.Lens

Methods

name :: Lens' Tag TagName

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Tag Tag a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Tag Tag a b

(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Tag Tag a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Tag Tag a b

(k ~ A_Lens, a ~ TagName, b ~ TagName) => LabelOptic "name" k Tag Tag a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Tag Tag a b

HasTags OpenApi (InsOrdHashSet Tag)

Defined in Data.OpenApi.Lens

Methods

tags :: Lens' OpenApi (InsOrdHashSet Tag)

HasExternalDocs Tag (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' Tag (Maybe ExternalDocs)

HasDescription Tag (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Tag (Maybe Text)

type Rep Tag

Defined in Data.OpenApi.Internal

type Rep Tag = D1 ('MetaData "Tag" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" '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

Tag name.

Types and formats

data OpenApiType where

Constructors

OpenApiString :: OpenApiType

OpenApiNumber :: OpenApiType

OpenApiInteger :: OpenApiType

OpenApiBoolean :: OpenApiType

OpenApiArray :: OpenApiType

OpenApiNull :: OpenApiType

OpenApiObject :: OpenApiType

Instances

Eq OpenApiType

Defined in Data.OpenApi.Internal

Methods

(==) :: OpenApiType -> OpenApiType -> Bool

(/=) :: OpenApiType -> OpenApiType -> Bool

Data OpenApiType

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OpenApiType -> Constr

dataTypeOf :: OpenApiType -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OpenApiType -> OpenApiType

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

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

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

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

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

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

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

Show OpenApiType

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OpenApiType -> ShowS

show :: OpenApiType -> String

showList :: [OpenApiType] -> ShowS

Generic OpenApiType

Defined in Data.OpenApi.Internal

Associated Types

type Rep OpenApiType :: Type -> Type

Methods

from :: OpenApiType -> Rep OpenApiType x

to :: Rep OpenApiType x -> OpenApiType

ToJSON OpenApiType

Defined in Data.OpenApi.Internal

Methods

toJSON :: OpenApiType -> Value

toEncoding :: OpenApiType -> Encoding

toJSONList :: [OpenApiType] -> Value

toEncodingList :: [OpenApiType] -> Encoding

FromJSON OpenApiType

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OpenApiType

parseJSONList :: Value -> Parser [OpenApiType]

AesonDefaultValue OpenApiType

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OpenApiType

SwaggerMonoid OpenApiType

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: OpenApiType

swaggerMappend :: OpenApiType -> OpenApiType -> OpenApiType

HasType NamedSchema (Maybe OpenApiType)

Defined in Data.OpenApi.Lens

Methods

type_ :: Lens' NamedSchema (Maybe OpenApiType)

HasType Schema (Maybe OpenApiType)

Defined in Data.OpenApi.Lens

Methods

type_ :: Lens' Schema (Maybe OpenApiType)

type Rep OpenApiType

Defined in Data.OpenApi.Internal

type Rep OpenApiType = D1 ('MetaData "OpenApiType" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) ((C1 ('MetaCons "OpenApiString" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OpenApiNumber" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpenApiInteger" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "OpenApiBoolean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpenApiArray" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "OpenApiNull" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OpenApiObject" 'PrefixI 'False) (U1 :: Type -> Type))))

type Format = Text

type Definitions = InsOrdHashMap Text

A list of definitions that can be used in references.

data Style

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

Constructors

StyleMatrix

Path-style parameters defined by RFC6570.

StyleLabel

Label style parameters defined by RFC6570.

StyleForm

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

StyleSimple

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

StyleSpaceDelimited

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

StylePipeDelimited

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

StyleDeepObject

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

Instances

Eq Style

Defined in Data.OpenApi.Internal

Methods

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

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

Data Style

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Style -> Constr

dataTypeOf :: Style -> DataType

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

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

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

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

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

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

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

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

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

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

Show Style

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

Generic Style

Defined in Data.OpenApi.Internal

Associated Types

type Rep Style :: Type -> Type

Methods

from :: Style -> Rep Style x

to :: Rep Style x -> Style

ToJSON Style

Defined in Data.OpenApi.Internal

Methods

toJSON :: Style -> Value

toEncoding :: Style -> Encoding

toJSONList :: [Style] -> Value

toEncodingList :: [Style] -> Encoding

FromJSON Style

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Style

parseJSONList :: Value -> Parser [Style]

HasStyle Param (Maybe Style)

Defined in Data.OpenApi.Lens

Methods

style :: Lens' Param (Maybe Style)

HasStyle Encoding (Maybe Style)

Defined in Data.OpenApi.Lens

Methods

style :: Lens' Encoding (Maybe Style)

type Rep Style

Defined in Data.OpenApi.Internal

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

Parameters

data Param

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

Constructors

Param

Fields

• _paramName :: Text

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

• _paramDescription :: Maybe Text

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

• _paramRequired :: Maybe Bool

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

• _paramDeprecated :: Maybe Bool

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

• _paramIn :: ParamLocation

  The location of the parameter.

• _paramAllowEmptyValue :: Maybe Bool

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

• _paramAllowReserved :: Maybe Bool

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

• _paramSchema :: Maybe (Referenced Schema)

  Parameter schema.

• _paramStyle :: Maybe Style

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

• _paramExplode :: Maybe Bool

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

• _paramExample :: Maybe Value

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

• _paramExamples :: InsOrdHashMap Text (Referenced Example)

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

Instances

Eq Param

Defined in Data.OpenApi.Internal

Methods

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

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

Data Param

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Param -> Constr

dataTypeOf :: Param -> DataType

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

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

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

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

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

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

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

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

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

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

Show Param

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Param -> ShowS

show :: Param -> String

showList :: [Param] -> ShowS

Generic Param

Defined in Data.OpenApi.Internal

Associated Types

type Rep Param :: Type -> Type

Methods

from :: Param -> Rep Param x

to :: Rep Param x -> Param

Semigroup Param

Defined in Data.OpenApi.Internal

Methods

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

sconcat :: NonEmpty Param -> Param

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

Monoid Param

Defined in Data.OpenApi.Internal

Methods

mempty :: Param

mappend :: Param -> Param -> Param

mconcat :: [Param] -> Param

ToJSON Param

Defined in Data.OpenApi.Internal

Methods

toJSON :: Param -> Value

toEncoding :: Param -> Encoding

toJSONList :: [Param] -> Value

toEncodingList :: [Param] -> Encoding

FromJSON Param

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Param

parseJSONList :: Value -> Parser [Param]

Generic Param

Defined in Data.OpenApi.Internal

Associated Types

type Code Param :: [[Type]]

Methods

from :: Param -> Rep Param

to :: Rep Param -> Param

HasDatatypeInfo Param

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Param :: DatatypeInfo

Methods

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

HasSwaggerAesonOptions Param

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Param -> SwaggerAesonOptions

aesonDefaults :: Proxy Param -> POP Maybe (Code Param)

SwaggerMonoid Param

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Param

swaggerMappend :: Param -> Param -> Param

HasName Param Text

Defined in Data.OpenApi.Lens

Methods

name :: Lens' Param Text

HasIn Param ParamLocation

Defined in Data.OpenApi.Lens

Methods

in_ :: Lens' Param ParamLocation

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

(k ~ A_Lens, a ~ ParamLocation, b ~ ParamLocation) => LabelOptic "in" k Param Param a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k Param Param a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b

HasParameters Operation [Referenced Param]

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' Operation [Referenced Param]

HasParameters PathItem [Referenced Param]

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' PathItem [Referenced Param]

HasParameters Components (Definitions Param)

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' Components (Definitions Param)

HasDescription Param (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Param (Maybe Text)

HasRequired Param (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

required :: Lens' Param (Maybe Bool)

HasSchema Param (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' Param (Maybe (Referenced Schema))

HasExample Param (Maybe Value)

Defined in Data.OpenApi.Lens

Methods

example :: Lens' Param (Maybe Value)

HasDeprecated Param (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

deprecated :: Lens' Param (Maybe Bool)

HasStyle Param (Maybe Style)

Defined in Data.OpenApi.Lens

Methods

style :: Lens' Param (Maybe Style)

HasExplode Param (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

explode :: Lens' Param (Maybe Bool)

HasAllowReserved Param (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

allowReserved :: Lens' Param (Maybe Bool)

HasAllowEmptyValue Param (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

allowEmptyValue :: Lens' Param (Maybe Bool)

HasExamples Param (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Param (InsOrdHashMap Text (Referenced Example))

ToJSON (Referenced Param)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Param -> Value

toEncoding :: Referenced Param -> Encoding

toJSONList :: [Referenced Param] -> Value

toEncodingList :: [Referenced Param] -> Encoding

FromJSON (Referenced Param)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Param)

parseJSONList :: Value -> Parser [Referenced Param]

type Rep Param

Defined in Data.OpenApi.Internal

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

type Code Param

Defined in Data.OpenApi.Internal

type Code Param = '['[Text, Maybe Text, Maybe Bool, Maybe Bool, ParamLocation, Maybe Bool, Maybe Bool, Maybe (Referenced Schema), Maybe Style, Maybe Bool, Maybe Value, InsOrdHashMap Text (Referenced Example)]]

type DatatypeInfoOf Param

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Param = 'ADT "Data.OpenApi.Internal" "Param" '['Record "Param" '['FieldInfo "_paramName", 'FieldInfo "_paramDescription", 'FieldInfo "_paramRequired", 'FieldInfo "_paramDeprecated", 'FieldInfo "_paramIn", 'FieldInfo "_paramAllowEmptyValue", 'FieldInfo "_paramAllowReserved", 'FieldInfo "_paramSchema", 'FieldInfo "_paramStyle", 'FieldInfo "_paramExplode", 'FieldInfo "_paramExample", 'FieldInfo "_paramExamples"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data ParamLocation

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.

ParamCookie

Used to pass a specific cookie value to the API.

Instances

Eq ParamLocation

Defined in Data.OpenApi.Internal

Methods

(==) :: ParamLocation -> ParamLocation -> Bool

(/=) :: ParamLocation -> ParamLocation -> Bool

Data ParamLocation

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: ParamLocation -> Constr

dataTypeOf :: ParamLocation -> DataType

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

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

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

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

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

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

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

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

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

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

Show ParamLocation

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> ParamLocation -> ShowS

show :: ParamLocation -> String

showList :: [ParamLocation] -> ShowS

Generic ParamLocation

Defined in Data.OpenApi.Internal

Associated Types

type Rep ParamLocation :: Type -> Type

Methods

from :: ParamLocation -> Rep ParamLocation x

to :: Rep ParamLocation x -> ParamLocation

ToJSON ParamLocation

Defined in Data.OpenApi.Internal

Methods

toJSON :: ParamLocation -> Value

toEncoding :: ParamLocation -> Encoding

toJSONList :: [ParamLocation] -> Value

toEncodingList :: [ParamLocation] -> Encoding

FromJSON ParamLocation

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser ParamLocation

parseJSONList :: Value -> Parser [ParamLocation]

AesonDefaultValue ParamLocation

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe ParamLocation

SwaggerMonoid ParamLocation

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: ParamLocation

swaggerMappend :: ParamLocation -> ParamLocation -> ParamLocation

HasIn Param ParamLocation

Defined in Data.OpenApi.Lens

Methods

in_ :: Lens' Param ParamLocation

type Rep ParamLocation

Defined in Data.OpenApi.Internal

type Rep ParamLocation = D1 ('MetaData "ParamLocation" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) ((C1 ('MetaCons "ParamQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ParamHeader" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ParamPath" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ParamCookie" 'PrefixI 'False) (U1 :: Type -> Type)))

type ParamName = Text

data Header

Header fields have the same meaning as for Param.

Style is always treated as StyleSimple, as it is the only value allowed for headers.

Constructors

Header

Fields

• _headerDescription :: Maybe HeaderName

  A short description of the header.

• _headerRequired :: Maybe Bool
• _headerDeprecated :: Maybe Bool
• _headerAllowEmptyValue :: Maybe Bool
• _headerExplode :: Maybe Bool
• _headerExample :: Maybe Value
• _headerExamples :: InsOrdHashMap Text (Referenced Example)
• _headerSchema :: Maybe (Referenced Schema)

Instances

Eq Header

Defined in Data.OpenApi.Internal

Methods

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

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

Data Header

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Header -> Constr

dataTypeOf :: Header -> DataType

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

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

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

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

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

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

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

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

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

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

Show Header

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Generic Header

Defined in Data.OpenApi.Internal

Associated Types

type Rep Header :: Type -> Type

Methods

from :: Header -> Rep Header x

to :: Rep Header x -> Header

Semigroup Header

Defined in Data.OpenApi.Internal

Methods

(<>) :: Header -> Header -> Header

sconcat :: NonEmpty Header -> Header

stimes :: Integral b => b -> Header -> Header

Monoid Header

Defined in Data.OpenApi.Internal

Methods

mempty :: Header

mappend :: Header -> Header -> Header

mconcat :: [Header] -> Header

ToJSON Header

Defined in Data.OpenApi.Internal

Methods

toJSON :: Header -> Value

toEncoding :: Header -> Encoding

toJSONList :: [Header] -> Value

toEncodingList :: [Header] -> Encoding

FromJSON Header

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Header

parseJSONList :: Value -> Parser [Header]

Generic Header

Defined in Data.OpenApi.Internal

Associated Types

type Code Header :: [[Type]]

Methods

from :: Header -> Rep Header

to :: Rep Header -> Header

HasDatatypeInfo Header

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Header :: DatatypeInfo

Methods

datatypeInfo :: proxy Header -> DatatypeInfo (Code Header)

HasSwaggerAesonOptions Header

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Header -> SwaggerAesonOptions

aesonDefaults :: Proxy Header -> POP Maybe (Code Header)

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "allowEmptyValue" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ Maybe HeaderName, b ~ Maybe HeaderName) => LabelOptic "description" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Example), b ~ InsOrdHashMap Text (Referenced Example)) => LabelOptic "examples" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "explode" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "required" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

(k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "schema" k Header Header a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Header Header a b

HasHeaders Components (Definitions Header)

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Components (Definitions Header)

HasDescription Header (Maybe HeaderName)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Header (Maybe HeaderName)

HasRequired Header (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

required :: Lens' Header (Maybe Bool)

HasSchema Header (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' Header (Maybe (Referenced Schema))

HasExample Header (Maybe Value)

Defined in Data.OpenApi.Lens

Methods

example :: Lens' Header (Maybe Value)

HasDeprecated Header (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

deprecated :: Lens' Header (Maybe Bool)

HasExplode Header (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

explode :: Lens' Header (Maybe Bool)

HasAllowEmptyValue Header (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

allowEmptyValue :: Lens' Header (Maybe Bool)

HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header))

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header))

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header))

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header))

HasExamples Header (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Header (InsOrdHashMap Text (Referenced Example))

ToJSON (Referenced Header)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Header -> Value

toEncoding :: Referenced Header -> Encoding

toJSONList :: [Referenced Header] -> Value

toEncodingList :: [Referenced Header] -> Encoding

FromJSON (Referenced Header)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Header)

parseJSONList :: Value -> Parser [Referenced Header]

type Rep Header

Defined in Data.OpenApi.Internal

type Rep Header = D1 ('MetaData "Header" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Header" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_headerDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HeaderName)) :*: S1 ('MetaSel ('Just "_headerRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "_headerDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_headerAllowEmptyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "_headerExplode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_headerExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "_headerExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Example))) :*: S1 ('MetaSel ('Just "_headerSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema)))))))

type Code Header

Defined in Data.OpenApi.Internal

type Code Header = '['[Maybe HeaderName, Maybe Bool, Maybe Bool, Maybe Bool, Maybe Bool, Maybe Value, InsOrdHashMap Text (Referenced Example), Maybe (Referenced Schema)]]

type DatatypeInfoOf Header

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Header = 'ADT "Data.OpenApi.Internal" "Header" '['Record "Header" '['FieldInfo "_headerDescription", 'FieldInfo "_headerRequired", 'FieldInfo "_headerDeprecated", 'FieldInfo "_headerAllowEmptyValue", 'FieldInfo "_headerExplode", 'FieldInfo "_headerExample", 'FieldInfo "_headerExamples", 'FieldInfo "_headerSchema"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

type HeaderName = Text

data Example

Constructors

Example

Fields

• _exampleSummary :: Maybe Text

  Short description for the example.

• _exampleDescription :: Maybe Text

  Long description for the example. CommonMark syntax MAY be used for rich text representation.

• _exampleValue :: Maybe Value

  Embedded literal example. The _exampleValue field and _exampleExternalValue field are mutually exclusive.

  To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.

• _exampleExternalValue :: Maybe URL

  A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The _exampleValue field and _exampleExternalValue field are mutually exclusive.

Instances

Eq Example

Defined in Data.OpenApi.Internal

Methods

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

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

Data Example

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Example -> Constr

dataTypeOf :: Example -> DataType

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

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

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

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

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

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

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

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

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

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

Show Example

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Example -> ShowS

show :: Example -> String

showList :: [Example] -> ShowS

Generic Example

Defined in Data.OpenApi.Internal

Associated Types

type Rep Example :: Type -> Type

Methods

from :: Example -> Rep Example x

to :: Rep Example x -> Example

ToJSON Example

Defined in Data.OpenApi.Internal

Methods

toJSON :: Example -> Value

toEncoding :: Example -> Encoding

toJSONList :: [Example] -> Value

toEncodingList :: [Example] -> Encoding

FromJSON Example

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Example

parseJSONList :: Value -> Parser [Example]

Generic Example

Defined in Data.OpenApi.Internal

Associated Types

type Code Example :: [[Type]]

Methods

from :: Example -> Rep Example

to :: Rep Example -> Example

HasDatatypeInfo Example

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Example :: DatatypeInfo

Methods

datatypeInfo :: proxy Example -> DatatypeInfo (Code Example)

HasSwaggerAesonOptions Example

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Example -> SwaggerAesonOptions

aesonDefaults :: Proxy Example -> POP Maybe (Code Example)

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Example Example a b

(k ~ A_Lens, a ~ Maybe URL, b ~ Maybe URL) => LabelOptic "externalValue" k Example Example a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Example Example a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "summary" k Example Example a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Example Example a b

(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "value" k Example Example a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Example Example a b

HasExamples Components (Definitions Example)

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Components (Definitions Example)

HasDescription Example (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Example (Maybe Text)

HasSummary Example (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

summary :: Lens' Example (Maybe Text)

HasValue Example (Maybe Value)

Defined in Data.OpenApi.Lens

Methods

value :: Lens' Example (Maybe Value)

HasExternalValue Example (Maybe URL)

Defined in Data.OpenApi.Lens

Methods

externalValue :: Lens' Example (Maybe URL)

HasExamples Header (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Header (InsOrdHashMap Text (Referenced Example))

HasExamples Param (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Param (InsOrdHashMap Text (Referenced Example))

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example))

ToJSON (Referenced Example)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Example -> Value

toEncoding :: Referenced Example -> Encoding

toJSONList :: [Referenced Example] -> Value

toEncodingList :: [Referenced Example] -> Encoding

FromJSON (Referenced Example)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Example)

parseJSONList :: Value -> Parser [Referenced Example]

type Rep Example

Defined in Data.OpenApi.Internal

type Rep Example = D1 ('MetaData "Example" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Example" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_exampleSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_exampleDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_exampleValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_exampleExternalValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)))))

type Code Example

Defined in Data.OpenApi.Internal

type Code Example = '['[Maybe Text, Maybe Text, Maybe Value, Maybe URL]]

type DatatypeInfoOf Example

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Example = 'ADT "Data.OpenApi.Internal" "Example" '['Record "Example" '['FieldInfo "_exampleSummary", 'FieldInfo "_exampleDescription", 'FieldInfo "_exampleValue", 'FieldInfo "_exampleExternalValue"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data RequestBody

Describes a single request body.

Constructors

RequestBody

Fields

• _requestBodyDescription :: Maybe Text

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

• _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject

  The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

• _requestBodyRequired :: Maybe Bool

  Determines if the request body is required in the request. Defaults to False.

Instances

Eq RequestBody

Defined in Data.OpenApi.Internal

Methods

(==) :: RequestBody -> RequestBody -> Bool

(/=) :: RequestBody -> RequestBody -> Bool

Data RequestBody

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: RequestBody -> Constr

dataTypeOf :: RequestBody -> DataType

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

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

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

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

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

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

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

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

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

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

Show RequestBody

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> RequestBody -> ShowS

show :: RequestBody -> String

showList :: [RequestBody] -> ShowS

Generic RequestBody

Defined in Data.OpenApi.Internal

Associated Types

type Rep RequestBody :: Type -> Type

Methods

from :: RequestBody -> Rep RequestBody x

to :: Rep RequestBody x -> RequestBody

Semigroup RequestBody

Defined in Data.OpenApi.Internal

Methods

(<>) :: RequestBody -> RequestBody -> RequestBody

sconcat :: NonEmpty RequestBody -> RequestBody

stimes :: Integral b => b -> RequestBody -> RequestBody

Monoid RequestBody

Defined in Data.OpenApi.Internal

Methods

mempty :: RequestBody

mappend :: RequestBody -> RequestBody -> RequestBody

mconcat :: [RequestBody] -> RequestBody

ToJSON RequestBody

Defined in Data.OpenApi.Internal

Methods

toJSON :: RequestBody -> Value

toEncoding :: RequestBody -> Encoding

toJSONList :: [RequestBody] -> Value

toEncodingList :: [RequestBody] -> Encoding

FromJSON RequestBody

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser RequestBody

parseJSONList :: Value -> Parser [RequestBody]

Generic RequestBody

Defined in Data.OpenApi.Internal

Associated Types

type Code RequestBody :: [[Type]]

Methods

from :: RequestBody -> Rep RequestBody

to :: Rep RequestBody -> RequestBody

HasDatatypeInfo RequestBody

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf RequestBody :: DatatypeInfo

Methods

datatypeInfo :: proxy RequestBody -> DatatypeInfo (Code RequestBody)

HasSwaggerAesonOptions RequestBody

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy RequestBody -> SwaggerAesonOptions

aesonDefaults :: Proxy RequestBody -> POP Maybe (Code RequestBody)

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx RequestBody RequestBody a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx RequestBody RequestBody a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx RequestBody RequestBody a b

HasRequestBodies Components (Definitions RequestBody)

Defined in Data.OpenApi.Lens

Methods

requestBodies :: Lens' Components (Definitions RequestBody)

HasDescription RequestBody (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' RequestBody (Maybe Text)

HasRequired RequestBody (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

required :: Lens' RequestBody (Maybe Bool)

HasRequestBody Operation (Maybe (Referenced RequestBody))

Defined in Data.OpenApi.Lens

Methods

requestBody :: Lens' Operation (Maybe (Referenced RequestBody))

HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject)

Defined in Data.OpenApi.Lens

Methods

content :: Lens' RequestBody (InsOrdHashMap MediaType MediaTypeObject)

ToJSON (Referenced RequestBody)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced RequestBody -> Value

toEncoding :: Referenced RequestBody -> Encoding

toJSONList :: [Referenced RequestBody] -> Value

toEncodingList :: [Referenced RequestBody] -> Encoding

FromJSON (Referenced RequestBody)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced RequestBody)

parseJSONList :: Value -> Parser [Referenced RequestBody]

type Rep RequestBody

Defined in Data.OpenApi.Internal

type Rep RequestBody = D1 ('MetaData "RequestBody" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "RequestBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "_requestBodyDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_requestBodyContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap MediaType MediaTypeObject)) :*: S1 ('MetaSel ('Just "_requestBodyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

type Code RequestBody

Defined in Data.OpenApi.Internal

type Code RequestBody = '['[Maybe Text, InsOrdHashMap MediaType MediaTypeObject, Maybe Bool]]

type DatatypeInfoOf RequestBody

Defined in Data.OpenApi.Internal

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

data MediaTypeObject

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

Constructors

MediaTypeObject

Fields

• _mediaTypeObjectSchema :: Maybe (Referenced Schema)
• _mediaTypeObjectExample :: Maybe Value

  Example of the media type. The example object SHOULD be in the correct format as specified by the media type.

• _mediaTypeObjectExamples :: InsOrdHashMap Text (Referenced Example)

  Examples of the media type. Each example object SHOULD match the media type and specified schema if present.

• _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding

  A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to RequestBody objects when the media type is multipart or application/x-www-form-urlencoded.

Instances

Eq MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

(==) :: MediaTypeObject -> MediaTypeObject -> Bool

(/=) :: MediaTypeObject -> MediaTypeObject -> Bool

Data MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: MediaTypeObject -> Constr

dataTypeOf :: MediaTypeObject -> DataType

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

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

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

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

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

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

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

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

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

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

Show MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> MediaTypeObject -> ShowS

show :: MediaTypeObject -> String

showList :: [MediaTypeObject] -> ShowS

Generic MediaTypeObject

Defined in Data.OpenApi.Internal

Associated Types

type Rep MediaTypeObject :: Type -> Type

Methods

from :: MediaTypeObject -> Rep MediaTypeObject x

to :: Rep MediaTypeObject x -> MediaTypeObject

Semigroup MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

(<>) :: MediaTypeObject -> MediaTypeObject -> MediaTypeObject

sconcat :: NonEmpty MediaTypeObject -> MediaTypeObject

stimes :: Integral b => b -> MediaTypeObject -> MediaTypeObject

Monoid MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

mempty :: MediaTypeObject

mappend :: MediaTypeObject -> MediaTypeObject -> MediaTypeObject

mconcat :: [MediaTypeObject] -> MediaTypeObject

ToJSON MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

toJSON :: MediaTypeObject -> Value

toEncoding :: MediaTypeObject -> Encoding

toJSONList :: [MediaTypeObject] -> Value

toEncodingList :: [MediaTypeObject] -> Encoding

FromJSON MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser MediaTypeObject

parseJSONList :: Value -> Parser [MediaTypeObject]

Generic MediaTypeObject

Defined in Data.OpenApi.Internal

Associated Types

type Code MediaTypeObject :: [[Type]]

Methods

from :: MediaTypeObject -> Rep MediaTypeObject

to :: Rep MediaTypeObject -> MediaTypeObject

HasDatatypeInfo MediaTypeObject

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf MediaTypeObject :: DatatypeInfo

Methods

datatypeInfo :: proxy MediaTypeObject -> DatatypeInfo (Code MediaTypeObject)

HasSwaggerAesonOptions MediaTypeObject

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy MediaTypeObject -> SwaggerAesonOptions

aesonDefaults :: Proxy MediaTypeObject -> POP Maybe (Code MediaTypeObject)

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b

HasSchema MediaTypeObject (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' MediaTypeObject (Maybe (Referenced Schema))

HasExample MediaTypeObject (Maybe Value)

Defined in Data.OpenApi.Lens

Methods

example :: Lens' MediaTypeObject (Maybe Value)

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example))

HasContent Response (InsOrdHashMap MediaType MediaTypeObject)

Defined in Data.OpenApi.Lens

Methods

content :: Lens' Response (InsOrdHashMap MediaType MediaTypeObject)

HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject)

Defined in Data.OpenApi.Lens

Methods

content :: Lens' RequestBody (InsOrdHashMap MediaType MediaTypeObject)

HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding)

Defined in Data.OpenApi.Lens

Methods

encoding :: Lens' MediaTypeObject (InsOrdHashMap Text Encoding)

type Rep MediaTypeObject

Defined in Data.OpenApi.Internal

type Rep MediaTypeObject = D1 ('MetaData "MediaTypeObject" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "MediaTypeObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_mediaTypeObjectSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))) :*: S1 ('MetaSel ('Just "_mediaTypeObjectExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "_mediaTypeObjectExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Example))) :*: S1 ('MetaSel ('Just "_mediaTypeObjectEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Encoding)))))

type Code MediaTypeObject

Defined in Data.OpenApi.Internal

type Code MediaTypeObject = '['[Maybe (Referenced Schema), Maybe Value, InsOrdHashMap Text (Referenced Example), InsOrdHashMap Text Encoding]]

type DatatypeInfoOf MediaTypeObject

Defined in Data.OpenApi.Internal

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

data Encoding

Constructors

Encoding

Fields

• _encodingContentType :: Maybe MediaType

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

• _encodingHeaders :: InsOrdHashMap Text (Referenced Header)

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

• _encodingStyle :: Maybe Style

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

• _encodingExplode :: Maybe Bool

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

• _encodingAllowReserved :: Maybe Bool

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

Instances

Eq Encoding

Defined in Data.OpenApi.Internal

Methods

(==) :: Encoding -> Encoding -> Bool

(/=) :: Encoding -> Encoding -> Bool

Data Encoding

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Encoding -> Constr

dataTypeOf :: Encoding -> DataType

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

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

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

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

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

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

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

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

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

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

Show Encoding

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

Generic Encoding

Defined in Data.OpenApi.Internal

Associated Types

type Rep Encoding :: Type -> Type

Methods

from :: Encoding -> Rep Encoding x

to :: Rep Encoding x -> Encoding

Semigroup Encoding

Defined in Data.OpenApi.Internal

Methods

(<>) :: Encoding -> Encoding -> Encoding

sconcat :: NonEmpty Encoding -> Encoding

stimes :: Integral b => b -> Encoding -> Encoding

Monoid Encoding

Defined in Data.OpenApi.Internal

Methods

mempty :: Encoding

mappend :: Encoding -> Encoding -> Encoding

mconcat :: [Encoding] -> Encoding

ToJSON Encoding

Defined in Data.OpenApi.Internal

Methods

toJSON :: Encoding -> Value

toEncoding :: Encoding -> Encoding0

toJSONList :: [Encoding] -> Value

toEncodingList :: [Encoding] -> Encoding0

FromJSON Encoding

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Encoding

parseJSONList :: Value -> Parser [Encoding]

Generic Encoding

Defined in Data.OpenApi.Internal

Associated Types

type Code Encoding :: [[Type]]

Methods

from :: Encoding -> Rep Encoding

to :: Rep Encoding -> Encoding

HasDatatypeInfo Encoding

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Encoding :: DatatypeInfo

Methods

datatypeInfo :: proxy Encoding -> DatatypeInfo (Code Encoding)

HasSwaggerAesonOptions Encoding

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Encoding -> SwaggerAesonOptions

aesonDefaults :: Proxy Encoding -> POP Maybe (Code Encoding)

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Encoding Encoding a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Encoding Encoding a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Encoding Encoding a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Encoding Encoding a b

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Encoding Encoding a b

HasStyle Encoding (Maybe Style)

Defined in Data.OpenApi.Lens

Methods

style :: Lens' Encoding (Maybe Style)

HasExplode Encoding (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

explode :: Lens' Encoding (Maybe Bool)

HasAllowReserved Encoding (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

allowReserved :: Lens' Encoding (Maybe Bool)

HasContentType Encoding (Maybe MediaType)

Defined in Data.OpenApi.Lens

Methods

contentType :: Lens' Encoding (Maybe MediaType)

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header))

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header))

HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding)

Defined in Data.OpenApi.Lens

Methods

encoding :: Lens' MediaTypeObject (InsOrdHashMap Text Encoding)

type Rep Encoding

Defined in Data.OpenApi.Internal

type Rep Encoding = D1 ('MetaData "Encoding" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Encoding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_encodingContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MediaType)) :*: S1 ('MetaSel ('Just "_encodingHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Header)))) :*: (S1 ('MetaSel ('Just "_encodingStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Style)) :*: (S1 ('MetaSel ('Just "_encodingExplode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_encodingAllowReserved") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

type Code Encoding

Defined in Data.OpenApi.Internal

type Code Encoding = '['[Maybe MediaType, InsOrdHashMap Text (Referenced Header), Maybe Style, Maybe Bool, Maybe Bool]]

type DatatypeInfoOf Encoding

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Encoding = 'ADT "Data.OpenApi.Internal" "Encoding" '['Record "Encoding" '['FieldInfo "_encodingContentType", 'FieldInfo "_encodingHeaders", 'FieldInfo "_encodingStyle", 'FieldInfo "_encodingExplode", 'FieldInfo "_encodingAllowReserved"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

Schemas

data Schema

Constructors

Schema

Fields

• _schemaTitle :: Maybe Text
• _schemaDescription :: Maybe Text
• _schemaRequired :: [ParamName]
• _schemaNullable :: Maybe Bool
• _schemaAllOf :: Maybe [Referenced Schema]
• _schemaOneOf :: Maybe [Referenced Schema]
• _schemaNot :: Maybe (Referenced Schema)
• _schemaAnyOf :: Maybe [Referenced Schema]
• _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
• _schemaAdditionalProperties :: Maybe AdditionalProperties
• _schemaDiscriminator :: Maybe Discriminator
• _schemaReadOnly :: Maybe Bool
• _schemaWriteOnly :: Maybe Bool
• _schemaXml :: Maybe Xml
• _schemaExternalDocs :: Maybe ExternalDocs
• _schemaExample :: Maybe Value
• _schemaDeprecated :: Maybe Bool
• _schemaMaxProperties :: Maybe Integer
• _schemaMinProperties :: Maybe Integer
• _schemaDefault :: Maybe Value

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

• _schemaType :: Maybe OpenApiType
• _schemaFormat :: Maybe Format
• _schemaItems :: Maybe OpenApiItems
• _schemaMaximum :: Maybe Scientific
• _schemaExclusiveMaximum :: Maybe Bool
• _schemaMinimum :: Maybe Scientific
• _schemaExclusiveMinimum :: Maybe Bool
• _schemaMaxLength :: Maybe Integer
• _schemaMinLength :: Maybe Integer
• _schemaPattern :: Maybe Pattern
• _schemaMaxItems :: Maybe Integer
• _schemaMinItems :: Maybe Integer
• _schemaUniqueItems :: Maybe Bool
• _schemaEnum :: Maybe [Value]
• _schemaMultipleOf :: Maybe Scientific

Instances

Eq Schema

Defined in Data.OpenApi.Internal

Methods

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

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

Data Schema

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Schema -> Constr

dataTypeOf :: Schema -> DataType

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

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

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

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

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

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

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

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

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

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

Show Schema

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Schema -> ShowS

show :: Schema -> String

showList :: [Schema] -> ShowS

Generic Schema

Defined in Data.OpenApi.Internal

Associated Types

type Rep Schema :: Type -> Type

Methods

from :: Schema -> Rep Schema x

to :: Rep Schema x -> Schema

Semigroup Schema

Defined in Data.OpenApi.Internal

Methods

(<>) :: Schema -> Schema -> Schema

sconcat :: NonEmpty Schema -> Schema

stimes :: Integral b => b -> Schema -> Schema

Monoid Schema

Defined in Data.OpenApi.Internal

Methods

mempty :: Schema

mappend :: Schema -> Schema -> Schema

mconcat :: [Schema] -> Schema

ToJSON Schema

Defined in Data.OpenApi.Internal

Methods

toJSON :: Schema -> Value

toEncoding :: Schema -> Encoding

toJSONList :: [Schema] -> Value

toEncodingList :: [Schema] -> Encoding

FromJSON Schema

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Schema

parseJSONList :: Value -> Parser [Schema]

Generic Schema

Defined in Data.OpenApi.Internal

Associated Types

type Code Schema :: [[Type]]

Methods

from :: Schema -> Rep Schema

to :: Rep Schema -> Schema

HasDatatypeInfo Schema

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Schema :: DatatypeInfo

Methods

datatypeInfo :: proxy Schema -> DatatypeInfo (Code Schema)

HasSwaggerAesonOptions Schema

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Schema -> SwaggerAesonOptions

aesonDefaults :: Proxy Schema -> POP Maybe (Code Schema)

SwaggerMonoid Schema

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Schema

swaggerMappend :: Schema -> Schema -> Schema

HasSchema NamedSchema Schema

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' NamedSchema Schema

(k ~ A_Lens, a ~ Maybe AdditionalProperties, b ~ Maybe AdditionalProperties) => LabelOptic "additionalProperties" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "allOf" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "anyOf" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "deprecated" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Discriminator, b ~ Maybe Discriminator) => LabelOptic "discriminator" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "example" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe ExternalDocs, b ~ Maybe ExternalDocs) => LabelOptic "externalDocs" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe OpenApiItems, b ~ Maybe OpenApiItems) => LabelOptic "items" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxProperties" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minProperties" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe (Referenced Schema), b ~ Maybe (Referenced Schema)) => LabelOptic "not" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "nullable" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe [Referenced Schema], b ~ Maybe [Referenced Schema]) => LabelOptic "oneOf" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Pattern, b ~ Maybe Pattern) => LabelOptic "pattern" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Schema), b ~ InsOrdHashMap Text (Referenced Schema)) => LabelOptic "properties" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "readOnly" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ [ParamName], b ~ [ParamName]) => LabelOptic "required" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "title" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe OpenApiType, b ~ Maybe OpenApiType) => LabelOptic "type" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "writeOnly" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

(k ~ A_Lens, a ~ Maybe Xml, b ~ Maybe Xml) => LabelOptic "xml" k Schema Schema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Schema Schema a b

HasExternalDocs Schema (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' Schema (Maybe ExternalDocs)

HasSchemas Components (Definitions Schema)

Defined in Data.OpenApi.Lens

Methods

schemas :: Lens' Components (Definitions Schema)

HasDescription Schema (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Schema (Maybe Text)

HasRequired Schema [ParamName]

Defined in Data.OpenApi.Lens

Methods

required :: Lens' Schema [ParamName]

HasSchema Header (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' Header (Maybe (Referenced Schema))

HasSchema Param (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' Param (Maybe (Referenced Schema))

HasSchema MediaTypeObject (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' MediaTypeObject (Maybe (Referenced Schema))

HasExample Schema (Maybe Value)

Defined in Data.OpenApi.Lens

Methods

example :: Lens' Schema (Maybe Value)

HasTitle Schema (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

title :: Lens' Schema (Maybe Text)

HasDeprecated Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

deprecated :: Lens' Schema (Maybe Bool)

HasXml Schema (Maybe Xml)

Defined in Data.OpenApi.Lens

Methods

xml :: Lens' Schema (Maybe Xml)

HasWriteOnly Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

writeOnly :: Lens' Schema (Maybe Bool)

HasUniqueItems Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

uniqueItems :: Lens' Schema (Maybe Bool)

HasType Schema (Maybe OpenApiType)

Defined in Data.OpenApi.Lens

Methods

type_ :: Lens' Schema (Maybe OpenApiType)

HasReadOnly Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

readOnly :: Lens' Schema (Maybe Bool)

HasPattern Schema (Maybe Pattern)

Defined in Data.OpenApi.Lens

Methods

pattern :: Lens' Schema (Maybe Pattern)

HasOneOf Schema (Maybe [Referenced Schema])

Defined in Data.OpenApi.Lens

Methods

oneOf :: Lens' Schema (Maybe [Referenced Schema])

HasNullable Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

nullable :: Lens' Schema (Maybe Bool)

HasNot Schema (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

not_ :: Lens' Schema (Maybe (Referenced Schema))

HasMultipleOf Schema (Maybe Scientific)

Defined in Data.OpenApi.Lens

Methods

multipleOf :: Lens' Schema (Maybe Scientific)

HasMinimum Schema (Maybe Scientific)

Defined in Data.OpenApi.Lens

Methods

minimum_ :: Lens' Schema (Maybe Scientific)

HasMinProperties Schema (Maybe Integer)

Defined in Data.OpenApi.Lens

Methods

minProperties :: Lens' Schema (Maybe Integer)

HasMinLength Schema (Maybe Integer)

Defined in Data.OpenApi.Lens

Methods

minLength :: Lens' Schema (Maybe Integer)

HasMinItems Schema (Maybe Integer)

Defined in Data.OpenApi.Lens

Methods

minItems :: Lens' Schema (Maybe Integer)

HasMaximum Schema (Maybe Scientific)

Defined in Data.OpenApi.Lens

Methods

maximum_ :: Lens' Schema (Maybe Scientific)

HasMaxProperties Schema (Maybe Integer)

Defined in Data.OpenApi.Lens

Methods

maxProperties :: Lens' Schema (Maybe Integer)

HasMaxLength Schema (Maybe Integer)

Defined in Data.OpenApi.Lens

Methods

maxLength :: Lens' Schema (Maybe Integer)

HasMaxItems Schema (Maybe Integer)

Defined in Data.OpenApi.Lens

Methods

maxItems :: Lens' Schema (Maybe Integer)

HasItems Schema (Maybe OpenApiItems)

Defined in Data.OpenApi.Lens

Methods

items :: Lens' Schema (Maybe OpenApiItems)

HasFormat Schema (Maybe Format)

Defined in Data.OpenApi.Lens

Methods

format :: Lens' Schema (Maybe Format)

HasExclusiveMinimum Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

exclusiveMinimum :: Lens' Schema (Maybe Bool)

HasExclusiveMaximum Schema (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

exclusiveMaximum :: Lens' Schema (Maybe Bool)

HasEnum Schema (Maybe [Value])

Defined in Data.OpenApi.Lens

Methods

enum_ :: Lens' Schema (Maybe [Value])

HasDiscriminator Schema (Maybe Discriminator)

Defined in Data.OpenApi.Lens

Methods

discriminator :: Lens' Schema (Maybe Discriminator)

HasDefault Schema (Maybe Value)

Defined in Data.OpenApi.Lens

Methods

default_ :: Lens' Schema (Maybe Value)

HasAnyOf Schema (Maybe [Referenced Schema])

Defined in Data.OpenApi.Lens

Methods

anyOf :: Lens' Schema (Maybe [Referenced Schema])

HasAllOf Schema (Maybe [Referenced Schema])

Defined in Data.OpenApi.Lens

Methods

allOf :: Lens' Schema (Maybe [Referenced Schema])

HasAdditionalProperties Schema (Maybe AdditionalProperties)

Defined in Data.OpenApi.Lens

Methods

additionalProperties :: Lens' Schema (Maybe AdditionalProperties)

HasProperties Schema (InsOrdHashMap Text (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema))

ToJSON (Referenced Schema)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Schema -> Value

toEncoding :: Referenced Schema -> Encoding

toJSONList :: [Referenced Schema] -> Value

toEncodingList :: [Referenced Schema] -> Encoding

FromJSON (Referenced Schema)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Schema)

parseJSONList :: Value -> Parser [Referenced Schema]

type Rep Schema

Defined in Data.OpenApi.Internal

type Rep Schema = D1 ('MetaData "Schema" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Schema" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "_schemaTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_schemaDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_schemaRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ParamName]) :*: S1 ('MetaSel ('Just "_schemaNullable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "_schemaAllOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Referenced Schema])) :*: S1 ('MetaSel ('Just "_schemaOneOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Referenced Schema]))) :*: (S1 ('MetaSel ('Just "_schemaNot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))) :*: S1 ('MetaSel ('Just "_schemaAnyOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Referenced Schema]))))) :*: (((S1 ('MetaSel ('Just "_schemaProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Schema))) :*: S1 ('MetaSel ('Just "_schemaAdditionalProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AdditionalProperties))) :*: (S1 ('MetaSel ('Just "_schemaDiscriminator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Discriminator)) :*: S1 ('MetaSel ('Just "_schemaReadOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "_schemaWriteOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_schemaXml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Xml))) :*: (S1 ('MetaSel ('Just "_schemaExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs)) :*: (S1 ('MetaSel ('Just "_schemaExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_schemaDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))) :*: ((((S1 ('MetaSel ('Just "_schemaMaxProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaMinProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_schemaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe OpenApiType)))) :*: ((S1 ('MetaSel ('Just "_schemaFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Format)) :*: S1 ('MetaSel ('Just "_schemaItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe OpenApiItems))) :*: (S1 ('MetaSel ('Just "_schemaMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)) :*: (S1 ('MetaSel ('Just "_schemaExclusiveMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_schemaMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)))))) :*: (((S1 ('MetaSel ('Just "_schemaExclusiveMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_schemaMaxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaMinLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pattern)))) :*: ((S1 ('MetaSel ('Just "_schemaMaxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "_schemaMinItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "_schemaUniqueItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "_schemaEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Value])) :*: S1 ('MetaSel ('Just "_schemaMultipleOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)))))))))

type Code Schema

Defined in Data.OpenApi.Internal

type Code Schema = '['[Maybe Text, Maybe Text, [ParamName], Maybe Bool, Maybe [Referenced Schema], Maybe [Referenced Schema], Maybe (Referenced Schema), Maybe [Referenced Schema], InsOrdHashMap Text (Referenced Schema), Maybe AdditionalProperties, Maybe Discriminator, Maybe Bool, Maybe Bool, Maybe Xml, Maybe ExternalDocs, Maybe Value, Maybe Bool, Maybe Integer, Maybe Integer, Maybe Value, Maybe OpenApiType, Maybe Format, Maybe OpenApiItems, Maybe Scientific, Maybe Bool, Maybe Scientific, Maybe Bool, Maybe Integer, Maybe Integer, Maybe Pattern, Maybe Integer, Maybe Integer, Maybe Bool, Maybe [Value], Maybe Scientific]]

type DatatypeInfoOf Schema

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Schema = 'ADT "Data.OpenApi.Internal" "Schema" '['Record "Schema" '['FieldInfo "_schemaTitle", 'FieldInfo "_schemaDescription", 'FieldInfo "_schemaRequired", 'FieldInfo "_schemaNullable", 'FieldInfo "_schemaAllOf", 'FieldInfo "_schemaOneOf", 'FieldInfo "_schemaNot", 'FieldInfo "_schemaAnyOf", 'FieldInfo "_schemaProperties", 'FieldInfo "_schemaAdditionalProperties", 'FieldInfo "_schemaDiscriminator", 'FieldInfo "_schemaReadOnly", 'FieldInfo "_schemaWriteOnly", 'FieldInfo "_schemaXml", 'FieldInfo "_schemaExternalDocs", 'FieldInfo "_schemaExample", 'FieldInfo "_schemaDeprecated", 'FieldInfo "_schemaMaxProperties", 'FieldInfo "_schemaMinProperties", 'FieldInfo "_schemaDefault", 'FieldInfo "_schemaType", 'FieldInfo "_schemaFormat", 'FieldInfo "_schemaItems", 'FieldInfo "_schemaMaximum", 'FieldInfo "_schemaExclusiveMaximum", 'FieldInfo "_schemaMinimum", 'FieldInfo "_schemaExclusiveMinimum", 'FieldInfo "_schemaMaxLength", 'FieldInfo "_schemaMinLength", 'FieldInfo "_schemaPattern", 'FieldInfo "_schemaMaxItems", 'FieldInfo "_schemaMinItems", 'FieldInfo "_schemaUniqueItems", 'FieldInfo "_schemaEnum", 'FieldInfo "_schemaMultipleOf"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data NamedSchema

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

Constructors

NamedSchema

Fields

• _namedSchemaName :: Maybe Text
• _namedSchemaSchema :: Schema

Instances

Eq NamedSchema

Defined in Data.OpenApi.Internal

Methods

(==) :: NamedSchema -> NamedSchema -> Bool

(/=) :: NamedSchema -> NamedSchema -> Bool

Data NamedSchema

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: NamedSchema -> Constr

dataTypeOf :: NamedSchema -> DataType

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

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

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

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

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

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

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

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

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

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

Show NamedSchema

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> NamedSchema -> ShowS

show :: NamedSchema -> String

showList :: [NamedSchema] -> ShowS

Generic NamedSchema

Defined in Data.OpenApi.Internal

Associated Types

type Rep NamedSchema :: Type -> Type

Methods

from :: NamedSchema -> Rep NamedSchema x

to :: Rep NamedSchema x -> NamedSchema

HasSchema NamedSchema Schema

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' NamedSchema Schema

(a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe [Value], b ~ Maybe [Value]) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe OpenApiItems, b ~ Maybe OpenApiItems) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx NamedSchema NamedSchema a b

(a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(k ~ A_Lens, a ~ Schema, b ~ Schema) => LabelOptic "schema" k NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx NamedSchema NamedSchema a b

(a ~ Maybe OpenApiType, b ~ Maybe OpenApiType) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b

HasName NamedSchema (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

name :: Lens' NamedSchema (Maybe Text)

HasType NamedSchema (Maybe OpenApiType)

Defined in Data.OpenApi.Lens

Methods

type_ :: Lens' NamedSchema (Maybe OpenApiType)

type Rep NamedSchema

Defined in Data.OpenApi.Internal

type Rep NamedSchema = D1 ('MetaData "NamedSchema" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" '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 OpenApiItems where

Items for OpenApiArray schemas.

Warning: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as it will incorporate Json Schema mostly verbatim.

OpenApiItemsObject should be used to specify homogenous array Schemas.

OpenApiItemsArray should be used to specify tuple Schemas.

Constructors

OpenApiItemsObject :: Referenced Schema -> OpenApiItems

OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems

Instances

Eq OpenApiItems

Defined in Data.OpenApi.Internal

Methods

(==) :: OpenApiItems -> OpenApiItems -> Bool

(/=) :: OpenApiItems -> OpenApiItems -> Bool

Data OpenApiItems

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OpenApiItems -> Constr

dataTypeOf :: OpenApiItems -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OpenApiItems -> OpenApiItems

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

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

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

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

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

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

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

Show OpenApiItems

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OpenApiItems -> ShowS

show :: OpenApiItems -> String

showList :: [OpenApiItems] -> ShowS

ToJSON OpenApiItems

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

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

Defined in Data.OpenApi.Internal

Methods

toJSON :: OpenApiItems -> Value

toEncoding :: OpenApiItems -> Encoding

toJSONList :: [OpenApiItems] -> Value

toEncodingList :: [OpenApiItems] -> Encoding

FromJSON OpenApiItems

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OpenApiItems

parseJSONList :: Value -> Parser [OpenApiItems]

(a ~ [Referenced Schema], b ~ [Referenced Schema]) => LabelOptic "_OpenApiItemsArray" A_Review OpenApiItems OpenApiItems a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Review NoIx OpenApiItems OpenApiItems a b

(a ~ Referenced Schema, b ~ Referenced Schema) => LabelOptic "_OpenApiItemsObject" A_Review OpenApiItems OpenApiItems a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic A_Review NoIx OpenApiItems OpenApiItems a b

HasSchema s Schema => HasItems s (Maybe OpenApiItems)

Defined in Data.OpenApi.Lens

Methods

items :: Lens' s (Maybe OpenApiItems)

HasItems Schema (Maybe OpenApiItems)

Defined in Data.OpenApi.Lens

Methods

items :: Lens' Schema (Maybe OpenApiItems)

data Xml

Constructors

Xml

Fields

• _xmlName :: Maybe Text

  Replaces the name of the element/attribute used for the described schema property. When defined within the OpenApiItems (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

Defined in Data.OpenApi.Internal

Methods

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

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

Data Xml

Defined in Data.OpenApi.Internal

Methods

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

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

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 :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Xml -> r

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

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

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

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

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

Show Xml

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Xml -> ShowS

show :: Xml -> String

showList :: [Xml] -> ShowS

Generic Xml

Defined in Data.OpenApi.Internal

Associated Types

type Rep Xml :: Type -> Type

Methods

from :: Xml -> Rep Xml x

to :: Rep Xml x -> Xml

ToJSON Xml

Defined in Data.OpenApi.Internal

Methods

toJSON :: Xml -> Value

toEncoding :: Xml -> Encoding

toJSONList :: [Xml] -> Value

toEncodingList :: [Xml] -> Encoding

FromJSON Xml

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Xml

parseJSONList :: Value -> Parser [Xml]

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "attribute" k Xml Xml a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Xml Xml a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "name" k Xml Xml a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Xml Xml a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "namespace" k Xml Xml a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Xml Xml a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "prefix" k Xml Xml a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Xml Xml a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "wrapped" k Xml Xml a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Xml Xml a b

HasName Xml (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

name :: Lens' Xml (Maybe Text)

HasXml Schema (Maybe Xml)

Defined in Data.OpenApi.Lens

Methods

xml :: Lens' Schema (Maybe Xml)

HasWrapped Xml (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

wrapped :: Lens' Xml (Maybe Bool)

HasPrefix Xml (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

prefix :: Lens' Xml (Maybe Text)

HasNamespace Xml (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

namespace :: Lens' Xml (Maybe Text)

HasAttribute Xml (Maybe Bool)

Defined in Data.OpenApi.Lens

Methods

attribute :: Lens' Xml (Maybe Bool)

type Rep Xml

Defined in Data.OpenApi.Internal

type Rep Xml = D1 ('MetaData "Xml" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Xml" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_xmlName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_xmlNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_xmlPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_xmlAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_xmlWrapped") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

type Pattern = Text

Regex pattern for string type.

data AdditionalProperties

Constructors

AdditionalPropertiesAllowed Bool

AdditionalPropertiesSchema (Referenced Schema)

Instances

Eq AdditionalProperties

Defined in Data.OpenApi.Internal

Methods

(==) :: AdditionalProperties -> AdditionalProperties -> Bool

(/=) :: AdditionalProperties -> AdditionalProperties -> Bool

Data AdditionalProperties

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: AdditionalProperties -> Constr

dataTypeOf :: AdditionalProperties -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> AdditionalProperties -> AdditionalProperties

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

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

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

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

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

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

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

Show AdditionalProperties

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> AdditionalProperties -> ShowS

show :: AdditionalProperties -> String

showList :: [AdditionalProperties] -> ShowS

ToJSON AdditionalProperties

Defined in Data.OpenApi.Internal

Methods

toJSON :: AdditionalProperties -> Value

toEncoding :: AdditionalProperties -> Encoding

toJSONList :: [AdditionalProperties] -> Value

toEncodingList :: [AdditionalProperties] -> Encoding

FromJSON AdditionalProperties

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser AdditionalProperties

parseJSONList :: Value -> Parser [AdditionalProperties]

HasAdditionalProperties Schema (Maybe AdditionalProperties)

Defined in Data.OpenApi.Lens

Methods

additionalProperties :: Lens' Schema (Maybe AdditionalProperties)

data Discriminator

Constructors

Discriminator

Fields

• _discriminatorPropertyName :: Text

  The name of the property in the payload that will hold the discriminator value.

• _discriminatorMapping :: InsOrdHashMap Text Text

  An object to hold mappings between payload values and schema names or references.

Instances

Eq Discriminator

Defined in Data.OpenApi.Internal

Methods

(==) :: Discriminator -> Discriminator -> Bool

(/=) :: Discriminator -> Discriminator -> Bool

Data Discriminator

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Discriminator -> Constr

dataTypeOf :: Discriminator -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Discriminator -> Discriminator

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

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

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

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

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

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

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

Show Discriminator

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Discriminator -> ShowS

show :: Discriminator -> String

showList :: [Discriminator] -> ShowS

Generic Discriminator

Defined in Data.OpenApi.Internal

Associated Types

type Rep Discriminator :: Type -> Type

Methods

from :: Discriminator -> Rep Discriminator x

to :: Rep Discriminator x -> Discriminator

ToJSON Discriminator

Defined in Data.OpenApi.Internal

Methods

toJSON :: Discriminator -> Value

toEncoding :: Discriminator -> Encoding

toJSONList :: [Discriminator] -> Value

toEncodingList :: [Discriminator] -> Encoding

FromJSON Discriminator

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Discriminator

parseJSONList :: Value -> Parser [Discriminator]

HasPropertyName Discriminator Text

Defined in Data.OpenApi.Lens

Methods

propertyName :: Lens' Discriminator Text

(k ~ A_Lens, a ~ InsOrdHashMap Text Text, b ~ InsOrdHashMap Text Text) => LabelOptic "mapping" k Discriminator Discriminator a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Discriminator Discriminator a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "propertyName" k Discriminator Discriminator a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Discriminator Discriminator a b

HasDiscriminator Schema (Maybe Discriminator)

Defined in Data.OpenApi.Lens

Methods

discriminator :: Lens' Schema (Maybe Discriminator)

HasMapping Discriminator (InsOrdHashMap Text Text)

Defined in Data.OpenApi.Lens

Methods

mapping :: Lens' Discriminator (InsOrdHashMap Text Text)

type Rep Discriminator

Defined in Data.OpenApi.Internal

type Rep Discriminator = D1 ('MetaData "Discriminator" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Discriminator" 'PrefixI 'True) (S1 ('MetaSel ('Just "_discriminatorPropertyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_discriminatorMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Text))))

Responses

data Responses

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

Constructors

Responses

Fields

• _responsesDefault :: Maybe (Referenced Response)

  The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses.

• _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)

  Any HTTP status code can be used as the property name (one property per HTTP status code). Describes the expected response for those HTTP status codes.

Instances

Eq Responses

Defined in Data.OpenApi.Internal

Methods

(==) :: Responses -> Responses -> Bool

(/=) :: Responses -> Responses -> Bool

Data Responses

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Responses -> Constr

dataTypeOf :: Responses -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Responses -> Responses

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

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

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

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

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

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

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

Show Responses

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Responses -> ShowS

show :: Responses -> String

showList :: [Responses] -> ShowS

Generic Responses

Defined in Data.OpenApi.Internal

Associated Types

type Rep Responses :: Type -> Type

Methods

from :: Responses -> Rep Responses x

to :: Rep Responses x -> Responses

Semigroup Responses

Defined in Data.OpenApi.Internal

Methods

(<>) :: Responses -> Responses -> Responses

sconcat :: NonEmpty Responses -> Responses

stimes :: Integral b => b -> Responses -> Responses

Monoid Responses

Defined in Data.OpenApi.Internal

Methods

mempty :: Responses

mappend :: Responses -> Responses -> Responses

mconcat :: [Responses] -> Responses

ToJSON Responses

Defined in Data.OpenApi.Internal

Methods

toJSON :: Responses -> Value

toEncoding :: Responses -> Encoding

toJSONList :: [Responses] -> Value

toEncodingList :: [Responses] -> Encoding

FromJSON Responses

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Responses

parseJSONList :: Value -> Parser [Responses]

Generic Responses

Defined in Data.OpenApi.Internal

Associated Types

type Code Responses :: [[Type]]

Methods

from :: Responses -> Rep Responses

to :: Rep Responses -> Responses

HasDatatypeInfo Responses

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Responses :: DatatypeInfo

Methods

datatypeInfo :: proxy Responses -> DatatypeInfo (Code Responses)

Ixed Responses

Defined in Data.OpenApi.Lens

Methods

ix :: Index Responses -> Traversal' Responses (IxValue Responses)

At Responses

Defined in Data.OpenApi.Lens

Methods

at :: Index Responses -> Lens' Responses (Maybe (IxValue Responses))

Ixed Responses

Defined in Data.OpenApi.Optics

Associated Types

type IxKind Responses

Methods

ix :: Index Responses -> Optic' (IxKind Responses) NoIx Responses (IxValue Responses)

At Responses

Defined in Data.OpenApi.Optics

Methods

at :: Index Responses -> Lens' Responses (Maybe (IxValue Responses))

AesonDefaultValue Responses

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Responses

HasSwaggerAesonOptions Responses

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Responses -> SwaggerAesonOptions

aesonDefaults :: Proxy Responses -> POP Maybe (Code Responses)

SwaggerMonoid Responses

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Responses

swaggerMappend :: Responses -> Responses -> Responses

HasResponses Operation Responses

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Operation Responses

(k ~ A_Lens, a ~ Maybe (Referenced Response), b ~ Maybe (Referenced Response)) => LabelOptic "default" k Responses Responses a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Responses Responses a b

(k ~ A_Lens, a ~ InsOrdHashMap HttpStatusCode (Referenced Response), b ~ InsOrdHashMap HttpStatusCode (Referenced Response)) => LabelOptic "responses" k Responses Responses a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Responses Responses a b

HasDefault Responses (Maybe (Referenced Response))

Defined in Data.OpenApi.Lens

Methods

default_ :: Lens' Responses (Maybe (Referenced Response))

HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response))

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response))

type Rep Responses

Defined in Data.OpenApi.Internal

type Rep Responses = D1 ('MetaData "Responses" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Responses" 'PrefixI 'True) (S1 ('MetaSel ('Just "_responsesDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Response))) :*: S1 ('MetaSel ('Just "_responsesResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HttpStatusCode (Referenced Response)))))

type Code Responses

Defined in Data.OpenApi.Internal

type Code Responses = '['[Maybe (Referenced Response), InsOrdHashMap HttpStatusCode (Referenced Response)]]

type DatatypeInfoOf Responses

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Responses = 'ADT "Data.OpenApi.Internal" "Responses" '['Record "Responses" '['FieldInfo "_responsesDefault", 'FieldInfo "_responsesResponses"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

type Index Responses

Defined in Data.OpenApi.Lens

type Index Responses = HttpStatusCode

type IxValue Responses

Defined in Data.OpenApi.Lens

type IxValue Responses = Referenced Response

type Index Responses

Defined in Data.OpenApi.Optics

type Index Responses = HttpStatusCode

type IxValue Responses

Defined in Data.OpenApi.Optics

type IxValue Responses = Referenced Response

type IxKind Responses

Defined in Data.OpenApi.Optics

type IxKind Responses = An_AffineTraversal

data Response

Describes a single response from an API Operation.

Constructors

Response

Fields

• _responseDescription :: Text

  A short description of the response. CommonMark syntax can be used for rich text representation.

• _responseContent :: InsOrdHashMap MediaType MediaTypeObject

  A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*.

• _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)

  Maps a header name to its definition.

• _responseLinks :: InsOrdHashMap Text (Referenced Link)

  A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.

Instances

Eq Response

Defined in Data.OpenApi.Internal

Methods

(==) :: Response -> Response -> Bool

(/=) :: Response -> Response -> Bool

Data Response

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Response -> Constr

dataTypeOf :: Response -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Response -> Response

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

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

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

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

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

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

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

Show Response

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

IsString Response

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Response

Generic Response

Defined in Data.OpenApi.Internal

Associated Types

type Rep Response :: Type -> Type

Methods

from :: Response -> Rep Response x

to :: Rep Response x -> Response

Semigroup Response

Defined in Data.OpenApi.Internal

Methods

(<>) :: Response -> Response -> Response

sconcat :: NonEmpty Response -> Response

stimes :: Integral b => b -> Response -> Response

Monoid Response

Defined in Data.OpenApi.Internal

Methods

mempty :: Response

mappend :: Response -> Response -> Response

mconcat :: [Response] -> Response

ToJSON Response

Defined in Data.OpenApi.Internal

Methods

toJSON :: Response -> Value

toEncoding :: Response -> Encoding

toJSONList :: [Response] -> Value

toEncodingList :: [Response] -> Encoding

FromJSON Response

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Response

parseJSONList :: Value -> Parser [Response]

Generic Response

Defined in Data.OpenApi.Internal

Associated Types

type Code Response :: [[Type]]

Methods

from :: Response -> Rep Response

to :: Rep Response -> Response

HasDatatypeInfo Response

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Response :: DatatypeInfo

Methods

datatypeInfo :: proxy Response -> DatatypeInfo (Code Response)

HasSwaggerAesonOptions Response

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Response -> SwaggerAesonOptions

aesonDefaults :: Proxy Response -> POP Maybe (Code Response)

SwaggerMonoid Response

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Response

swaggerMappend :: Response -> Response -> Response

HasDescription Response Text

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Response Text

(k ~ A_Lens, a ~ InsOrdHashMap MediaType MediaTypeObject, b ~ InsOrdHashMap MediaType MediaTypeObject) => LabelOptic "content" k Response Response a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Response Response a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "description" k Response Response a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Response Response a b

(k ~ A_Lens, a ~ InsOrdHashMap HeaderName (Referenced Header), b ~ InsOrdHashMap HeaderName (Referenced Header)) => LabelOptic "headers" k Response Response a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Response Response a b

(k ~ A_Lens, a ~ InsOrdHashMap Text (Referenced Link), b ~ InsOrdHashMap Text (Referenced Link)) => LabelOptic "links" k Response Response a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Response Response a b

HasResponses Components (Definitions Response)

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Components (Definitions Response)

HasDefault Responses (Maybe (Referenced Response))

Defined in Data.OpenApi.Lens

Methods

default_ :: Lens' Responses (Maybe (Referenced Response))

HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response))

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response))

HasLinks Response (InsOrdHashMap Text (Referenced Link))

Defined in Data.OpenApi.Lens

Methods

links :: Lens' Response (InsOrdHashMap Text (Referenced Link))

HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header))

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header))

HasContent Response (InsOrdHashMap MediaType MediaTypeObject)

Defined in Data.OpenApi.Lens

Methods

content :: Lens' Response (InsOrdHashMap MediaType MediaTypeObject)

ToJSON (Referenced Response)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Response -> Value

toEncoding :: Referenced Response -> Encoding

toJSONList :: [Referenced Response] -> Value

toEncodingList :: [Referenced Response] -> Encoding

FromJSON (Referenced Response)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Response)

parseJSONList :: Value -> Parser [Referenced Response]

type Rep Response

Defined in Data.OpenApi.Internal

type Rep Response = D1 ('MetaData "Response" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Response" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_responseDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_responseContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap MediaType MediaTypeObject))) :*: (S1 ('MetaSel ('Just "_responseHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HeaderName (Referenced Header))) :*: S1 ('MetaSel ('Just "_responseLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Link))))))

type Code Response

Defined in Data.OpenApi.Internal

type Code Response = '['[Text, InsOrdHashMap MediaType MediaTypeObject, InsOrdHashMap HeaderName (Referenced Header), InsOrdHashMap Text (Referenced Link)]]

type DatatypeInfoOf Response

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Response = 'ADT "Data.OpenApi.Internal" "Response" '['Record "Response" '['FieldInfo "_responseDescription", 'FieldInfo "_responseContent", 'FieldInfo "_responseHeaders", 'FieldInfo "_responseLinks"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

type HttpStatusCode = Int

data Link

The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

Constructors

Link

Fields

• _linkOperationRef :: Maybe Text

  A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the _linkOperationId field, and MUST point to an Operation Object. Relative _linkOperationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.

• _linkOperationId :: Maybe Text

  The name of an existing, resolvable OAS operation, as defined with a unique _operationOperationId. This field is mutually exclusive of the _linkOperationRef field.

• _linkParameters :: InsOrdHashMap Text ExpressionOrValue

  A map representing parameters to pass to an operation as specified with _linkOperationId or identified via _linkOperationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).

• _linkRequestBody :: Maybe ExpressionOrValue

  A literal value or {expression} to use as a request body when calling the target operation.

• _linkDescription :: Maybe Text

  A description of the link.

• _linkServer :: Maybe Server

  A server object to be used by the target operation.

Instances

Eq Link

Defined in Data.OpenApi.Internal

Methods

(==) :: Link -> Link -> Bool

(/=) :: Link -> Link -> Bool

Data Link

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Link -> Constr

dataTypeOf :: Link -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Link -> Link

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

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

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

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

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

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

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

Show Link

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

Generic Link

Defined in Data.OpenApi.Internal

Associated Types

type Rep Link :: Type -> Type

Methods

from :: Link -> Rep Link x

to :: Rep Link x -> Link

ToJSON Link

Defined in Data.OpenApi.Internal

Methods

toJSON :: Link -> Value

toEncoding :: Link -> Encoding

toJSONList :: [Link] -> Value

toEncodingList :: [Link] -> Encoding

FromJSON Link

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Link

parseJSONList :: Value -> Parser [Link]

Generic Link

Defined in Data.OpenApi.Internal

Associated Types

type Code Link :: [[Type]]

Methods

from :: Link -> Rep Link

to :: Rep Link -> Link

HasDatatypeInfo Link

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Link :: DatatypeInfo

Methods

datatypeInfo :: proxy Link -> DatatypeInfo (Code Link)

AesonDefaultValue Link

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe Link

HasSwaggerAesonOptions Link

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy Link -> SwaggerAesonOptions

aesonDefaults :: Proxy Link -> POP Maybe (Code Link)

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k Link Link a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Link Link a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationId" k Link Link a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Link Link a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "operationRef" k Link Link a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Link Link a b

(k ~ A_Lens, a ~ InsOrdHashMap Text ExpressionOrValue, b ~ InsOrdHashMap Text ExpressionOrValue) => LabelOptic "parameters" k Link Link a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Link Link a b

(k ~ A_Lens, a ~ Maybe ExpressionOrValue, b ~ Maybe ExpressionOrValue) => LabelOptic "requestBody" k Link Link a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Link Link a b

(k ~ A_Lens, a ~ Maybe Server, b ~ Maybe Server) => LabelOptic "server" k Link Link a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Link Link a b

HasLinks Components (Definitions Link)

Defined in Data.OpenApi.Lens

Methods

links :: Lens' Components (Definitions Link)

HasDescription Link (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' Link (Maybe Text)

HasRequestBody Link (Maybe ExpressionOrValue)

Defined in Data.OpenApi.Lens

Methods

requestBody :: Lens' Link (Maybe ExpressionOrValue)

HasOperationId Link (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

operationId :: Lens' Link (Maybe Text)

HasServer Link (Maybe Server)

Defined in Data.OpenApi.Lens

Methods

server :: Lens' Link (Maybe Server)

HasOperationRef Link (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

operationRef :: Lens' Link (Maybe Text)

HasParameters Link (InsOrdHashMap Text ExpressionOrValue)

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' Link (InsOrdHashMap Text ExpressionOrValue)

HasLinks Response (InsOrdHashMap Text (Referenced Link))

Defined in Data.OpenApi.Lens

Methods

links :: Lens' Response (InsOrdHashMap Text (Referenced Link))

ToJSON (Referenced Link)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Link -> Value

toEncoding :: Referenced Link -> Encoding

toJSONList :: [Referenced Link] -> Value

toEncodingList :: [Referenced Link] -> Encoding

FromJSON (Referenced Link)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Link)

parseJSONList :: Value -> Parser [Referenced Link]

type Rep Link

Defined in Data.OpenApi.Internal

type Rep Link = D1 ('MetaData "Link" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "Link" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_linkOperationRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_linkOperationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_linkParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text ExpressionOrValue)))) :*: (S1 ('MetaSel ('Just "_linkRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExpressionOrValue)) :*: (S1 ('MetaSel ('Just "_linkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_linkServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Server))))))

type Code Link

Defined in Data.OpenApi.Internal

type Code Link = '['[Maybe Text, Maybe Text, InsOrdHashMap Text ExpressionOrValue, Maybe ExpressionOrValue, Maybe Text, Maybe Server]]

type DatatypeInfoOf Link

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Link = 'ADT "Data.OpenApi.Internal" "Link" '['Record "Link" '['FieldInfo "_linkOperationRef", 'FieldInfo "_linkOperationId", 'FieldInfo "_linkParameters", 'FieldInfo "_linkRequestBody", 'FieldInfo "_linkDescription", 'FieldInfo "_linkServer"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

newtype Callback

A map of possible out-of band callbacks related to the parent operation. Each value in the map is a PathItem Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.

Constructors

Callback (InsOrdHashMap Text PathItem)

Instances

Eq Callback

Defined in Data.OpenApi.Internal

Methods

(==) :: Callback -> Callback -> Bool

(/=) :: Callback -> Callback -> Bool

Data Callback

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Callback -> Constr

dataTypeOf :: Callback -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Callback -> Callback

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

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

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

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

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

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

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

Show Callback

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Callback -> ShowS

show :: Callback -> String

showList :: [Callback] -> ShowS

Generic Callback

Defined in Data.OpenApi.Internal

Associated Types

type Rep Callback :: Type -> Type

Methods

from :: Callback -> Rep Callback x

to :: Rep Callback x -> Callback

ToJSON Callback

Defined in Data.OpenApi.Internal

Methods

toJSON :: Callback -> Value

toEncoding :: Callback -> Encoding

toJSONList :: [Callback] -> Value

toEncodingList :: [Callback] -> Encoding

FromJSON Callback

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Callback

parseJSONList :: Value -> Parser [Callback]

HasCallbacks Components (Definitions Callback)

Defined in Data.OpenApi.Lens

Methods

callbacks :: Lens' Components (Definitions Callback)

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback))

Defined in Data.OpenApi.Lens

Methods

callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback))

ToJSON (Referenced Callback)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Callback -> Value

toEncoding :: Referenced Callback -> Encoding

toJSONList :: [Referenced Callback] -> Value

toEncodingList :: [Referenced Callback] -> Encoding

FromJSON (Referenced Callback)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Callback)

parseJSONList :: Value -> Parser [Referenced Callback]

type Rep Callback

Defined in Data.OpenApi.Internal

type Rep Callback = D1 ('MetaData "Callback" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'True) (C1 ('MetaCons "Callback" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text PathItem))))

Security

data SecurityScheme

Constructors

SecurityScheme

Fields

• _securitySchemeType :: SecuritySchemeType

  The type of the security scheme.

• _securitySchemeDescription :: Maybe Text

  A short description for security scheme.

Instances

Eq SecurityScheme

Defined in Data.OpenApi.Internal

Methods

(==) :: SecurityScheme -> SecurityScheme -> Bool

(/=) :: SecurityScheme -> SecurityScheme -> Bool

Data SecurityScheme

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: SecurityScheme -> Constr

dataTypeOf :: SecurityScheme -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SecurityScheme -> SecurityScheme

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

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

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

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

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

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

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

Show SecurityScheme

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> SecurityScheme -> ShowS

show :: SecurityScheme -> String

showList :: [SecurityScheme] -> ShowS

Generic SecurityScheme

Defined in Data.OpenApi.Internal

Associated Types

type Rep SecurityScheme :: Type -> Type

Methods

from :: SecurityScheme -> Rep SecurityScheme x

to :: Rep SecurityScheme x -> SecurityScheme

Semigroup SecurityScheme

Defined in Data.OpenApi.Internal

Methods

(<>) :: SecurityScheme -> SecurityScheme -> SecurityScheme

sconcat :: NonEmpty SecurityScheme -> SecurityScheme

stimes :: Integral b => b -> SecurityScheme -> SecurityScheme

ToJSON SecurityScheme

Defined in Data.OpenApi.Internal

Methods

toJSON :: SecurityScheme -> Value

toEncoding :: SecurityScheme -> Encoding

toJSONList :: [SecurityScheme] -> Value

toEncodingList :: [SecurityScheme] -> Encoding

FromJSON SecurityScheme

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser SecurityScheme

parseJSONList :: Value -> Parser [SecurityScheme]

Generic SecurityScheme

Defined in Data.OpenApi.Internal

Associated Types

type Code SecurityScheme :: [[Type]]

Methods

from :: SecurityScheme -> Rep SecurityScheme

to :: Rep SecurityScheme -> SecurityScheme

HasDatatypeInfo SecurityScheme

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf SecurityScheme :: DatatypeInfo

Methods

datatypeInfo :: proxy SecurityScheme -> DatatypeInfo (Code SecurityScheme)

HasSwaggerAesonOptions SecurityScheme

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy SecurityScheme -> SwaggerAesonOptions

aesonDefaults :: Proxy SecurityScheme -> POP Maybe (Code SecurityScheme)

HasType SecurityScheme SecuritySchemeType

Defined in Data.OpenApi.Lens

Methods

type_ :: Lens' SecurityScheme SecuritySchemeType

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k SecurityScheme SecurityScheme a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b

(k ~ A_Lens, a ~ SecuritySchemeType, b ~ SecuritySchemeType) => LabelOptic "type" k SecurityScheme SecurityScheme a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b

HasSecuritySchemes Components (Definitions SecurityScheme)

Defined in Data.OpenApi.Lens

Methods

securitySchemes :: Lens' Components (Definitions SecurityScheme)

HasDescription SecurityScheme (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' SecurityScheme (Maybe Text)

type Rep SecurityScheme

Defined in Data.OpenApi.Internal

type Rep SecurityScheme = D1 ('MetaData "SecurityScheme" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "SecurityScheme" 'PrefixI 'True) (S1 ('MetaSel ('Just "_securitySchemeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecuritySchemeType) :*: S1 ('MetaSel ('Just "_securitySchemeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

type Code SecurityScheme

Defined in Data.OpenApi.Internal

type Code SecurityScheme = '['[SecuritySchemeType, Maybe Text]]

type DatatypeInfoOf SecurityScheme

Defined in Data.OpenApi.Internal

type DatatypeInfoOf SecurityScheme = 'ADT "Data.OpenApi.Internal" "SecurityScheme" '['Record "SecurityScheme" '['FieldInfo "_securitySchemeType", 'FieldInfo "_securitySchemeDescription"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data SecuritySchemeType

>>> encode (SecuritySchemeHttp (HttpSchemeBearer Nothing))
"{\"scheme\":\"bearer\",\"type\":\"http\"}"

>>> encode (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt")))
"{\"scheme\":\"bearer\",\"type\":\"http\",\"bearerFormat\":\"jwt\"}"

>>> encode (SecuritySchemeHttp HttpSchemeBasic)
"{\"scheme\":\"basic\",\"type\":\"http\"}"

>>> encode (SecuritySchemeHttp (HttpSchemeCustom "CANARY"))
"{\"scheme\":\"CANARY\",\"type\":\"http\"}"

>>> encode (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie))
"{\"in\":\"cookie\",\"name\":\"id\",\"type\":\"apiKey\"}"

Constructors

SecuritySchemeHttp HttpSchemeType

SecuritySchemeApiKey ApiKeyParams

SecuritySchemeOAuth2 OAuth2Flows

SecuritySchemeOpenIdConnect URL

Instances

Eq SecuritySchemeType

Defined in Data.OpenApi.Internal

Methods

(==) :: SecuritySchemeType -> SecuritySchemeType -> Bool

(/=) :: SecuritySchemeType -> SecuritySchemeType -> Bool

Data SecuritySchemeType

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: SecuritySchemeType -> Constr

dataTypeOf :: SecuritySchemeType -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SecuritySchemeType -> SecuritySchemeType

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

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

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

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

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

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

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

Show SecuritySchemeType

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> SecuritySchemeType -> ShowS

show :: SecuritySchemeType -> String

showList :: [SecuritySchemeType] -> ShowS

Generic SecuritySchemeType

Defined in Data.OpenApi.Internal

Associated Types

type Rep SecuritySchemeType :: Type -> Type

Methods

from :: SecuritySchemeType -> Rep SecuritySchemeType x

to :: Rep SecuritySchemeType x -> SecuritySchemeType

ToJSON SecuritySchemeType

Defined in Data.OpenApi.Internal

Methods

toJSON :: SecuritySchemeType -> Value

toEncoding :: SecuritySchemeType -> Encoding

toJSONList :: [SecuritySchemeType] -> Value

toEncodingList :: [SecuritySchemeType] -> Encoding

FromJSON SecuritySchemeType

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser SecuritySchemeType

parseJSONList :: Value -> Parser [SecuritySchemeType]

AesonDefaultValue SecuritySchemeType

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe SecuritySchemeType

HasType SecurityScheme SecuritySchemeType

Defined in Data.OpenApi.Lens

Methods

type_ :: Lens' SecurityScheme SecuritySchemeType

(k ~ A_Prism, a ~ ApiKeyParams, b ~ ApiKeyParams) => LabelOptic "_SecuritySchemeApiKey" k SecuritySchemeType SecuritySchemeType a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b

(k ~ A_Prism, a ~ HttpSchemeType, b ~ HttpSchemeType) => LabelOptic "_SecuritySchemeHttp" k SecuritySchemeType SecuritySchemeType a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b

(k ~ A_Prism, a ~ OAuth2Flows, b ~ OAuth2Flows) => LabelOptic "_SecuritySchemeOAuth2" k SecuritySchemeType SecuritySchemeType a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b

(k ~ A_Prism, a ~ URL, b ~ URL) => LabelOptic "_SecuritySchemeOpenIdConnect" k SecuritySchemeType SecuritySchemeType a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b

type Rep SecuritySchemeType

Defined in Data.OpenApi.Internal

type Rep SecuritySchemeType = D1 ('MetaData "SecuritySchemeType" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) ((C1 ('MetaCons "SecuritySchemeHttp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HttpSchemeType)) :+: C1 ('MetaCons "SecuritySchemeApiKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiKeyParams))) :+: (C1 ('MetaCons "SecuritySchemeOAuth2" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2Flows)) :+: C1 ('MetaCons "SecuritySchemeOpenIdConnect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URL))))

data HttpSchemeType

Constructors

HttpSchemeBearer (Maybe BearerFormat)

HttpSchemeBasic

HttpSchemeCustom Text

Instances

Eq HttpSchemeType

Defined in Data.OpenApi.Internal

Methods

(==) :: HttpSchemeType -> HttpSchemeType -> Bool

(/=) :: HttpSchemeType -> HttpSchemeType -> Bool

Data HttpSchemeType

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: HttpSchemeType -> Constr

dataTypeOf :: HttpSchemeType -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> HttpSchemeType -> HttpSchemeType

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

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

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

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

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

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

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

Show HttpSchemeType

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> HttpSchemeType -> ShowS

show :: HttpSchemeType -> String

showList :: [HttpSchemeType] -> ShowS

Generic HttpSchemeType

Defined in Data.OpenApi.Internal

Associated Types

type Rep HttpSchemeType :: Type -> Type

Methods

from :: HttpSchemeType -> Rep HttpSchemeType x

to :: Rep HttpSchemeType x -> HttpSchemeType

type Rep HttpSchemeType

Defined in Data.OpenApi.Internal

type Rep HttpSchemeType = D1 ('MetaData "HttpSchemeType" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "HttpSchemeBearer" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BearerFormat))) :+: (C1 ('MetaCons "HttpSchemeBasic" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HttpSchemeCustom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

newtype SecurityDefinitions

Constructors

SecurityDefinitions (Definitions SecurityScheme)

Instances

Eq SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

(==) :: SecurityDefinitions -> SecurityDefinitions -> Bool

(/=) :: SecurityDefinitions -> SecurityDefinitions -> Bool

Data SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: SecurityDefinitions -> Constr

dataTypeOf :: SecurityDefinitions -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SecurityDefinitions -> SecurityDefinitions

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

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

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

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

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

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

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

Show SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> SecurityDefinitions -> ShowS

show :: SecurityDefinitions -> String

showList :: [SecurityDefinitions] -> ShowS

Generic SecurityDefinitions

Defined in Data.OpenApi.Internal

Associated Types

type Rep SecurityDefinitions :: Type -> Type

Methods

from :: SecurityDefinitions -> Rep SecurityDefinitions x

to :: Rep SecurityDefinitions x -> SecurityDefinitions

Semigroup SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

(<>) :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions

sconcat :: NonEmpty SecurityDefinitions -> SecurityDefinitions

stimes :: Integral b => b -> SecurityDefinitions -> SecurityDefinitions

Monoid SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

mempty :: SecurityDefinitions

mappend :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions

mconcat :: [SecurityDefinitions] -> SecurityDefinitions

ToJSON SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

toJSON :: SecurityDefinitions -> Value

toEncoding :: SecurityDefinitions -> Encoding

toJSONList :: [SecurityDefinitions] -> Value

toEncodingList :: [SecurityDefinitions] -> Encoding

FromJSON SecurityDefinitions

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser SecurityDefinitions

parseJSONList :: Value -> Parser [SecurityDefinitions]

type Rep SecurityDefinitions

Defined in Data.OpenApi.Internal

type Rep SecurityDefinitions = D1 ('MetaData "SecurityDefinitions" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'True) (C1 ('MetaCons "SecurityDefinitions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions SecurityScheme))))

newtype SecurityRequirement

Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes).

Constructors

SecurityRequirement

Fields

• getSecurityRequirement :: InsOrdHashMap Text [Text]

Instances

Eq SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

(==) :: SecurityRequirement -> SecurityRequirement -> Bool

(/=) :: SecurityRequirement -> SecurityRequirement -> Bool

Data SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: SecurityRequirement -> Constr

dataTypeOf :: SecurityRequirement -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SecurityRequirement -> SecurityRequirement

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

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

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

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

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

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

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

Read SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

readsPrec :: Int -> ReadS SecurityRequirement

readList :: ReadS [SecurityRequirement]

readPrec :: ReadPrec SecurityRequirement

readListPrec :: ReadPrec [SecurityRequirement]

Show SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> SecurityRequirement -> ShowS

show :: SecurityRequirement -> String

showList :: [SecurityRequirement] -> ShowS

Semigroup SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

(<>) :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement

sconcat :: NonEmpty SecurityRequirement -> SecurityRequirement

stimes :: Integral b => b -> SecurityRequirement -> SecurityRequirement

Monoid SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

mempty :: SecurityRequirement

mappend :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement

mconcat :: [SecurityRequirement] -> SecurityRequirement

ToJSON SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

toJSON :: SecurityRequirement -> Value

toEncoding :: SecurityRequirement -> Encoding

toJSONList :: [SecurityRequirement] -> Value

toEncodingList :: [SecurityRequirement] -> Encoding

FromJSON SecurityRequirement

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser SecurityRequirement

parseJSONList :: Value -> Parser [SecurityRequirement]

HasSecurity Operation [SecurityRequirement]

Defined in Data.OpenApi.Lens

Methods

security :: Lens' Operation [SecurityRequirement]

HasSecurity OpenApi [SecurityRequirement]

Defined in Data.OpenApi.Lens

Methods

security :: Lens' OpenApi [SecurityRequirement]

API key

data ApiKeyParams

Constructors

ApiKeyParams

Fields

• _apiKeyName :: Text

  The name of the header or query parameter to be used.

• _apiKeyIn :: ApiKeyLocation

  The location of the API key.

Instances

Eq ApiKeyParams

Defined in Data.OpenApi.Internal

Methods

(==) :: ApiKeyParams -> ApiKeyParams -> Bool

(/=) :: ApiKeyParams -> ApiKeyParams -> Bool

Data ApiKeyParams

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: ApiKeyParams -> Constr

dataTypeOf :: ApiKeyParams -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ApiKeyParams -> ApiKeyParams

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

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

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

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

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

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

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

Show ApiKeyParams

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> ApiKeyParams -> ShowS

show :: ApiKeyParams -> String

showList :: [ApiKeyParams] -> ShowS

Generic ApiKeyParams

Defined in Data.OpenApi.Internal

Associated Types

type Rep ApiKeyParams :: Type -> Type

Methods

from :: ApiKeyParams -> Rep ApiKeyParams x

to :: Rep ApiKeyParams x -> ApiKeyParams

ToJSON ApiKeyParams

Defined in Data.OpenApi.Internal

Methods

toJSON :: ApiKeyParams -> Value

toEncoding :: ApiKeyParams -> Encoding

toJSONList :: [ApiKeyParams] -> Value

toEncodingList :: [ApiKeyParams] -> Encoding

FromJSON ApiKeyParams

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser ApiKeyParams

parseJSONList :: Value -> Parser [ApiKeyParams]

type Rep ApiKeyParams

Defined in Data.OpenApi.Internal

type Rep ApiKeyParams = D1 ('MetaData "ApiKeyParams" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "ApiKeyParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "_apiKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_apiKeyIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiKeyLocation)))

data ApiKeyLocation

The location of the API key.

Constructors

ApiKeyQuery

ApiKeyHeader

ApiKeyCookie

Instances

Eq ApiKeyLocation

Defined in Data.OpenApi.Internal

Methods

(==) :: ApiKeyLocation -> ApiKeyLocation -> Bool

(/=) :: ApiKeyLocation -> ApiKeyLocation -> Bool

Data ApiKeyLocation

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: ApiKeyLocation -> Constr

dataTypeOf :: ApiKeyLocation -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ApiKeyLocation -> ApiKeyLocation

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

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

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

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

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

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

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

Show ApiKeyLocation

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> ApiKeyLocation -> ShowS

show :: ApiKeyLocation -> String

showList :: [ApiKeyLocation] -> ShowS

Generic ApiKeyLocation

Defined in Data.OpenApi.Internal

Associated Types

type Rep ApiKeyLocation :: Type -> Type

Methods

from :: ApiKeyLocation -> Rep ApiKeyLocation x

to :: Rep ApiKeyLocation x -> ApiKeyLocation

ToJSON ApiKeyLocation

Defined in Data.OpenApi.Internal

Methods

toJSON :: ApiKeyLocation -> Value

toEncoding :: ApiKeyLocation -> Encoding

toJSONList :: [ApiKeyLocation] -> Value

toEncodingList :: [ApiKeyLocation] -> Encoding

FromJSON ApiKeyLocation

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser ApiKeyLocation

parseJSONList :: Value -> Parser [ApiKeyLocation]

type Rep ApiKeyLocation

Defined in Data.OpenApi.Internal

type Rep ApiKeyLocation = D1 ('MetaData "ApiKeyLocation" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "ApiKeyQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ApiKeyHeader" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ApiKeyCookie" 'PrefixI 'False) (U1 :: Type -> Type)))

OAuth2

data OAuth2Flows

Constructors

OAuth2Flows

Fields

• _oAuth2FlowsImplicit :: Maybe (OAuth2Flow OAuth2ImplicitFlow)

  Configuration for the OAuth Implicit flow

• _oAuth2FlowsPassword :: Maybe (OAuth2Flow OAuth2PasswordFlow)

  Configuration for the OAuth Resource Owner Password flow

• _oAuth2FlowsClientCredentials :: Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)

  Configuration for the OAuth Client Credentials flow

• _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)

  Configuration for the OAuth Authorization Code flow

Instances

Eq OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2Flows -> OAuth2Flows -> Bool

(/=) :: OAuth2Flows -> OAuth2Flows -> Bool

Data OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OAuth2Flows -> Constr

dataTypeOf :: OAuth2Flows -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OAuth2Flows -> OAuth2Flows

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

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

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

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

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

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

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

Show OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OAuth2Flows -> ShowS

show :: OAuth2Flows -> String

showList :: [OAuth2Flows] -> ShowS

Generic OAuth2Flows

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2Flows :: Type -> Type

Methods

from :: OAuth2Flows -> Rep OAuth2Flows x

to :: Rep OAuth2Flows x -> OAuth2Flows

Semigroup OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

(<>) :: OAuth2Flows -> OAuth2Flows -> OAuth2Flows

sconcat :: NonEmpty OAuth2Flows -> OAuth2Flows

stimes :: Integral b => b -> OAuth2Flows -> OAuth2Flows

Monoid OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

mempty :: OAuth2Flows

mappend :: OAuth2Flows -> OAuth2Flows -> OAuth2Flows

mconcat :: [OAuth2Flows] -> OAuth2Flows

ToJSON OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

toJSON :: OAuth2Flows -> Value

toEncoding :: OAuth2Flows -> Encoding

toJSONList :: [OAuth2Flows] -> Value

toEncodingList :: [OAuth2Flows] -> Encoding

FromJSON OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OAuth2Flows

parseJSONList :: Value -> Parser [OAuth2Flows]

Generic OAuth2Flows

Defined in Data.OpenApi.Internal

Associated Types

type Code OAuth2Flows :: [[Type]]

Methods

from :: OAuth2Flows -> Rep OAuth2Flows

to :: Rep OAuth2Flows -> OAuth2Flows

HasDatatypeInfo OAuth2Flows

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf OAuth2Flows :: DatatypeInfo

Methods

datatypeInfo :: proxy OAuth2Flows -> DatatypeInfo (Code OAuth2Flows)

HasSwaggerAesonOptions OAuth2Flows

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy OAuth2Flows -> SwaggerAesonOptions

aesonDefaults :: Proxy OAuth2Flows -> POP Maybe (Code OAuth2Flows)

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow), b ~ Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) => LabelOptic "authorizationCode" k OAuth2Flows OAuth2Flows a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2ClientCredentialsFlow), b ~ Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) => LabelOptic "clientCredentials" k OAuth2Flows OAuth2Flows a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2ImplicitFlow), b ~ Maybe (OAuth2Flow OAuth2ImplicitFlow)) => LabelOptic "implicit" k OAuth2Flows OAuth2Flows a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2PasswordFlow), b ~ Maybe (OAuth2Flow OAuth2PasswordFlow)) => LabelOptic "password" k OAuth2Flows OAuth2Flows a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b

HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow))

Defined in Data.OpenApi.Lens

Methods

password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow))

HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow))

Defined in Data.OpenApi.Lens

Methods

implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow))

HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))

Defined in Data.OpenApi.Lens

Methods

clientCredentials :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))

HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))

Defined in Data.OpenApi.Lens

Methods

authorizationCode :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))

type Rep OAuth2Flows

Defined in Data.OpenApi.Internal

type Rep OAuth2Flows = D1 ('MetaData "OAuth2Flows" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "OAuth2Flows" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_oAuth2FlowsImplicit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2ImplicitFlow))) :*: S1 ('MetaSel ('Just "_oAuth2FlowsPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2PasswordFlow)))) :*: (S1 ('MetaSel ('Just "_oAuth2FlowsClientCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))) :*: S1 ('MetaSel ('Just "_oAuth2FlowsAuthorizationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))))))

type Code OAuth2Flows

Defined in Data.OpenApi.Internal

type Code OAuth2Flows = '['[Maybe (OAuth2Flow OAuth2ImplicitFlow), Maybe (OAuth2Flow OAuth2PasswordFlow), Maybe (OAuth2Flow OAuth2ClientCredentialsFlow), Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)]]

type DatatypeInfoOf OAuth2Flows

Defined in Data.OpenApi.Internal

type DatatypeInfoOf OAuth2Flows = 'ADT "Data.OpenApi.Internal" "OAuth2Flows" '['Record "OAuth2Flows" '['FieldInfo "_oAuth2FlowsImplicit", 'FieldInfo "_oAuth2FlowsPassword", 'FieldInfo "_oAuth2FlowsClientCredentials", 'FieldInfo "_oAuth2FlowsAuthorizationCode"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

data OAuth2Flow p

Constructors

OAuth2Flow

Fields

• _oAuth2Params :: p
• _oAath2RefreshUrl :: Maybe URL

  The URL to be used for obtaining refresh tokens.

• _oAuth2Scopes :: InsOrdHashMap Text Text

  The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.

Instances

HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow))

Defined in Data.OpenApi.Lens

Methods

password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow))

HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow))

Defined in Data.OpenApi.Lens

Methods

implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow))

HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))

Defined in Data.OpenApi.Lens

Methods

clientCredentials :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))

HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))

Defined in Data.OpenApi.Lens

Methods

authorizationCode :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))

Eq p => Eq (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2Flow p -> OAuth2Flow p -> Bool

(/=) :: OAuth2Flow p -> OAuth2Flow p -> Bool

Data p => Data (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth2Flow p -> c (OAuth2Flow p)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (OAuth2Flow p)

toConstr :: OAuth2Flow p -> Constr

dataTypeOf :: OAuth2Flow p -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (OAuth2Flow p))

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

gmapT :: (forall b. Data b => b -> b) -> OAuth2Flow p -> OAuth2Flow p

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flow p -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth2Flow p -> r

gmapQ :: (forall d. Data d => d -> u) -> OAuth2Flow p -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth2Flow p -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth2Flow p -> m (OAuth2Flow p)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flow p -> m (OAuth2Flow p)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth2Flow p -> m (OAuth2Flow p)

Show p => Show (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OAuth2Flow p -> ShowS

show :: OAuth2Flow p -> String

showList :: [OAuth2Flow p] -> ShowS

Generic (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Associated Types

type Rep (OAuth2Flow p) :: Type -> Type

Methods

from :: OAuth2Flow p -> Rep (OAuth2Flow p) x

to :: Rep (OAuth2Flow p) x -> OAuth2Flow p

Semigroup (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

(<>) :: OAuth2Flow p -> OAuth2Flow p -> OAuth2Flow p

sconcat :: NonEmpty (OAuth2Flow p) -> OAuth2Flow p

stimes :: Integral b => b -> OAuth2Flow p -> OAuth2Flow p

(Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

toJSON :: OAuth2Flow p -> Value

toEncoding :: OAuth2Flow p -> Encoding

toJSONList :: [OAuth2Flow p] -> Value

toEncodingList :: [OAuth2Flow p] -> Encoding

(Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (OAuth2Flow p)

parseJSONList :: Value -> Parser [OAuth2Flow p]

Generic (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Associated Types

type Code (OAuth2Flow p) :: [[Type]]

Methods

from :: OAuth2Flow p -> Rep (OAuth2Flow p)

to :: Rep (OAuth2Flow p) -> OAuth2Flow p

HasDatatypeInfo (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf (OAuth2Flow p) :: DatatypeInfo

Methods

datatypeInfo :: proxy (OAuth2Flow p) -> DatatypeInfo (Code (OAuth2Flow p))

AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe (OAuth2Flow p)

AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p)

Defined in Data.OpenApi.Internal

Methods

swaggerAesonOptions :: Proxy (OAuth2Flow p) -> SwaggerAesonOptions

aesonDefaults :: Proxy (OAuth2Flow p) -> POP Maybe (Code (OAuth2Flow p))

type Rep (OAuth2Flow p)

Defined in Data.OpenApi.Internal

type Rep (OAuth2Flow p) = D1 ('MetaData "OAuth2Flow" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "OAuth2Flow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2Params") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 p) :*: (S1 ('MetaSel ('Just "_oAath2RefreshUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)) :*: S1 ('MetaSel ('Just "_oAuth2Scopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Text)))))

type Code (OAuth2Flow p)

Defined in Data.OpenApi.Internal

type Code (OAuth2Flow p) = '['[p, Maybe URL, InsOrdHashMap Text Text]]

type DatatypeInfoOf (OAuth2Flow p)

Defined in Data.OpenApi.Internal

type DatatypeInfoOf (OAuth2Flow p) = 'ADT "Data.OpenApi.Internal" "OAuth2Flow" '['Record "OAuth2Flow" '['FieldInfo "_oAuth2Params", 'FieldInfo "_oAath2RefreshUrl", 'FieldInfo "_oAuth2Scopes"]] '['['StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy, 'StrictnessInfo 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy]]

newtype OAuth2ImplicitFlow

Constructors

OAuth2ImplicitFlow

Fields

• _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL

Instances

Eq OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2ImplicitFlow -> OAuth2ImplicitFlow -> Bool

(/=) :: OAuth2ImplicitFlow -> OAuth2ImplicitFlow -> Bool

Data OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OAuth2ImplicitFlow -> Constr

dataTypeOf :: OAuth2ImplicitFlow -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OAuth2ImplicitFlow -> OAuth2ImplicitFlow

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

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

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

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

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

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

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

Show OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OAuth2ImplicitFlow -> ShowS

show :: OAuth2ImplicitFlow -> String

showList :: [OAuth2ImplicitFlow] -> ShowS

Generic OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2ImplicitFlow :: Type -> Type

Methods

from :: OAuth2ImplicitFlow -> Rep OAuth2ImplicitFlow x

to :: Rep OAuth2ImplicitFlow x -> OAuth2ImplicitFlow

ToJSON OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Methods

toJSON :: OAuth2ImplicitFlow -> Value

toEncoding :: OAuth2ImplicitFlow -> Encoding

toJSONList :: [OAuth2ImplicitFlow] -> Value

toEncodingList :: [OAuth2ImplicitFlow] -> Encoding

FromJSON OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OAuth2ImplicitFlow

parseJSONList :: Value -> Parser [OAuth2ImplicitFlow]

AesonDefaultValue OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OAuth2ImplicitFlow

HasAuthorizationUrl OAuth2ImplicitFlow AuthorizationURL

Defined in Data.OpenApi.Lens

Methods

authorizationUrl :: Lens' OAuth2ImplicitFlow AuthorizationURL

(k ~ An_Iso, a ~ AuthorizationURL, b ~ AuthorizationURL) => LabelOptic "authorizationUrl" k OAuth2ImplicitFlow OAuth2ImplicitFlow a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2ImplicitFlow OAuth2ImplicitFlow a b

HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow))

Defined in Data.OpenApi.Lens

Methods

implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow))

type Rep OAuth2ImplicitFlow

Defined in Data.OpenApi.Internal

type Rep OAuth2ImplicitFlow = D1 ('MetaData "OAuth2ImplicitFlow" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'True) (C1 ('MetaCons "OAuth2ImplicitFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2ImplicitFlowAuthorizationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL)))

newtype OAuth2PasswordFlow

Constructors

OAuth2PasswordFlow

Fields

• _oAuth2PasswordFlowTokenUrl :: TokenURL

Instances

Eq OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2PasswordFlow -> OAuth2PasswordFlow -> Bool

(/=) :: OAuth2PasswordFlow -> OAuth2PasswordFlow -> Bool

Data OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OAuth2PasswordFlow -> Constr

dataTypeOf :: OAuth2PasswordFlow -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OAuth2PasswordFlow -> OAuth2PasswordFlow

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

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

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

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

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

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

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

Show OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OAuth2PasswordFlow -> ShowS

show :: OAuth2PasswordFlow -> String

showList :: [OAuth2PasswordFlow] -> ShowS

Generic OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2PasswordFlow :: Type -> Type

Methods

from :: OAuth2PasswordFlow -> Rep OAuth2PasswordFlow x

to :: Rep OAuth2PasswordFlow x -> OAuth2PasswordFlow

ToJSON OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Methods

toJSON :: OAuth2PasswordFlow -> Value

toEncoding :: OAuth2PasswordFlow -> Encoding

toJSONList :: [OAuth2PasswordFlow] -> Value

toEncodingList :: [OAuth2PasswordFlow] -> Encoding

FromJSON OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OAuth2PasswordFlow

parseJSONList :: Value -> Parser [OAuth2PasswordFlow]

AesonDefaultValue OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OAuth2PasswordFlow

HasTokenUrl OAuth2PasswordFlow TokenURL

Defined in Data.OpenApi.Lens

Methods

tokenUrl :: Lens' OAuth2PasswordFlow TokenURL

(k ~ An_Iso, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2PasswordFlow OAuth2PasswordFlow a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2PasswordFlow OAuth2PasswordFlow a b

HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow))

Defined in Data.OpenApi.Lens

Methods

password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow))

type Rep OAuth2PasswordFlow

Defined in Data.OpenApi.Internal

type Rep OAuth2PasswordFlow = D1 ('MetaData "OAuth2PasswordFlow" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'True) (C1 ('MetaCons "OAuth2PasswordFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2PasswordFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)))

newtype OAuth2ClientCredentialsFlow

Constructors

OAuth2ClientCredentialsFlow

Fields

• _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL

Instances

Eq OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow -> Bool

(/=) :: OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow -> Bool

Data OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OAuth2ClientCredentialsFlow -> Constr

dataTypeOf :: OAuth2ClientCredentialsFlow -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow

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

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

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

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

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

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

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

Show OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OAuth2ClientCredentialsFlow -> ShowS

show :: OAuth2ClientCredentialsFlow -> String

showList :: [OAuth2ClientCredentialsFlow] -> ShowS

Generic OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2ClientCredentialsFlow :: Type -> Type

Methods

from :: OAuth2ClientCredentialsFlow -> Rep OAuth2ClientCredentialsFlow x

to :: Rep OAuth2ClientCredentialsFlow x -> OAuth2ClientCredentialsFlow

ToJSON OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Methods

toJSON :: OAuth2ClientCredentialsFlow -> Value

toEncoding :: OAuth2ClientCredentialsFlow -> Encoding

toJSONList :: [OAuth2ClientCredentialsFlow] -> Value

toEncodingList :: [OAuth2ClientCredentialsFlow] -> Encoding

FromJSON OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OAuth2ClientCredentialsFlow

parseJSONList :: Value -> Parser [OAuth2ClientCredentialsFlow]

AesonDefaultValue OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OAuth2ClientCredentialsFlow

HasTokenUrl OAuth2ClientCredentialsFlow TokenURL

Defined in Data.OpenApi.Lens

Methods

tokenUrl :: Lens' OAuth2ClientCredentialsFlow TokenURL

(k ~ An_Iso, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b

HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))

Defined in Data.OpenApi.Lens

Methods

clientCredentials :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))

type Rep OAuth2ClientCredentialsFlow

Defined in Data.OpenApi.Internal

type Rep OAuth2ClientCredentialsFlow = D1 ('MetaData "OAuth2ClientCredentialsFlow" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'True) (C1 ('MetaCons "OAuth2ClientCredentialsFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2ClientCredentialsFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)))

data OAuth2AuthorizationCodeFlow

Constructors

OAuth2AuthorizationCodeFlow

Fields

• _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
• _oAuth2AuthorizationCodeFlowTokenUrl :: TokenURL

Instances

Eq OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow -> Bool

(/=) :: OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow -> Bool

Data OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OAuth2AuthorizationCodeFlow -> Constr

dataTypeOf :: OAuth2AuthorizationCodeFlow -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow

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

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

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

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

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

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

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

Show OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> OAuth2AuthorizationCodeFlow -> ShowS

show :: OAuth2AuthorizationCodeFlow -> String

showList :: [OAuth2AuthorizationCodeFlow] -> ShowS

Generic OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2AuthorizationCodeFlow :: Type -> Type

Methods

from :: OAuth2AuthorizationCodeFlow -> Rep OAuth2AuthorizationCodeFlow x

to :: Rep OAuth2AuthorizationCodeFlow x -> OAuth2AuthorizationCodeFlow

ToJSON OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Methods

toJSON :: OAuth2AuthorizationCodeFlow -> Value

toEncoding :: OAuth2AuthorizationCodeFlow -> Encoding

toJSONList :: [OAuth2AuthorizationCodeFlow] -> Value

toEncodingList :: [OAuth2AuthorizationCodeFlow] -> Encoding

FromJSON OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser OAuth2AuthorizationCodeFlow

parseJSONList :: Value -> Parser [OAuth2AuthorizationCodeFlow]

AesonDefaultValue OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe OAuth2AuthorizationCodeFlow

HasAuthorizationUrl OAuth2AuthorizationCodeFlow AuthorizationURL

Defined in Data.OpenApi.Lens

Methods

authorizationUrl :: Lens' OAuth2AuthorizationCodeFlow AuthorizationURL

HasTokenUrl OAuth2AuthorizationCodeFlow TokenURL

Defined in Data.OpenApi.Lens

Methods

tokenUrl :: Lens' OAuth2AuthorizationCodeFlow TokenURL

(k ~ A_Lens, a ~ AuthorizationURL, b ~ AuthorizationURL) => LabelOptic "authorizationUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b

(k ~ A_Lens, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b

HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))

Defined in Data.OpenApi.Lens

Methods

authorizationCode :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))

type Rep OAuth2AuthorizationCodeFlow

Defined in Data.OpenApi.Internal

type Rep OAuth2AuthorizationCodeFlow = D1 ('MetaData "OAuth2AuthorizationCodeFlow" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "OAuth2AuthorizationCodeFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2AuthorizationCodeFlowAuthorizationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL) :*: S1 ('MetaSel ('Just "_oAuth2AuthorizationCodeFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)))

type AuthorizationURL = Text

The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.

type TokenURL = Text

The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.

External documentation

data ExternalDocs

Allows referencing an external resource for extended documentation.

Constructors

ExternalDocs

Fields

• _externalDocsDescription :: Maybe Text

  A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.

• _externalDocsUrl :: URL

  The URL for the target documentation.

Instances

Eq ExternalDocs

Defined in Data.OpenApi.Internal

Methods

(==) :: ExternalDocs -> ExternalDocs -> Bool

(/=) :: ExternalDocs -> ExternalDocs -> Bool

Data ExternalDocs

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: ExternalDocs -> Constr

dataTypeOf :: ExternalDocs -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ExternalDocs -> ExternalDocs

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

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

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

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

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

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

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

Ord ExternalDocs

Defined in Data.OpenApi.Internal

Methods

compare :: ExternalDocs -> ExternalDocs -> Ordering

(<) :: ExternalDocs -> ExternalDocs -> Bool

(<=) :: ExternalDocs -> ExternalDocs -> Bool

(>) :: ExternalDocs -> ExternalDocs -> Bool

(>=) :: ExternalDocs -> ExternalDocs -> Bool

max :: ExternalDocs -> ExternalDocs -> ExternalDocs

min :: ExternalDocs -> ExternalDocs -> ExternalDocs

Show ExternalDocs

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> ExternalDocs -> ShowS

show :: ExternalDocs -> String

showList :: [ExternalDocs] -> ShowS

Generic ExternalDocs

Defined in Data.OpenApi.Internal

Associated Types

type Rep ExternalDocs :: Type -> Type

Methods

from :: ExternalDocs -> Rep ExternalDocs x

to :: Rep ExternalDocs x -> ExternalDocs

Semigroup ExternalDocs

Defined in Data.OpenApi.Internal

Methods

(<>) :: ExternalDocs -> ExternalDocs -> ExternalDocs

sconcat :: NonEmpty ExternalDocs -> ExternalDocs

stimes :: Integral b => b -> ExternalDocs -> ExternalDocs

Monoid ExternalDocs

Defined in Data.OpenApi.Internal

Methods

mempty :: ExternalDocs

mappend :: ExternalDocs -> ExternalDocs -> ExternalDocs

mconcat :: [ExternalDocs] -> ExternalDocs

Hashable ExternalDocs

Defined in Data.OpenApi.Internal

Methods

hashWithSalt :: Int -> ExternalDocs -> Int

hash :: ExternalDocs -> Int

ToJSON ExternalDocs

Defined in Data.OpenApi.Internal

Methods

toJSON :: ExternalDocs -> Value

toEncoding :: ExternalDocs -> Encoding

toJSONList :: [ExternalDocs] -> Value

toEncodingList :: [ExternalDocs] -> Encoding

FromJSON ExternalDocs

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser ExternalDocs

parseJSONList :: Value -> Parser [ExternalDocs]

SwaggerMonoid ExternalDocs

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: ExternalDocs

swaggerMappend :: ExternalDocs -> ExternalDocs -> ExternalDocs

HasUrl ExternalDocs URL

Defined in Data.OpenApi.Lens

Methods

url :: Lens' ExternalDocs URL

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k ExternalDocs ExternalDocs a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b

(k ~ A_Lens, a ~ URL, b ~ URL) => LabelOptic "url" k ExternalDocs ExternalDocs a b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b

HasExternalDocs Tag (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' Tag (Maybe ExternalDocs)

HasExternalDocs Schema (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' Schema (Maybe ExternalDocs)

HasExternalDocs Operation (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' Operation (Maybe ExternalDocs)

HasExternalDocs OpenApi (Maybe ExternalDocs)

Defined in Data.OpenApi.Lens

Methods

externalDocs :: Lens' OpenApi (Maybe ExternalDocs)

HasDescription ExternalDocs (Maybe Text)

Defined in Data.OpenApi.Lens

Methods

description :: Lens' ExternalDocs (Maybe Text)

type Rep ExternalDocs

Defined in Data.OpenApi.Internal

type Rep ExternalDocs = D1 ('MetaData "ExternalDocs" "Data.OpenApi.Internal" "openapi3-3.0.2.0-4GKlcOYQXd7236rq5W0t4n" 'False) (C1 ('MetaCons "ExternalDocs" 'PrefixI 'True) (S1 ('MetaSel ('Just "_externalDocsDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_externalDocsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URL)))

References

newtype Reference

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

Constructors

Reference

Fields

• getReference :: Text

Instances

Eq Reference

Defined in Data.OpenApi.Internal

Methods

(==) :: Reference -> Reference -> Bool

(/=) :: Reference -> Reference -> Bool

Data Reference

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Reference -> Constr

dataTypeOf :: Reference -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Reference -> Reference

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

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

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

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

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

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

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

Show Reference

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Reference -> ShowS

show :: Reference -> String

showList :: [Reference] -> ShowS

ToJSON Reference

Defined in Data.OpenApi.Internal

Methods

toJSON :: Reference -> Value

toEncoding :: Reference -> Encoding

toJSONList :: [Reference] -> Value

toEncodingList :: [Reference] -> Encoding

FromJSON Reference

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser Reference

parseJSONList :: Value -> Parser [Reference]

data Referenced a

Constructors

Ref Reference

Inline a

Instances

Functor Referenced

Defined in Data.OpenApi.Internal

Methods

fmap :: (a -> b) -> Referenced a -> Referenced b

(<$) :: a -> Referenced b -> Referenced a

(k ~ A_Prism, a1 ~ a2, b ~ a3) => LabelOptic "_Inline" k (Referenced a2) (Referenced a3) a1 b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx (Referenced a2) (Referenced a3) a1 b

(k ~ A_Prism, a1 ~ Reference, b ~ Reference) => LabelOptic "_Ref" k (Referenced a2) (Referenced a2) a1 b

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx (Referenced a2) (Referenced a2) a1 b

HasParameters Operation [Referenced Param]

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' Operation [Referenced Param]

HasParameters PathItem [Referenced Param]

Defined in Data.OpenApi.Lens

Methods

parameters :: Lens' PathItem [Referenced Param]

HasSchema Header (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' Header (Maybe (Referenced Schema))

HasSchema Param (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' Param (Maybe (Referenced Schema))

HasSchema MediaTypeObject (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

schema :: Lens' MediaTypeObject (Maybe (Referenced Schema))

HasRequestBody Operation (Maybe (Referenced RequestBody))

Defined in Data.OpenApi.Lens

Methods

requestBody :: Lens' Operation (Maybe (Referenced RequestBody))

HasOneOf Schema (Maybe [Referenced Schema])

Defined in Data.OpenApi.Lens

Methods

oneOf :: Lens' Schema (Maybe [Referenced Schema])

HasNot Schema (Maybe (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

not_ :: Lens' Schema (Maybe (Referenced Schema))

HasDefault Responses (Maybe (Referenced Response))

Defined in Data.OpenApi.Lens

Methods

default_ :: Lens' Responses (Maybe (Referenced Response))

HasAnyOf Schema (Maybe [Referenced Schema])

Defined in Data.OpenApi.Lens

Methods

anyOf :: Lens' Schema (Maybe [Referenced Schema])

HasAllOf Schema (Maybe [Referenced Schema])

Defined in Data.OpenApi.Lens

Methods

allOf :: Lens' Schema (Maybe [Referenced Schema])

HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response))

Defined in Data.OpenApi.Lens

Methods

responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response))

HasLinks Response (InsOrdHashMap Text (Referenced Link))

Defined in Data.OpenApi.Lens

Methods

links :: Lens' Response (InsOrdHashMap Text (Referenced Link))

HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header))

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header))

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header))

Defined in Data.OpenApi.Lens

Methods

headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header))

HasExamples Header (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Header (InsOrdHashMap Text (Referenced Example))

HasExamples Param (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' Param (InsOrdHashMap Text (Referenced Example))

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example))

Defined in Data.OpenApi.Lens

Methods

examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example))

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback))

Defined in Data.OpenApi.Lens

Methods

callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback))

HasProperties Schema (InsOrdHashMap Text (Referenced Schema))

Defined in Data.OpenApi.Lens

Methods

properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema))

Eq a => Eq (Referenced a)

Defined in Data.OpenApi.Internal

Methods

(==) :: Referenced a -> Referenced a -> Bool

(/=) :: Referenced a -> Referenced a -> Bool

Data a => Data (Referenced a)

Defined in Data.OpenApi.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Referenced a -> c (Referenced a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Referenced a)

toConstr :: Referenced a -> Constr

dataTypeOf :: Referenced a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Referenced a))

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

gmapT :: (forall b. Data b => b -> b) -> Referenced a -> Referenced a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Referenced a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Referenced a -> r

gmapQ :: (forall d. Data d => d -> u) -> Referenced a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Referenced a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Referenced a -> m (Referenced a)

Show a => Show (Referenced a)

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Referenced a -> ShowS

show :: Referenced a -> String

showList :: [Referenced a] -> ShowS

IsString a => IsString (Referenced a)

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Referenced a

ToJSON (Referenced Header)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Header -> Value

toEncoding :: Referenced Header -> Encoding

toJSONList :: [Referenced Header] -> Value

toEncodingList :: [Referenced Header] -> Encoding

ToJSON (Referenced Callback)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Callback -> Value

toEncoding :: Referenced Callback -> Encoding

toJSONList :: [Referenced Callback] -> Value

toEncodingList :: [Referenced Callback] -> Encoding

ToJSON (Referenced Response)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Response -> Value

toEncoding :: Referenced Response -> Encoding

toJSONList :: [Referenced Response] -> Value

toEncodingList :: [Referenced Response] -> Encoding

ToJSON (Referenced Schema)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Schema -> Value

toEncoding :: Referenced Schema -> Encoding

toJSONList :: [Referenced Schema] -> Value

toEncodingList :: [Referenced Schema] -> Encoding

ToJSON (Referenced Link)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Link -> Value

toEncoding :: Referenced Link -> Encoding

toJSONList :: [Referenced Link] -> Value

toEncodingList :: [Referenced Link] -> Encoding

ToJSON (Referenced Example)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Example -> Value

toEncoding :: Referenced Example -> Encoding

toJSONList :: [Referenced Example] -> Value

toEncodingList :: [Referenced Example] -> Encoding

ToJSON (Referenced Param)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced Param -> Value

toEncoding :: Referenced Param -> Encoding

toJSONList :: [Referenced Param] -> Value

toEncodingList :: [Referenced Param] -> Encoding

ToJSON (Referenced RequestBody)

Defined in Data.OpenApi.Internal

Methods

toJSON :: Referenced RequestBody -> Value

toEncoding :: Referenced RequestBody -> Encoding

toJSONList :: [Referenced RequestBody] -> Value

toEncodingList :: [Referenced RequestBody] -> Encoding

FromJSON (Referenced Header)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Header)

parseJSONList :: Value -> Parser [Referenced Header]

FromJSON (Referenced Callback)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Callback)

parseJSONList :: Value -> Parser [Referenced Callback]

FromJSON (Referenced Response)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Response)

parseJSONList :: Value -> Parser [Referenced Response]

FromJSON (Referenced Schema)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Schema)

parseJSONList :: Value -> Parser [Referenced Schema]

FromJSON (Referenced Link)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Link)

parseJSONList :: Value -> Parser [Referenced Link]

FromJSON (Referenced Example)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Example)

parseJSONList :: Value -> Parser [Referenced Example]

FromJSON (Referenced Param)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced Param)

parseJSONList :: Value -> Parser [Referenced Param]

FromJSON (Referenced RequestBody)

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser (Referenced RequestBody)

parseJSONList :: Value -> Parser [Referenced RequestBody]

Monoid a => SwaggerMonoid (Referenced a)

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: Referenced a

swaggerMappend :: Referenced a -> Referenced a -> Referenced a

Miscellaneous

newtype MimeList

Constructors

MimeList

Fields

• getMimeList :: [MediaType]

Instances

Eq MimeList

Defined in Data.OpenApi.Internal

Methods

(==) :: MimeList -> MimeList -> Bool

(/=) :: MimeList -> MimeList -> Bool

Data MimeList

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: MimeList -> Constr

dataTypeOf :: MimeList -> DataType

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

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

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

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

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

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

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

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

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

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

Show MimeList

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> MimeList -> ShowS

show :: MimeList -> String

showList :: [MimeList] -> ShowS

Semigroup MimeList

Defined in Data.OpenApi.Internal

Methods

(<>) :: MimeList -> MimeList -> MimeList

sconcat :: NonEmpty MimeList -> MimeList

stimes :: Integral b => b -> MimeList -> MimeList

Monoid MimeList

Defined in Data.OpenApi.Internal

Methods

mempty :: MimeList

mappend :: MimeList -> MimeList -> MimeList

mconcat :: [MimeList] -> MimeList

ToJSON MimeList

Defined in Data.OpenApi.Internal

Methods

toJSON :: MimeList -> Value

toEncoding :: MimeList -> Encoding

toJSONList :: [MimeList] -> Value

toEncodingList :: [MimeList] -> Encoding

FromJSON MimeList

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser MimeList

parseJSONList :: Value -> Parser [MimeList]

AesonDefaultValue MimeList

Defined in Data.OpenApi.Internal

Methods

defaultValue :: Maybe MimeList

SwaggerMonoid MimeList

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: MimeList

swaggerMappend :: MimeList -> MimeList -> MimeList

newtype URL

Constructors

URL

Fields

• getUrl :: Text

Instances

Eq URL

Defined in Data.OpenApi.Internal

Methods

(==) :: URL -> URL -> Bool

(/=) :: URL -> URL -> Bool

Data URL

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: URL -> Constr

dataTypeOf :: URL -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> URL -> URL

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

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

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

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

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

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

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

Ord URL

Defined in Data.OpenApi.Internal

Methods

compare :: URL -> URL -> Ordering

(<) :: URL -> URL -> Bool

(<=) :: URL -> URL -> Bool

(>) :: URL -> URL -> Bool

(>=) :: URL -> URL -> Bool

max :: URL -> URL -> URL

min :: URL -> URL -> URL

Show URL

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

Hashable URL

Defined in Data.OpenApi.Internal

Methods

hashWithSalt :: Int -> URL -> Int

hash :: URL -> Int

ToJSON URL

Defined in Data.OpenApi.Internal

Methods

toJSON :: URL -> Value

toEncoding :: URL -> Encoding

toJSONList :: [URL] -> Value

toEncodingList :: [URL] -> Encoding

FromJSON URL

Defined in Data.OpenApi.Internal

Methods

parseJSON :: Value -> Parser URL

parseJSONList :: Value -> Parser [URL]

SwaggerMonoid URL

Defined in Data.OpenApi.Internal

Methods

swaggerMempty :: URL

swaggerMappend :: URL -> URL -> URL

HasUrl ExternalDocs URL

Defined in Data.OpenApi.Lens

Methods

url :: Lens' ExternalDocs URL

HasUrl License (Maybe URL)

Defined in Data.OpenApi.Lens

Methods

url :: Lens' License (Maybe URL)

HasUrl Contact (Maybe URL)

Defined in Data.OpenApi.Lens

Methods

url :: Lens' Contact (Maybe URL)

HasExternalValue Example (Maybe URL)

Defined in Data.OpenApi.Lens

Methods

externalValue :: Lens' Example (Maybe URL)