openapi3-3.1.0: OpenAPI 3.0 data model
MaintainerNickolay Kudasov <nickolay@getshoptv.com>
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Data.OpenApi

Description

Swagger™ is a project used to describe and document RESTful APIs.

The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.

Synopsis

How to use this library

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

Monoid instances

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

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

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

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 $ encodePretty mempty { _infoTitle = "Todo API", _infoVersion = "1.0" }
{
    "title": "Todo API",
    "version": "1.0"
}

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

>>> BSL.putStrLn $ encodePretty $ mempty { _infoTitle = "Todo API" } <> mempty { _infoVersion = "1.0" }
{
    "title": "Todo API",
    "version": "1.0"
}

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 $ encodePretty $ (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")) ]
:}
{
    "components": {
        "schemas": {
            "User": {
                "type": "string"
            }
        }
    },
    "info": {
        "title": "",
        "version": ""
    },
    "openapi": "3.0.0",
    "paths": {
        "/user": {
            "get": {
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/User"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "404": {
                        "description": "User info not found"
                    }
                }
            }
        }
    }
}

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 $ encodePretty $ (mempty :: Response) & description .~ "No content"
{
    "description": "No content"
}
>>> :{
BSL.putStrLn $ encodePretty $ (mempty :: Schema)
  & type_       ?~ OpenApiBoolean
  & description ?~ "To be or not to be"
:}
{
    "description": "To be or not to be",
    "type": "boolean"
}

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

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

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

Schema specification

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

ParamSchema t specifies all the common properties, available for every data schema. The t parameter imposes some restrictions on type and items properties (see 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 ToJSONToSchema correspondance:

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

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 $ encodePretty $ toSchema (Proxy :: Proxy Error)
{
    "oneOf": [
        {
            "properties": {
                "tag": {
                    "enum": [
                        "ErrorNoUser"
                    ],
                    "type": "string"
                },
                "userId": {
                    "maximum": 9223372036854775807,
                    "minimum": -9223372036854775808,
                    "type": "integer"
                }
            },
            "required": [
                "userId",
                "tag"
            ],
            "type": "object"
        },
        {
            "properties": {
                "requiredPermission": {
                    "type": "string"
                },
                "tag": {
                    "enum": [
                        "ErrorAccessDenied"
                    ],
                    "type": "string"
                }
            },
            "required": [
                "requiredPermission",
                "tag"
            ],
            "type": "object"
        }
    ],
    "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

Swagger specification

data OpenApi Source #

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

Instances details
Eq OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data OpenApi Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OpenApi Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code OpenApi :: [[Type]] #

HasDatatypeInfo OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf OpenApi :: DatatypeInfo #

HasSwaggerAesonOptions OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

HasInfo OpenApi Info Source # 
Instance details

Defined in Data.OpenApi.Lens

HasComponents OpenApi Components Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Components, b ~ Components) => LabelOptic "components" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Info, b ~ Info) => LabelOptic "info" k OpenApi OpenApi a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasTags OpenApi (InsOrdHashSet Tag) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers OpenApi [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSecurity OpenApi [SecurityRequirement] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs OpenApi (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPaths OpenApi (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

type Code OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf OpenApi Source # 
Instance details

Defined in Data.OpenApi.Internal

data Server Source #

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

Instances details
Eq Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Server Source # 
Instance details

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

Defined in Data.OpenApi.Internal

IsString Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Server #

Generic Server Source # 
Instance details

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

Defined in Data.OpenApi.Internal

FromJSON Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Server :: [[Type]] #

Methods

from :: Server -> Rep Server #

to :: Rep Server -> Server #

HasDatatypeInfo Server Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Server :: DatatypeInfo #

AesonDefaultValue Server Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions Server Source # 
Instance details

Defined in Data.OpenApi.Internal

HasUrl Server Text Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k Server Server a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasServers Operation [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers PathItem [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers OpenApi [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Server (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServer Link (Maybe Server) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasVariables Server (InsOrdHashMap Text ServerVariable) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Server Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Server = D1 ('MetaData "Server" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Server" 'PrefixI 'True) (S1 ('MetaSel ('Just "_serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_serverDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_serverVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text ServerVariable)))))
type Code Server Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Server Source # 
Instance details

Defined in Data.OpenApi.Internal

data ServerVariable Source #

Constructors

ServerVariable 

Fields

Instances

Instances details
Eq ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

Data ServerVariable Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep ServerVariable :: Type -> Type #

ToJSON ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "default" k ServerVariable ServerVariable a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasVariables Server (InsOrdHashMap Text ServerVariable) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep ServerVariable Source # 
Instance details

Defined in Data.OpenApi.Internal

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

data Components Source #

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

Instances

Instances details
Eq Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Components Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Components :: Type -> Type #

Semigroup Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Components Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Components Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Components :: [[Type]] #

HasDatatypeInfo Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Components :: DatatypeInfo #

AesonDefaultValue Components Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions Components Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Components Source # 
Instance details

Defined in Data.OpenApi.Internal

HasComponents OpenApi Components Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasSecuritySchemes Components (Definitions SecurityScheme) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSchemas Components (Definitions Schema) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasResponses Components (Definitions Response) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequestBodies Components (Definitions RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters Components (Definitions Param) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLinks Components (Definitions Link) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Components (Definitions Header) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Components (Definitions Example) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasCallbacks Components (Definitions Callback) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Components Source # 
Instance details

Defined in Data.OpenApi.Internal

type Code Components Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Components Source # 
Instance details

Defined in Data.OpenApi.Internal

Info types

data Info Source #

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

Constructors

Info 

Fields

Instances

Instances details
Eq Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Info Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Info -> ShowS #

show :: Info -> String #

showList :: [Info] -> ShowS #

Generic Info Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

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

sconcat :: NonEmpty Info -> Info #

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

Monoid Info Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

mempty :: Info #

mappend :: Info -> Info -> Info #

mconcat :: [Info] -> Info #

ToJSON Info Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Info Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue Info Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Info Source # 
Instance details

Defined in Data.OpenApi.Internal

HasInfo OpenApi Info Source # 
Instance details

Defined in Data.OpenApi.Lens

HasVersion Info Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTitle Info Text Source # 
Instance details

Defined in Data.OpenApi.Lens

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

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

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

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

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

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Info Info a b #

HasDescription Info (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTermsOfService Info (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Info Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Info = D1 ('MetaData "Info" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

Contact information for the exposed API.

Constructors

Contact 

Fields

Instances

Instances details
Eq Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Contact Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Contact Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasUrl Contact (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName Contact (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEmail Contact (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Contact Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Contact = D1 ('MetaData "Contact" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Contact" 'PrefixI 'True) (S1 ('MetaSel ('Just "_contactName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_contactUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)) :*: S1 ('MetaSel ('Just "_contactEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data License Source #

License information for the exposed API.

Constructors

License 

Fields

Instances

Instances details
Eq License Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data License Source # 
Instance details

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

Defined in Data.OpenApi.Internal

IsString License Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> License #

Generic License Source # 
Instance details

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

Defined in Data.OpenApi.Internal

FromJSON License Source # 
Instance details

Defined in Data.OpenApi.Internal

HasName License Text Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k License License a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasUrl License (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep License Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep License = D1 ('MetaData "License" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "License" 'PrefixI 'True) (S1 ('MetaSel ('Just "_licenseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_licenseUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL))))

PathItem

data PathItem Source #

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

Constructors

PathItem 

Fields

Instances

Instances details
Eq PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Data PathItem Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic PathItem Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code PathItem :: [[Type]] #

HasDatatypeInfo PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf PathItem :: DatatypeInfo #

HasSwaggerAesonOptions PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasServers PathItem [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription PathItem (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTrace PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary PathItem (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPaths OpenApi (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Lens

SwaggerMonoid (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Internal

type DatatypeInfoOf PathItem Source # 
Instance details

Defined in Data.OpenApi.Internal

Operations

data Operation Source #

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

Instances details
Eq Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Operation Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Operation :: Type -> Type #

Semigroup Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Operation :: [[Type]] #

HasDatatypeInfo Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Operation :: DatatypeInfo #

Ixed Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

At Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

Ixed Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

Associated Types

type IxKind Operation #

At Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

HasSwaggerAesonOptions Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

HasResponses Operation Responses Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Responses, b ~ Responses) => LabelOptic "responses" k Operation Operation a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasTags Operation (InsOrdHashSet TagName) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers Operation [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSecurity Operation [SecurityRequirement] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs Operation (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTrace PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOperationId Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Operation (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Operation Source # 
Instance details

Defined in Data.OpenApi.Internal

type Index Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

type IxValue Operation Source # 
Instance details

Defined in Data.OpenApi.Lens

type Index Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

type IxValue Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

type IxKind Operation Source # 
Instance details

Defined in Data.OpenApi.Optics

data Tag Source #

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

Constructors

Tag 

Fields

Instances

Instances details
Eq Tag Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Tag Source # 
Instance details

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

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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

IsString Tag Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Tag #

Generic Tag Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Tag Source # 
Instance details

Defined in Data.OpenApi.Internal

HasName Tag TagName Source # 
Instance details

Defined in Data.OpenApi.Lens

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

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

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Tag Tag a b #

HasTags OpenApi (InsOrdHashSet Tag) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs Tag (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Tag (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Tag Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Tag = D1 ('MetaData "Tag" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Tag" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TagName) :*: (S1 ('MetaSel ('Just "_tagDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_tagExternalDocs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExternalDocs)))))

type TagName = Text Source #

Tag name.

Types and formats

data OpenApiType where Source #

Instances

Instances details
Eq OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OpenApiType Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OpenApiType :: Type -> Type #

ToJSON OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

HasType NamedSchema (Maybe OpenApiType) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasType Schema (Maybe OpenApiType) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OpenApiType Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep OpenApiType = D1 ('MetaData "OpenApiType" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Definitions = InsOrdHashMap Text Source #

A list of definitions that can be used in references.

data Style Source #

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

Instances details
Eq Style Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Style Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Style -> ShowS #

show :: Style -> String #

showList :: [Style] -> ShowS #

Generic Style Source # 
Instance details

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

Defined in Data.OpenApi.Internal

FromJSON Style Source # 
Instance details

Defined in Data.OpenApi.Internal

HasStyle Param (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasStyle Encoding (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Style Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Style = D1 ('MetaData "Style" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

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

Constructors

Param 

Fields

  • _paramName :: Text

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

  • _paramDescription :: Maybe Text

    A brief description of the parameter. This could contain examples of use. 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

Instances details
Eq Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Param Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Param -> ShowS #

show :: Param -> String #

showList :: [Param] -> ShowS #

Generic Param Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

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

sconcat :: NonEmpty Param -> Param #

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

Monoid Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

mempty :: Param #

mappend :: Param -> Param -> Param #

mconcat :: [Param] -> Param #

ToJSON Param Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Param :: [[Type]] #

Methods

from :: Param -> Rep Param #

to :: Rep Param -> Param #

HasDatatypeInfo Param Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Param :: DatatypeInfo #

Methods

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

HasSwaggerAesonOptions Param Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Param Source # 
Instance details

Defined in Data.OpenApi.Internal

HasName Param Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasIn Param ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Lens

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

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

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

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

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

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

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

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

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

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

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

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Param Param a b #

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters Components (Definitions Param) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Param (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasExample Param (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasStyle Param (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowReserved Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowEmptyValue Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced Param) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Param) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Param Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Param Source # 
Instance details

Defined in Data.OpenApi.Internal

data ParamLocation Source #

Constructors

ParamQuery

Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.

ParamHeader

Custom headers that are expected as part of the request.

ParamPath

Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in items{itemId}, the path parameter is itemId.

ParamCookie

Used to pass a specific cookie value to the API.

Instances

Instances details
Eq ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

Data ParamLocation Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep ParamLocation :: Type -> Type #

ToJSON ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

HasIn Param ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ParamLocation = D1 ('MetaData "ParamLocation" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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)))

data Header Source #

Header fields have the same meaning as for Param.

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

Instances

Instances details
Eq Header Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Header Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Header Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid Header Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Header Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Header Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Header Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Header :: [[Type]] #

Methods

from :: Header -> Rep Header #

to :: Rep Header -> Header #

HasDatatypeInfo Header Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Header :: DatatypeInfo #

HasSwaggerAesonOptions Header Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasHeaders Components (Definitions Header) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Header (Maybe HeaderName) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasExample Header (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowEmptyValue Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced Header) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Header) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Header Source # 
Instance details

Defined in Data.OpenApi.Internal

type Code Header Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Header Source # 
Instance details

Defined in Data.OpenApi.Internal

data Example Source #

Constructors

Example 

Fields

Instances

Instances details
Eq Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Example Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Example Source # 
Instance details

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

Defined in Data.OpenApi.Internal

FromJSON Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Example :: [[Type]] #

HasDatatypeInfo Example Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Example :: DatatypeInfo #

HasSwaggerAesonOptions Example Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasExamples Components (Definitions Example) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Example (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary Example (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasValue Example (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalValue Example (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced Example) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Example) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Example Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Example = D1 ('MetaData "Example" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Example" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_exampleSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_exampleDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_exampleValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "_exampleExternalValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)))))
type Code Example Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Example Source # 
Instance details

Defined in Data.OpenApi.Internal

data RequestBody Source #

Describes a single request body.

Constructors

RequestBody 

Fields

Instances

Instances details
Eq RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Data RequestBody Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep RequestBody :: Type -> Type #

Semigroup RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code RequestBody :: [[Type]] #

HasDatatypeInfo RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf RequestBody :: DatatypeInfo #

HasSwaggerAesonOptions RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasRequestBodies Components (Definitions RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription RequestBody (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired RequestBody (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep RequestBody = D1 ('MetaData "RequestBody" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "RequestBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "_requestBodyDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "_requestBodyContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap MediaType MediaTypeObject)) :*: S1 ('MetaSel ('Just "_requestBodyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))
type Code RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf RequestBody Source # 
Instance details

Defined in Data.OpenApi.Internal

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

data MediaTypeObject Source #

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

Constructors

MediaTypeObject 

Fields

Instances

Instances details
Eq MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Data MediaTypeObject Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep MediaTypeObject :: Type -> Type #

Semigroup MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code MediaTypeObject :: [[Type]] #

HasDatatypeInfo MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Lens

HasExample MediaTypeObject (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent Response (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep MediaTypeObject = D1 ('MetaData "MediaTypeObject" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "MediaTypeObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_mediaTypeObjectSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Schema))) :*: S1 ('MetaSel ('Just "_mediaTypeObjectExample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "_mediaTypeObjectExamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Example))) :*: S1 ('MetaSel ('Just "_mediaTypeObjectEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Encoding)))))
type Code MediaTypeObject Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf MediaTypeObject Source # 
Instance details

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 Source #

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 binaryapplication/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

Instances details
Eq Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Encoding Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Encoding Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Encoding :: [[Type]] #

HasDatatypeInfo Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Encoding :: DatatypeInfo #

HasSwaggerAesonOptions Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasStyle Encoding (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Encoding (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowReserved Encoding (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContentType Encoding (Maybe MediaType) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Encoding = D1 ('MetaData "Encoding" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Encoding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_encodingContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MediaType)) :*: S1 ('MetaSel ('Just "_encodingHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Header)))) :*: (S1 ('MetaSel ('Just "_encodingStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Style)) :*: (S1 ('MetaSel ('Just "_encodingExplode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "_encodingAllowReserved") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))
type Code Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Encoding Source # 
Instance details

Defined in Data.OpenApi.Internal

Schemas

data Schema Source #

Constructors

Schema 

Fields

Instances

Instances details
Eq Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Schema Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Schema Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Schema :: [[Type]] #

Methods

from :: Schema -> Rep Schema #

to :: Rep Schema -> Schema #

HasDatatypeInfo Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Schema :: DatatypeInfo #

HasSwaggerAesonOptions Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSchema NamedSchema Schema Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasExternalDocs Schema (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSchemas Components (Definitions Schema) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Schema (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired Schema [ParamName] Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasExample Schema (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTitle Schema (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasXml Schema (Maybe Xml) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasWriteOnly Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUniqueItems Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasType Schema (Maybe OpenApiType) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasReadOnly Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPattern Schema (Maybe Pattern) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasNullable Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasNot Schema (Maybe (Referenced Schema)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMultipleOf Schema (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinimum Schema (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinProperties Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinLength Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinItems Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaximum Schema (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaxProperties Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaxLength Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaxItems Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasItems Schema (Maybe OpenApiItems) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasFormat Schema (Maybe Format) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExclusiveMinimum Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExclusiveMaximum Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasEnum Schema (Maybe [Value]) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDiscriminator Schema (Maybe Discriminator) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDefault Schema (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

ToJSON (Referenced Schema) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Schema) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Schema Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Schema Source # 
Instance details

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 Source #

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

Instances

Instances details
Eq NamedSchema Source # 
Instance details

Defined in Data.OpenApi.Internal

Data NamedSchema Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic NamedSchema Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep NamedSchema :: Type -> Type #

HasSchema NamedSchema Schema Source # 
Instance details

Defined in Data.OpenApi.Lens

(a ~ Maybe Value, b ~ Maybe Value) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Format, b ~ Maybe Format) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe OpenApiItems, b ~ Maybe OpenApiItems) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Scientific, b ~ Maybe Scientific) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

(a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Schema, b ~ Schema) => LabelOptic "schema" k NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe OpenApiType, b ~ Maybe OpenApiType) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasName NamedSchema (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasType NamedSchema (Maybe OpenApiType) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep NamedSchema Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep NamedSchema = D1 ('MetaData "NamedSchema" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

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.

Instances

Instances details
Eq OpenApiItems Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OpenApiItems Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: OpenApiItems -> Constr #

dataTypeOf :: OpenApiItems -> DataType #

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

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

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

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

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

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

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

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

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

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

Show OpenApiItems Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON OpenApiItems Source #

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

>>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
{
    "example": [],
    "items": {},
    "maxItems": 0
}
Instance details

Defined in Data.OpenApi.Internal

FromJSON OpenApiItems Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Optics

(a ~ Referenced Schema, b ~ Referenced Schema) => LabelOptic "_OpenApiItemsObject" A_Review OpenApiItems OpenApiItems a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasSchema s Schema => HasItems s (Maybe OpenApiItems) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasItems Schema (Maybe OpenApiItems) Source # 
Instance details

Defined in Data.OpenApi.Lens

data Xml Source #

Constructors

Xml 

Fields

  • _xmlName :: Maybe Text

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

Instances details
Eq Xml Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data Xml Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> Xml -> ShowS #

show :: Xml -> String #

showList :: [Xml] -> ShowS #

Generic Xml Source # 
Instance details

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

Defined in Data.OpenApi.Internal

FromJSON Xml Source # 
Instance details

Defined in Data.OpenApi.Internal

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

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

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

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

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

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx Xml Xml a b #

HasName Xml (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasXml Schema (Maybe Xml) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasWrapped Xml (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasPrefix Xml (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasNamespace Xml (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAttribute Xml (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Xml Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Xml = D1 ('MetaData "Xml" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

Regex pattern for string type.

data AdditionalProperties Source #

Instances

Instances details
Eq AdditionalProperties Source # 
Instance details

Defined in Data.OpenApi.Internal

Data AdditionalProperties Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: AdditionalProperties -> Constr #

dataTypeOf :: AdditionalProperties -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AdditionalProperties Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON AdditionalProperties Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON AdditionalProperties Source # 
Instance details

Defined in Data.OpenApi.Internal

HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # 
Instance details

Defined in Data.OpenApi.Lens

data Discriminator Source #

Constructors

Discriminator 

Fields

Instances

Instances details
Eq Discriminator Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Discriminator Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Discriminator Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Discriminator :: Type -> Type #

ToJSON Discriminator Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Discriminator Source # 
Instance details

Defined in Data.OpenApi.Internal

HasPropertyName Discriminator Text Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "propertyName" k Discriminator Discriminator a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasDiscriminator Schema (Maybe Discriminator) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMapping Discriminator (InsOrdHashMap Text Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Discriminator Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Discriminator = D1 ('MetaData "Discriminator" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

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

Constructors

Responses 

Fields

Instances

Instances details
Eq Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Responses Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep Responses :: Type -> Type #

Semigroup Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Responses :: [[Type]] #

HasDatatypeInfo Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Responses :: DatatypeInfo #

Ixed Responses Source # 
Instance details

Defined in Data.OpenApi.Lens

At Responses Source # 
Instance details

Defined in Data.OpenApi.Lens

Ixed Responses Source # 
Instance details

Defined in Data.OpenApi.Optics

Associated Types

type IxKind Responses #

At Responses Source # 
Instance details

Defined in Data.OpenApi.Optics

AesonDefaultValue Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

HasResponses Operation Responses Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasDefault Responses (Maybe (Referenced Response)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Responses = D1 ('MetaData "Responses" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Responses" 'PrefixI 'True) (S1 ('MetaSel ('Just "_responsesDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Referenced Response))) :*: S1 ('MetaSel ('Just "_responsesResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HttpStatusCode (Referenced Response)))))
type Code Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Responses Source # 
Instance details

Defined in Data.OpenApi.Internal

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

Defined in Data.OpenApi.Lens

type IxValue Responses Source # 
Instance details

Defined in Data.OpenApi.Lens

type Index Responses Source # 
Instance details

Defined in Data.OpenApi.Optics

type IxValue Responses Source # 
Instance details

Defined in Data.OpenApi.Optics

type IxKind Responses Source # 
Instance details

Defined in Data.OpenApi.Optics

data Response Source #

Describes a single response from an API Operation.

Constructors

Response 

Fields

Instances

Instances details
Eq Response Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Response Source # 
Instance details

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

Defined in Data.OpenApi.Internal

IsString Response Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Response Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Monoid Response Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Response Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Response Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic Response Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code Response :: [[Type]] #

HasDatatypeInfo Response Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf Response :: DatatypeInfo #

HasSwaggerAesonOptions Response Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid Response Source # 
Instance details

Defined in Data.OpenApi.Internal

HasDescription Response Text Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "description" k Response Response a b Source # 
Instance details

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

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

Defined in Data.OpenApi.Optics

HasResponses Components (Definitions Response) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDefault Responses (Maybe (Referenced Response)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLinks Response (InsOrdHashMap Text (Referenced Link)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasContent Response (InsOrdHashMap MediaType MediaTypeObject) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced Response) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Response) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Response Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Response = D1 ('MetaData "Response" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "Response" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_responseDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_responseContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap MediaType MediaTypeObject))) :*: (S1 ('MetaSel ('Just "_responseHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap HeaderName (Referenced Header))) :*: S1 ('MetaSel ('Just "_responseLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text (Referenced Link))))))
type Code Response Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf Response Source # 
Instance details

Defined in Data.OpenApi.Internal

data Link Source #

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

Constructors

Link 

Fields

Instances

newtype Callback Source #

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.

Instances

Instances details
Eq Callback Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Callback Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic Callback Source # 
Instance details

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

Defined in Data.OpenApi.Internal

FromJSON Callback Source # 
Instance details

Defined in Data.OpenApi.Internal

HasCallbacks Components (Definitions Callback) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # 
Instance details

Defined in Data.OpenApi.Lens

ToJSON (Referenced Callback) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Callback) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Callback Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep Callback = D1 ('MetaData "Callback" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'True) (C1 ('MetaCons "Callback" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text PathItem))))

Security

data SecurityScheme Source #

Constructors

SecurityScheme 

Fields

Instances

Instances details
Eq SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

Data SecurityScheme Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep SecurityScheme :: Type -> Type #

Semigroup SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code SecurityScheme :: [[Type]] #

HasDatatypeInfo SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSwaggerAesonOptions SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

HasType SecurityScheme SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k SecurityScheme SecurityScheme a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ SecuritySchemeType, b ~ SecuritySchemeType) => LabelOptic "type" k SecurityScheme SecurityScheme a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasSecuritySchemes Components (Definitions SecurityScheme) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription SecurityScheme (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep SecurityScheme = D1 ('MetaData "SecurityScheme" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "SecurityScheme" 'PrefixI 'True) (S1 ('MetaSel ('Just "_securitySchemeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecuritySchemeType) :*: S1 ('MetaSel ('Just "_securitySchemeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))
type Code SecurityScheme Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf SecurityScheme Source # 
Instance details

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 Source #

>>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer Nothing))
{
    "scheme": "bearer",
    "type": "http"
}
>>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt")))
{
    "bearerFormat": "jwt",
    "scheme": "bearer",
    "type": "http"
}
>>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp HttpSchemeBasic)
{
    "scheme": "basic",
    "type": "http"
}
>>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeCustom "CANARY"))
{
    "scheme": "CANARY",
    "type": "http"
}
>>> BSL.putStrLn $ encodePretty (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie))
{
    "in": "cookie",
    "name": "id",
    "type": "apiKey"
}

Instances

Instances details
Eq SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

Data SecuritySchemeType Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep SecuritySchemeType :: Type -> Type #

ToJSON SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

HasType SecurityScheme SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Prism, a ~ ApiKeyParams, b ~ ApiKeyParams) => LabelOptic "_SecuritySchemeApiKey" k SecuritySchemeType SecuritySchemeType a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Prism, a ~ HttpSchemeType, b ~ HttpSchemeType) => LabelOptic "_SecuritySchemeHttp" k SecuritySchemeType SecuritySchemeType a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Prism, a ~ OAuth2Flows, b ~ OAuth2Flows) => LabelOptic "_SecuritySchemeOAuth2" k SecuritySchemeType SecuritySchemeType a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Prism, a ~ URL, b ~ URL) => LabelOptic "_SecuritySchemeOpenIdConnect" k SecuritySchemeType SecuritySchemeType a b Source # 
Instance details

Defined in Data.OpenApi.Optics

type Rep SecuritySchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep SecuritySchemeType = D1 ('MetaData "SecuritySchemeType" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

Instances

Instances details
Eq HttpSchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

Data HttpSchemeType Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic HttpSchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep HttpSchemeType :: Type -> Type #

type Rep HttpSchemeType Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep HttpSchemeType = D1 ('MetaData "HttpSchemeType" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

Instances

Instances details
Eq SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

Data SecurityDefinitions Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep SecurityDefinitions :: Type -> Type #

Semigroup SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep SecurityDefinitions Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep SecurityDefinitions = D1 ('MetaData "SecurityDefinitions" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'True) (C1 ('MetaCons "SecurityDefinitions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Definitions SecurityScheme))))

newtype SecurityRequirement Source #

Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes).

Instances

Instances details
Eq SecurityRequirement Source # 
Instance details

Defined in Data.OpenApi.Internal

Data SecurityRequirement Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Show SecurityRequirement Source # 
Instance details

Defined in Data.OpenApi.Internal

Semigroup SecurityRequirement Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid SecurityRequirement Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON SecurityRequirement Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON SecurityRequirement Source # 
Instance details

Defined in Data.OpenApi.Internal

HasSecurity Operation [SecurityRequirement] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSecurity OpenApi [SecurityRequirement] Source # 
Instance details

Defined in Data.OpenApi.Lens

API key

data ApiKeyParams Source #

Constructors

ApiKeyParams 

Fields

Instances

Instances details
Eq ApiKeyParams Source # 
Instance details

Defined in Data.OpenApi.Internal

Data ApiKeyParams Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic ApiKeyParams Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep ApiKeyParams :: Type -> Type #

ToJSON ApiKeyParams Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON ApiKeyParams Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ApiKeyParams Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ApiKeyParams = D1 ('MetaData "ApiKeyParams" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "ApiKeyParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "_apiKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_apiKeyIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiKeyLocation)))

data ApiKeyLocation Source #

The location of the API key.

Instances

Instances details
Eq ApiKeyLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

Data ApiKeyLocation Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic ApiKeyLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep ApiKeyLocation :: Type -> Type #

ToJSON ApiKeyLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON ApiKeyLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ApiKeyLocation Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ApiKeyLocation = D1 ('MetaData "ApiKeyLocation" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

Constructors

OAuth2Flows 

Fields

Instances

Instances details
Eq OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OAuth2Flows Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2Flows :: Type -> Type #

Semigroup OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Code OAuth2Flows :: [[Type]] #

HasDatatypeInfo OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type DatatypeInfoOf OAuth2Flows :: DatatypeInfo #

HasSwaggerAesonOptions OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow), b ~ Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) => LabelOptic "authorizationCode" k OAuth2Flows OAuth2Flows a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2ClientCredentialsFlow), b ~ Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) => LabelOptic "clientCredentials" k OAuth2Flows OAuth2Flows a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2ImplicitFlow), b ~ Maybe (OAuth2Flow OAuth2ImplicitFlow)) => LabelOptic "implicit" k OAuth2Flows OAuth2Flows a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ Maybe (OAuth2Flow OAuth2PasswordFlow), b ~ Maybe (OAuth2Flow OAuth2PasswordFlow)) => LabelOptic "password" k OAuth2Flows OAuth2Flows a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep OAuth2Flows = D1 ('MetaData "OAuth2Flows" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "OAuth2Flows" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_oAuth2FlowsImplicit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2ImplicitFlow))) :*: S1 ('MetaSel ('Just "_oAuth2FlowsPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2PasswordFlow)))) :*: (S1 ('MetaSel ('Just "_oAuth2FlowsClientCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow))) :*: S1 ('MetaSel ('Just "_oAuth2FlowsAuthorizationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow))))))
type Code OAuth2Flows Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf OAuth2Flows Source # 
Instance details

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 Source #

Constructors

OAuth2Flow 

Fields

Instances

Instances details
HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

Eq p => Eq (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: OAuth2Flow p -> OAuth2Flow p -> Bool #

(/=) :: OAuth2Flow p -> OAuth2Flow p -> Bool #

Data p => Data (OAuth2Flow p) Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic (OAuth2Flow p) Source # 
Instance details

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

Defined in Data.OpenApi.Internal

(Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

(Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic (OAuth2Flow p) Source # 
Instance details

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

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

Defined in Data.OpenApi.Internal

AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep (OAuth2Flow p) = D1 ('MetaData "OAuth2Flow" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'False) (C1 ('MetaCons "OAuth2Flow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2Params") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 p) :*: (S1 ('MetaSel ('Just "_oAath2RefreshUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URL)) :*: S1 ('MetaSel ('Just "_oAuth2Scopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InsOrdHashMap Text Text)))))
type Code (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

type DatatypeInfoOf (OAuth2Flow p) Source # 
Instance details

Defined in Data.OpenApi.Internal

newtype OAuth2ImplicitFlow Source #

Instances

Instances details
Eq OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OAuth2ImplicitFlow Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2ImplicitFlow :: Type -> Type #

ToJSON OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

HasAuthorizationUrl OAuth2ImplicitFlow AuthorizationURL Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ An_Iso, a ~ AuthorizationURL, b ~ AuthorizationURL) => LabelOptic "authorizationUrl" k OAuth2ImplicitFlow OAuth2ImplicitFlow a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OAuth2ImplicitFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep OAuth2ImplicitFlow = D1 ('MetaData "OAuth2ImplicitFlow" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'True) (C1 ('MetaCons "OAuth2ImplicitFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2ImplicitFlowAuthorizationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthorizationURL)))

newtype OAuth2PasswordFlow Source #

Instances

Instances details
Eq OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OAuth2PasswordFlow Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2PasswordFlow :: Type -> Type #

ToJSON OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

HasTokenUrl OAuth2PasswordFlow TokenURL Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ An_Iso, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2PasswordFlow OAuth2PasswordFlow a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OAuth2PasswordFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep OAuth2PasswordFlow = D1 ('MetaData "OAuth2PasswordFlow" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'True) (C1 ('MetaCons "OAuth2PasswordFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2PasswordFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)))

newtype OAuth2ClientCredentialsFlow Source #

Instances

Instances details
Eq OAuth2ClientCredentialsFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OAuth2ClientCredentialsFlow Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OAuth2ClientCredentialsFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2ClientCredentialsFlow :: Type -> Type #

ToJSON OAuth2ClientCredentialsFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OAuth2ClientCredentialsFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue OAuth2ClientCredentialsFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

HasTokenUrl OAuth2ClientCredentialsFlow TokenURL Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ An_Iso, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasClientCredentials OAuth2Flows (Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OAuth2ClientCredentialsFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep OAuth2ClientCredentialsFlow = D1 ('MetaData "OAuth2ClientCredentialsFlow" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" 'True) (C1 ('MetaCons "OAuth2ClientCredentialsFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "_oAuth2ClientCredentialsFlowTokenUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenURL)))

data OAuth2AuthorizationCodeFlow Source #

Instances

Instances details
Eq OAuth2AuthorizationCodeFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Data OAuth2AuthorizationCodeFlow Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Generic OAuth2AuthorizationCodeFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep OAuth2AuthorizationCodeFlow :: Type -> Type #

ToJSON OAuth2AuthorizationCodeFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON OAuth2AuthorizationCodeFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue OAuth2AuthorizationCodeFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

HasAuthorizationUrl OAuth2AuthorizationCodeFlow AuthorizationURL Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTokenUrl OAuth2AuthorizationCodeFlow TokenURL Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ AuthorizationURL, b ~ AuthorizationURL) => LabelOptic "authorizationUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ TokenURL, b ~ TokenURL) => LabelOptic "tokenUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasAuthorizationCode OAuth2Flows (Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep OAuth2AuthorizationCodeFlow Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep OAuth2AuthorizationCodeFlow = D1 ('MetaData "OAuth2AuthorizationCodeFlow" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.

type TokenURL = Text Source #

The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.

External documentation

data ExternalDocs Source #

Allows referencing an external resource for extended documentation.

Constructors

ExternalDocs 

Fields

Instances

Instances details
Eq ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

Data ExternalDocs Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Show ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

Generic ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

Associated Types

type Rep ExternalDocs :: Type -> Type #

Semigroup ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

Hashable ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

HasUrl ExternalDocs URL Source # 
Instance details

Defined in Data.OpenApi.Lens

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k ExternalDocs ExternalDocs a b Source # 
Instance details

Defined in Data.OpenApi.Optics

(k ~ A_Lens, a ~ URL, b ~ URL) => LabelOptic "url" k ExternalDocs ExternalDocs a b Source # 
Instance details

Defined in Data.OpenApi.Optics

HasExternalDocs Tag (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs Schema (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs Operation (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalDocs OpenApi (Maybe ExternalDocs) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription ExternalDocs (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

type Rep ExternalDocs Source # 
Instance details

Defined in Data.OpenApi.Internal

type Rep ExternalDocs = D1 ('MetaData "ExternalDocs" "Data.OpenApi.Internal" "openapi3-3.1.0-7isxFiHLHmmGsqOyvZgXZT" '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 Source #

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

Constructors

Reference 

Fields

Instances

Instances details
Eq Reference Source # 
Instance details

Defined in Data.OpenApi.Internal

Data Reference Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

toConstr :: Reference -> Constr #

dataTypeOf :: Reference -> DataType #

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

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

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

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

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

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

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

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

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

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

Show Reference Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON Reference Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON Reference Source # 
Instance details

Defined in Data.OpenApi.Internal

data Referenced a Source #

Constructors

Ref Reference 
Inline a 

Instances

Instances details
Functor Referenced Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fmap :: (a -> b) -> Referenced a -> Referenced b #

(<$) :: a -> Referenced b -> Referenced a #

(k ~ A_Prism, a1 ~ a2, b ~ a3) => LabelOptic "_Inline" k (Referenced a2) (Referenced a3) a1 b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx (Referenced a2) (Referenced a3) a1 b #

(k ~ A_Prism, a1 ~ Reference, b ~ Reference) => LabelOptic "_Ref" k (Referenced a2) (Referenced a2) a1 b Source # 
Instance details

Defined in Data.OpenApi.Optics

Methods

labelOptic :: Optic k NoIx (Referenced a2) (Referenced a2) a1 b #

HasParameters Operation [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasParameters PathItem [Referenced Param] Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasNot Schema (Maybe (Referenced Schema)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDefault Responses (Maybe (Referenced Response)) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasLinks Response (InsOrdHashMap Text (Referenced Link)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Defined in Data.OpenApi.Lens

Eq a => Eq (Referenced a) Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

(==) :: Referenced a -> Referenced a -> Bool #

(/=) :: Referenced a -> Referenced a -> Bool #

Data a => Data (Referenced a) Source # 
Instance details

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

Defined in Data.OpenApi.Internal

IsString a => IsString (Referenced a) Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

fromString :: String -> Referenced a #

ToJSON (Referenced Header) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced Callback) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced Response) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced Schema) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced Link) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced Example) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced Param) Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON (Referenced RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Header) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Callback) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Response) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Schema) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Link) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Example) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced Param) Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON (Referenced RequestBody) Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid a => SwaggerMonoid (Referenced a) Source # 
Instance details

Defined in Data.OpenApi.Internal

Miscellaneous

newtype MimeList Source #

Constructors

MimeList 

Fields

Instances

Instances details
Eq MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

Data MimeList Source # 
Instance details

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

Defined in Data.OpenApi.Internal

Semigroup MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

Monoid MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

ToJSON MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

AesonDefaultValue MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid MimeList Source # 
Instance details

Defined in Data.OpenApi.Internal

newtype URL Source #

Constructors

URL 

Fields

Instances

Instances details
Eq URL Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

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

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

Data URL Source # 
Instance details

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

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

Defined in Data.OpenApi.Internal

Methods

showsPrec :: Int -> URL -> ShowS #

show :: URL -> String #

showList :: [URL] -> ShowS #

Hashable URL Source # 
Instance details

Defined in Data.OpenApi.Internal

Methods

hashWithSalt :: Int -> URL -> Int #

hash :: URL -> Int #

ToJSON URL Source # 
Instance details

Defined in Data.OpenApi.Internal

FromJSON URL Source # 
Instance details

Defined in Data.OpenApi.Internal

SwaggerMonoid URL Source # 
Instance details

Defined in Data.OpenApi.Internal

HasUrl ExternalDocs URL Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUrl License (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUrl Contact (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExternalValue Example (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens