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

Data.OpenApi

Contents

How to use this library
Re-exports
Swagger specification

Description

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

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

Synopsis

module Data.OpenApi.Lens
module Data.OpenApi.Operation
module Data.OpenApi.ParamSchema
module Data.OpenApi.Schema
module Data.OpenApi.Schema.Validation
data OpenApi = OpenApi {
- _openApiInfo :: Info
- _openApiServers :: [ Server ]
- _openApiPaths :: InsOrdHashMap FilePath PathItem
- _openApiComponents :: Components
- _openApiSecurity :: [ SecurityRequirement ]
- _openApiTags :: InsOrdHashSet Tag
- _openApiExternalDocs :: Maybe ExternalDocs
- _openApiOpenapi :: OpenApiSpecVersion
}
data Server = Server {
- _serverUrl :: Text
- _serverDescription :: Maybe Text
- _serverVariables :: InsOrdHashMap Text ServerVariable
}
data ServerVariable = ServerVariable {
- _serverVariableEnum :: Maybe ( InsOrdHashSet Text )
- _serverVariableDefault :: Text
- _serverVariableDescription :: Maybe Text
}
data Components = Components {
- _componentsSchemas :: Definitions Schema
- _componentsResponses :: Definitions Response
- _componentsParameters :: Definitions Param
- _componentsExamples :: Definitions Example
- _componentsRequestBodies :: Definitions RequestBody
- _componentsHeaders :: Definitions Header
- _componentsSecuritySchemes :: SecurityDefinitions
- _componentsLinks :: Definitions Link
- _componentsCallbacks :: Definitions Callback
}
data Info = Info {
- _infoTitle :: Text
- _infoDescription :: Maybe Text
- _infoTermsOfService :: Maybe Text
- _infoContact :: Maybe Contact
- _infoLicense :: Maybe License
- _infoVersion :: Text
}
data Contact = Contact {
- _contactName :: Maybe Text
- _contactUrl :: Maybe URL
- _contactEmail :: Maybe Text
}
data License = License {
- _licenseName :: Text
- _licenseUrl :: Maybe URL
}
data PathItem = PathItem {
- _pathItemSummary :: Maybe Text
- _pathItemDescription :: Maybe Text
- _pathItemGet :: Maybe Operation
- _pathItemPut :: Maybe Operation
- _pathItemPost :: Maybe Operation
- _pathItemDelete :: Maybe Operation
- _pathItemOptions :: Maybe Operation
- _pathItemHead :: Maybe Operation
- _pathItemPatch :: Maybe Operation
- _pathItemTrace :: Maybe Operation
- _pathItemServers :: [ Server ]
- _pathItemParameters :: [ Referenced Param ]
}
data Operation = Operation {
- _operationTags :: InsOrdHashSet TagName
- _operationSummary :: Maybe Text
- _operationDescription :: Maybe Text
- _operationExternalDocs :: Maybe ExternalDocs
- _operationOperationId :: Maybe Text
- _operationParameters :: [ Referenced Param ]
- _operationRequestBody :: Maybe ( Referenced RequestBody )
- _operationResponses :: Responses
- _operationCallbacks :: InsOrdHashMap Text ( Referenced Callback )
- _operationDeprecated :: Maybe Bool
- _operationSecurity :: [ SecurityRequirement ]
- _operationServers :: [ Server ]
}
data Tag = Tag {
- _tagName :: TagName
- _tagDescription :: Maybe Text
- _tagExternalDocs :: Maybe ExternalDocs
}
type TagName = Text
data OpenApiType where
- OpenApiString :: OpenApiType
- OpenApiNumber :: OpenApiType
- OpenApiInteger :: OpenApiType
- OpenApiBoolean :: OpenApiType
- OpenApiArray :: OpenApiType
- OpenApiNull :: OpenApiType
- OpenApiObject :: OpenApiType
type Format = Text
type Definitions = InsOrdHashMap Text
data Style
- = StyleMatrix
- | StyleLabel
- | StyleForm
- | StyleSimple
- | StyleSpaceDelimited
- | StylePipeDelimited
- | StyleDeepObject
data Param = Param {
- _paramName :: Text
- _paramDescription :: Maybe Text
- _paramRequired :: Maybe Bool
- _paramDeprecated :: Maybe Bool
- _paramIn :: ParamLocation
- _paramAllowEmptyValue :: Maybe Bool
- _paramAllowReserved :: Maybe Bool
- _paramSchema :: Maybe ( Referenced Schema )
- _paramStyle :: Maybe Style
- _paramExplode :: Maybe Bool
- _paramExample :: Maybe Value
- _paramExamples :: InsOrdHashMap Text ( Referenced Example )
}
data ParamLocation
- = ParamQuery
- | ParamHeader
- | ParamPath
- | ParamCookie
type ParamName = Text
data Header = Header {
- _headerDescription :: Maybe HeaderName
- _headerRequired :: Maybe Bool
- _headerDeprecated :: Maybe Bool
- _headerAllowEmptyValue :: Maybe Bool
- _headerExplode :: Maybe Bool
- _headerExample :: Maybe Value
- _headerExamples :: InsOrdHashMap Text ( Referenced Example )
- _headerSchema :: Maybe ( Referenced Schema )
}
type HeaderName = Text
data Example = Example {
- _exampleSummary :: Maybe Text
- _exampleDescription :: Maybe Text
- _exampleValue :: Maybe Value
- _exampleExternalValue :: Maybe URL
}
data RequestBody = RequestBody {
- _requestBodyDescription :: Maybe Text
- _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
- _requestBodyRequired :: Maybe Bool
}
data MediaTypeObject = MediaTypeObject {
- _mediaTypeObjectSchema :: Maybe ( Referenced Schema )
- _mediaTypeObjectExample :: Maybe Value
- _mediaTypeObjectExamples :: InsOrdHashMap Text ( Referenced Example )
- _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
}
data Encoding = Encoding {
- _encodingContentType :: Maybe MediaType
- _encodingHeaders :: InsOrdHashMap Text ( Referenced Header )
- _encodingStyle :: Maybe Style
- _encodingExplode :: Maybe Bool
- _encodingAllowReserved :: Maybe Bool
}
data Schema = Schema {
- _schemaTitle :: Maybe Text
- _schemaDescription :: Maybe Text
- _schemaRequired :: [ ParamName ]
- _schemaNullable :: Maybe Bool
- _schemaAllOf :: Maybe [ Referenced Schema ]
- _schemaOneOf :: Maybe [ Referenced Schema ]
- _schemaNot :: Maybe ( Referenced Schema )
- _schemaAnyOf :: Maybe [ Referenced Schema ]
- _schemaProperties :: InsOrdHashMap Text ( Referenced Schema )
- _schemaAdditionalProperties :: Maybe AdditionalProperties
- _schemaDiscriminator :: Maybe Discriminator
- _schemaReadOnly :: Maybe Bool
- _schemaWriteOnly :: Maybe Bool
- _schemaXml :: Maybe Xml
- _schemaExternalDocs :: Maybe ExternalDocs
- _schemaExample :: Maybe Value
- _schemaDeprecated :: Maybe Bool
- _schemaMaxProperties :: Maybe Integer
- _schemaMinProperties :: Maybe Integer
- _schemaDefault :: Maybe Value
- _schemaType :: Maybe OpenApiType
- _schemaFormat :: Maybe Format
- _schemaItems :: Maybe OpenApiItems
- _schemaMaximum :: Maybe Scientific
- _schemaExclusiveMaximum :: Maybe Bool
- _schemaMinimum :: Maybe Scientific
- _schemaExclusiveMinimum :: Maybe Bool
- _schemaMaxLength :: Maybe Integer
- _schemaMinLength :: Maybe Integer
- _schemaPattern :: Maybe Pattern
- _schemaMaxItems :: Maybe Integer
- _schemaMinItems :: Maybe Integer
- _schemaUniqueItems :: Maybe Bool
- _schemaEnum :: Maybe [ Value ]
- _schemaMultipleOf :: Maybe Scientific
}
data NamedSchema = NamedSchema {
- _namedSchemaName :: Maybe Text
- _namedSchemaSchema :: Schema
}
data OpenApiItems where
- OpenApiItemsObject :: Referenced Schema -> OpenApiItems
- OpenApiItemsArray :: [ Referenced Schema ] -> OpenApiItems
data Xml = Xml {
- _xmlName :: Maybe Text
- _xmlNamespace :: Maybe Text
- _xmlPrefix :: Maybe Text
- _xmlAttribute :: Maybe Bool
- _xmlWrapped :: Maybe Bool
}
type Pattern = Text
data AdditionalProperties
- = AdditionalPropertiesAllowed Bool
- | AdditionalPropertiesSchema ( Referenced Schema )
data Discriminator = Discriminator {
- _discriminatorPropertyName :: Text
- _discriminatorMapping :: InsOrdHashMap Text Text
}
data Responses = Responses {
- _responsesDefault :: Maybe ( Referenced Response )
- _responsesResponses :: InsOrdHashMap HttpStatusCode ( Referenced Response )
}
data Response = Response {
- _responseDescription :: Text
- _responseContent :: InsOrdHashMap MediaType MediaTypeObject
- _responseHeaders :: InsOrdHashMap HeaderName ( Referenced Header )
- _responseLinks :: InsOrdHashMap Text ( Referenced Link )
}
type HttpStatusCode = Int
data Link = Link {
- _linkOperationRef :: Maybe Text
- _linkOperationId :: Maybe Text
- _linkParameters :: InsOrdHashMap Text ExpressionOrValue
- _linkRequestBody :: Maybe ExpressionOrValue
- _linkDescription :: Maybe Text
- _linkServer :: Maybe Server
}
newtype Callback = Callback ( InsOrdHashMap Text PathItem )
data SecurityScheme = SecurityScheme {
- _securitySchemeType :: SecuritySchemeType
- _securitySchemeDescription :: Maybe Text
}
data SecuritySchemeType
- = SecuritySchemeHttp HttpSchemeType
- | SecuritySchemeApiKey ApiKeyParams
- | SecuritySchemeOAuth2 OAuth2Flows
- | SecuritySchemeOpenIdConnect URL
data HttpSchemeType
- = HttpSchemeBearer ( Maybe BearerFormat )
- | HttpSchemeBasic
- | HttpSchemeCustom Text
newtype SecurityDefinitions = SecurityDefinitions ( Definitions SecurityScheme )
newtype SecurityRequirement = SecurityRequirement {
- getSecurityRequirement :: InsOrdHashMap Text [ Text ]
}
data ApiKeyParams = ApiKeyParams {
- _apiKeyName :: Text
- _apiKeyIn :: ApiKeyLocation
}
data ApiKeyLocation
- = ApiKeyQuery
- | ApiKeyHeader
- | ApiKeyCookie
data OAuth2Flows = OAuth2Flows {
- _oAuth2FlowsImplicit :: Maybe ( OAuth2Flow OAuth2ImplicitFlow )
- _oAuth2FlowsPassword :: Maybe ( OAuth2Flow OAuth2PasswordFlow )
- _oAuth2FlowsClientCredentials :: Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )
- _oAuth2FlowsAuthorizationCode :: Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )
}
data OAuth2Flow p = OAuth2Flow {
- _oAuth2Params :: p
- _oAath2RefreshUrl :: Maybe URL
- _oAuth2Scopes :: InsOrdHashMap Text Text
}
newtype OAuth2ImplicitFlow = OAuth2ImplicitFlow {
- _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL
}
newtype OAuth2PasswordFlow = OAuth2PasswordFlow {
- _oAuth2PasswordFlowTokenUrl :: TokenURL
}
newtype OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow {
- _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL
}
data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow {
- _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
- _oAuth2AuthorizationCodeFlowTokenUrl :: TokenURL
}
type AuthorizationURL = Text
type TokenURL = Text
data ExternalDocs = ExternalDocs {
- _externalDocsDescription :: Maybe Text
- _externalDocsUrl :: URL
}
newtype Reference = Reference {
- getReference :: Text
}
data Referenced a
- = Ref Reference
- | Inline a
newtype MimeList = MimeList {
- getMimeList :: [ MediaType ]
}
newtype URL = URL {
- getUrl :: Text
}

How to use this library

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

`Monoid` instances

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 .~ IOHM.fromList [ ("User", mempty & type_ ?~ OpenApiString) ]
  & paths .~
    IOHM.fromList [ ("/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:

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

Schema specification

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

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

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

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

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

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

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

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

Here's an example showing ToJSON – ToSchema correspondance:

>>> data Person = Person { name :: String, age :: Integer } deriving Generic
>>> instance ToJSON Person
>>> instance ToSchema Person
>>> BSL.putStrLn $ 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"
        }
    ]
}

Manipulation

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

Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc. To facilitate common needs, Data.OpenApi.Operation module provides useful helpers.

Validation

While ToParamSchema and ToSchema provide means to easily obtain schemas for Haskell types, there is no static mechanism to ensure those instances correspond to the ToHttpApiData or ToJSON instances.

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

Re-exports

module Data.OpenApi.Lens

module Data.OpenApi.Operation

module Data.OpenApi.ParamSchema

module Data.OpenApi.Schema

module Data.OpenApi.Schema.Validation

Swagger specification

data OpenApi 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.
_openApiOpenapi :: OpenApiSpecVersion

The spec of OpenApi this spec adheres to. Must be between lowerOpenApiSpecVersion and upperOpenApiSpecVersion

Instances

Instances details

Eq OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OpenApi -> OpenApi -> Bool Source # (/=) :: OpenApi -> OpenApi -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OpenApi Source # toConstr :: OpenApi -> Constr Source # dataTypeOf :: OpenApi -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OpenApi ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OpenApi ) Source # gmapT :: ( forall b. Data b => b -> b) -> OpenApi -> OpenApi Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OpenApi -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OpenApi -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OpenApi -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OpenApi -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OpenApi -> m OpenApi Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OpenApi -> m OpenApi Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OpenApi -> m OpenApi Source #
Show OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OpenApi -> ShowS Source # show :: OpenApi -> String Source # showList :: [ OpenApi ] -> ShowS Source #
Generic OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OpenApi :: Type -> Type Source # Methods from :: OpenApi -> Rep OpenApi x Source # to :: Rep OpenApi x -> OpenApi Source #
Semigroup OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: OpenApi -> OpenApi -> OpenApi Source # sconcat :: NonEmpty OpenApi -> OpenApi Source # stimes :: Integral b => b -> OpenApi -> OpenApi Source #
Monoid OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: OpenApi Source # mappend :: OpenApi -> OpenApi -> OpenApi Source # mconcat :: [ OpenApi ] -> OpenApi Source #
ToJSON OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OpenApi -> Value Source # toEncoding :: OpenApi -> Encoding Source # toJSONList :: [ OpenApi ] -> Value Source # toEncodingList :: [ OpenApi ] -> Encoding Source #
FromJSON OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OpenApi Source # parseJSONList :: Value -> Parser [ OpenApi ] Source #
Generic OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code OpenApi :: [[ Type ]] Source # Methods from :: OpenApi -> Rep OpenApi Source # to :: Rep OpenApi -> OpenApi Source #
HasDatatypeInfo OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf OpenApi :: DatatypeInfo Source # Methods datatypeInfo :: proxy OpenApi -> DatatypeInfo ( Code OpenApi ) Source #
HasSwaggerAesonOptions OpenApi Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy OpenApi -> SwaggerAesonOptions Source # aesonDefaults :: Proxy OpenApi -> POP Maybe ( Code OpenApi ) Source #
HasOpenapi OpenApi OpenApiSpecVersion Source #
Instance details Defined in Data.OpenApi.Lens Methods openapi :: Lens' OpenApi OpenApiSpecVersion Source #
HasInfo OpenApi Info Source #
Instance details Defined in Data.OpenApi.Lens Methods info :: Lens' OpenApi Info Source #
HasComponents OpenApi Components Source #
Instance details Defined in Data.OpenApi.Lens Methods components :: Lens' OpenApi Components Source #
(k ~ A_Lens , a ~ Components , b ~ Components ) => LabelOptic "components" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(k ~ A_Lens , a ~ Maybe ExternalDocs , b ~ Maybe ExternalDocs ) => LabelOptic "externalDocs" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(k ~ A_Lens , a ~ Info , b ~ Info ) => LabelOptic "info" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(k ~ A_Lens , a ~ OpenApiSpecVersion , b ~ OpenApiSpecVersion ) => LabelOptic "openapi" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(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 Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(k ~ A_Lens , a ~ [ SecurityRequirement ], b ~ [ SecurityRequirement ]) => LabelOptic "security" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(k ~ A_Lens , a ~ [ Server ], b ~ [ Server ]) => LabelOptic "servers" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
(k ~ A_Lens , a ~ InsOrdHashSet Tag , b ~ InsOrdHashSet Tag ) => LabelOptic "tags" k OpenApi OpenApi a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OpenApi OpenApi a b Source #
HasTags OpenApi ( InsOrdHashSet Tag ) Source #
Instance details Defined in Data.OpenApi.Lens Methods tags :: Lens' OpenApi ( InsOrdHashSet Tag ) Source #
HasServers OpenApi [ Server ] Source #
Instance details Defined in Data.OpenApi.Lens Methods servers :: Lens' OpenApi [ Server ] Source #
HasSecurity OpenApi [ SecurityRequirement ] Source #
Instance details Defined in Data.OpenApi.Lens Methods security :: Lens' OpenApi [ SecurityRequirement ] Source #
HasExternalDocs OpenApi ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' OpenApi ( Maybe ExternalDocs ) Source #
HasPaths OpenApi ( InsOrdHashMap FilePath PathItem ) Source #
Instance details Defined in Data.OpenApi.Lens Methods paths :: Lens' OpenApi ( InsOrdHashMap FilePath PathItem ) Source #
type Rep OpenApi Source #
Instance details Defined in Data.OpenApi.Internal type Rep OpenApi = D1 (' MetaData "OpenApi" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' False ) ( C1 (' MetaCons "OpenApi" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "_openApiInfo") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Info ) :: S1 (' MetaSel (' Just "_openApiServers") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ Server ])) :: ( S1 (' MetaSel (' Just "_openApiPaths") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( InsOrdHashMap FilePath PathItem )) :: S1 (' MetaSel (' Just "_openApiComponents") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Components ))) :: (( S1 (' MetaSel (' Just "_openApiSecurity") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ SecurityRequirement ]) :: S1 (' MetaSel (' Just "_openApiTags") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( InsOrdHashSet Tag ))) :: ( S1 (' MetaSel (' Just "_openApiExternalDocs") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe ExternalDocs )) :*: S1 (' MetaSel (' Just "_openApiOpenapi") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 OpenApiSpecVersion )))))
type Code OpenApi Source #
Instance details Defined in Data.OpenApi.Internal type Code OpenApi = '['[ Info , [ Server ], InsOrdHashMap FilePath PathItem , Components , [ SecurityRequirement ], InsOrdHashSet Tag , Maybe ExternalDocs , OpenApiSpecVersion ]]
type DatatypeInfoOf OpenApi Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf OpenApi = ' ADT "Data.OpenApi.Internal" "OpenApi" '[' Record "OpenApi" '[' FieldInfo "_openApiInfo", ' FieldInfo "_openApiServers", ' FieldInfo "_openApiPaths", ' FieldInfo "_openApiComponents", ' FieldInfo "_openApiSecurity", ' FieldInfo "_openApiTags", ' FieldInfo "_openApiExternalDocs", ' FieldInfo "_openApiOpenapi"]] '['[' 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 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 Source # (/=) :: Server -> Server -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Server Source # toConstr :: Server -> Constr Source # dataTypeOf :: Server -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Server ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Server ) Source # gmapT :: ( forall b. Data b => b -> b) -> Server -> Server Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Server -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Server -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Server -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Server -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Server -> m Server Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Server -> m Server Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Server -> m Server Source #
Show Server Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Server -> ShowS Source # show :: Server -> String Source # showList :: [ Server ] -> ShowS Source #
IsString Server Source #
Instance details Defined in Data.OpenApi.Internal Methods fromString :: String -> Server Source #
Generic Server Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Server :: Type -> Type Source # Methods from :: Server -> Rep Server x Source # to :: Rep Server x -> Server Source #
ToJSON Server Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Server -> Value Source # toEncoding :: Server -> Encoding Source # toJSONList :: [ Server ] -> Value Source # toEncodingList :: [ Server ] -> Encoding Source #
FromJSON Server Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Server Source # parseJSONList :: Value -> Parser [ Server ] Source #
Generic Server Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Server :: [[ Type ]] Source # Methods from :: Server -> Rep Server Source # to :: Rep Server -> Server Source #
HasDatatypeInfo Server Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Server :: DatatypeInfo Source # Methods datatypeInfo :: proxy Server -> DatatypeInfo ( Code Server ) Source #
AesonDefaultValue Server Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Server Source #
HasSwaggerAesonOptions Server Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Server -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Server -> POP Maybe ( Code Server ) Source #
HasUrl Server Text Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' Server Text Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k Server Server a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Server Server a b Source #
(k ~ A_Lens , a ~ Text , b ~ Text ) => LabelOptic "url" k Server Server a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Server Server a b Source #
(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 Methods labelOptic :: Optic k NoIx Server Server a b Source #
HasServers Operation [ Server ] Source #
Instance details Defined in Data.OpenApi.Lens Methods servers :: Lens' Operation [ Server ] Source #
HasServers PathItem [ Server ] Source #
Instance details Defined in Data.OpenApi.Lens Methods servers :: Lens' PathItem [ Server ] Source #
HasServers OpenApi [ Server ] Source #
Instance details Defined in Data.OpenApi.Lens Methods servers :: Lens' OpenApi [ Server ] Source #
HasDescription Server ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Server ( Maybe Text ) Source #
HasServer Link ( Maybe Server ) Source #
Instance details Defined in Data.OpenApi.Lens Methods server :: Lens' Link ( Maybe Server ) Source #
HasVariables Server ( InsOrdHashMap Text ServerVariable ) Source #
Instance details Defined in Data.OpenApi.Lens Methods variables :: Lens' Server ( InsOrdHashMap Text ServerVariable ) Source #
type Rep Server Source #
Instance details Defined in Data.OpenApi.Internal type Rep Server = D1 (' MetaData "Server" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Server = '['[ Text , Maybe Text , InsOrdHashMap Text ServerVariable ]]
type DatatypeInfoOf Server Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Server = ' ADT "Data.OpenApi.Internal" "Server" '[' Record "Server" '[' FieldInfo "_serverUrl", ' FieldInfo "_serverDescription", ' FieldInfo "_serverVariables"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

data ServerVariable Source #

Constructors

ServerVariable

Fields

_serverVariableEnum :: Maybe ( InsOrdHashSet Text )

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

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

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

Instances

Instances details

Eq ServerVariable Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: ServerVariable -> ServerVariable -> Bool Source # (/=) :: ServerVariable -> ServerVariable -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ServerVariable Source # toConstr :: ServerVariable -> Constr Source # dataTypeOf :: ServerVariable -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ServerVariable ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ServerVariable ) Source # gmapT :: ( forall b. Data b => b -> b) -> ServerVariable -> ServerVariable Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ServerVariable -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ServerVariable -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ServerVariable -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ServerVariable -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ServerVariable -> m ServerVariable Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ServerVariable -> m ServerVariable Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ServerVariable -> m ServerVariable Source #
Show ServerVariable Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ServerVariable -> ShowS Source # show :: ServerVariable -> String Source # showList :: [ ServerVariable ] -> ShowS Source #
Generic ServerVariable Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep ServerVariable :: Type -> Type Source # Methods from :: ServerVariable -> Rep ServerVariable x Source # to :: Rep ServerVariable x -> ServerVariable Source #
ToJSON ServerVariable Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: ServerVariable -> Value Source # toEncoding :: ServerVariable -> Encoding Source # toJSONList :: [ ServerVariable ] -> Value Source # toEncodingList :: [ ServerVariable ] -> Encoding Source #
FromJSON ServerVariable Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ServerVariable Source # parseJSONList :: Value -> Parser [ ServerVariable ] Source #
(k ~ A_Lens , a ~ Text , b ~ Text ) => LabelOptic "default" k ServerVariable ServerVariable a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ServerVariable ServerVariable a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k ServerVariable ServerVariable a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ServerVariable ServerVariable a b Source #
(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 Methods labelOptic :: Optic k NoIx ServerVariable ServerVariable a b Source #
HasVariables Server ( InsOrdHashMap Text ServerVariable ) Source #
Instance details Defined in Data.OpenApi.Lens Methods variables :: Lens' Server ( InsOrdHashMap Text ServerVariable ) Source #
type Rep ServerVariable Source #
Instance details Defined in Data.OpenApi.Internal type Rep ServerVariable = D1 (' MetaData "ServerVariable" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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.

Constructors

Components

Fields

Instances

Instances details

Eq Components Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Components -> Components -> Bool Source # (/=) :: Components -> Components -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Components Source # toConstr :: Components -> Constr Source # dataTypeOf :: Components -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Components ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Components ) Source # gmapT :: ( forall b. Data b => b -> b) -> Components -> Components Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Components -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Components -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Components -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Components -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Components -> m Components Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Components -> m Components Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Components -> m Components Source #
Show Components Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Components -> ShowS Source # show :: Components -> String Source # showList :: [ Components ] -> ShowS Source #
Generic Components Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Components :: Type -> Type Source # Methods from :: Components -> Rep Components x Source # to :: Rep Components x -> Components Source #
Semigroup Components Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Components -> Components -> Components Source # sconcat :: NonEmpty Components -> Components Source # stimes :: Integral b => b -> Components -> Components Source #
Monoid Components Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Components Source # mappend :: Components -> Components -> Components Source # mconcat :: [ Components ] -> Components Source #
ToJSON Components Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Components -> Value Source # toEncoding :: Components -> Encoding Source # toJSONList :: [ Components ] -> Value Source # toEncodingList :: [ Components ] -> Encoding Source #
FromJSON Components Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Components Source # parseJSONList :: Value -> Parser [ Components ] Source #
Generic Components Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Components :: [[ Type ]] Source # Methods from :: Components -> Rep Components Source # to :: Rep Components -> Components Source #
HasDatatypeInfo Components Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Components :: DatatypeInfo Source # Methods datatypeInfo :: proxy Components -> DatatypeInfo ( Code Components ) Source #
AesonDefaultValue Components Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Components Source #
HasSwaggerAesonOptions Components Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Components -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Components -> POP Maybe ( Code Components ) Source #
SwaggerMonoid Components Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Components Source # swaggerMappend :: Components -> Components -> Components Source #
HasComponents OpenApi Components Source #
Instance details Defined in Data.OpenApi.Lens Methods components :: Lens' OpenApi Components Source #
HasSecuritySchemes Components SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Lens Methods securitySchemes :: Lens' Components SecurityDefinitions Source #
(k ~ A_Lens , a ~ Definitions Callback , b ~ Definitions Callback ) => LabelOptic "callbacks" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions Example , b ~ Definitions Example ) => LabelOptic "examples" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions Header , b ~ Definitions Header ) => LabelOptic "headers" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions Link , b ~ Definitions Link ) => LabelOptic "links" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions Param , b ~ Definitions Param ) => LabelOptic "parameters" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions RequestBody , b ~ Definitions RequestBody ) => LabelOptic "requestBodies" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions Response , b ~ Definitions Response ) => LabelOptic "responses" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ Definitions Schema , b ~ Definitions Schema ) => LabelOptic "schemas" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
(k ~ A_Lens , a ~ SecurityDefinitions , b ~ SecurityDefinitions ) => LabelOptic "securitySchemes" k Components Components a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Components Components a b Source #
HasSchemas Components ( Definitions Schema ) Source #
Instance details Defined in Data.OpenApi.Lens Methods schemas :: Lens' Components ( Definitions Schema ) Source #
HasResponses Components ( Definitions Response ) Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Components ( Definitions Response ) Source #
HasRequestBodies Components ( Definitions RequestBody ) Source #
Instance details Defined in Data.OpenApi.Lens Methods requestBodies :: Lens' Components ( Definitions RequestBody ) Source #
HasParameters Components ( Definitions Param ) Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' Components ( Definitions Param ) Source #
HasLinks Components ( Definitions Link ) Source #
Instance details Defined in Data.OpenApi.Lens Methods links :: Lens' Components ( Definitions Link ) Source #
HasHeaders Components ( Definitions Header ) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Components ( Definitions Header ) Source #
HasExamples Components ( Definitions Example ) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Components ( Definitions Example ) Source #
HasCallbacks Components ( Definitions Callback ) Source #
Instance details Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Components ( Definitions Callback ) Source #
type Rep Components Source #
Instance details Defined in Data.OpenApi.Internal type Rep Components = D1 (' MetaData "Components" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' False ) ( C1 (' MetaCons "Components" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "_componentsSchemas") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Schema )) :: S1 (' MetaSel (' Just "_componentsResponses") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Response ))) :: ( S1 (' MetaSel (' Just "_componentsParameters") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Param )) :: S1 (' MetaSel (' Just "_componentsExamples") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Example )))) :: (( S1 (' MetaSel (' Just "_componentsRequestBodies") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions RequestBody )) :: S1 (' MetaSel (' Just "_componentsHeaders") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Header ))) :: ( S1 (' MetaSel (' Just "_componentsSecuritySchemes") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 SecurityDefinitions ) :: ( S1 (' MetaSel (' Just "_componentsLinks") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Link )) :: S1 (' MetaSel (' Just "_componentsCallbacks") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Definitions Callback )))))))
type Code Components Source #
Instance details Defined in Data.OpenApi.Internal type Code Components = '['[ Definitions Schema , Definitions Response , Definitions Param , Definitions Example , Definitions RequestBody , Definitions Header , SecurityDefinitions , Definitions Link , Definitions Callback ]]
type DatatypeInfoOf Components Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Components = ' ADT "Data.OpenApi.Internal" "Components" '[' Record "Components" '[' FieldInfo "_componentsSchemas", ' FieldInfo "_componentsResponses", ' FieldInfo "_componentsParameters", ' FieldInfo "_componentsExamples", ' FieldInfo "_componentsRequestBodies", ' FieldInfo "_componentsHeaders", ' FieldInfo "_componentsSecuritySchemes", ' FieldInfo "_componentsLinks", ' FieldInfo "_componentsCallbacks"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

Info types

data Info 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

_infoTitle :: Text

The title of the API.
_infoDescription :: Maybe Text

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

A URL to the Terms of Service for the API. MUST be in the format of a URL.
_infoContact :: Maybe Contact

The contact information for the exposed API.
_infoLicense :: Maybe License

The license information for the exposed API.
_infoVersion :: Text

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

Instances

Instances details

Eq Info Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Info -> Info -> Bool Source # (/=) :: Info -> Info -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Info Source # toConstr :: Info -> Constr Source # dataTypeOf :: Info -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Info ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Info ) Source # gmapT :: ( forall b. Data b => b -> b) -> Info -> Info Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Info -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Info -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Info -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Info -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Info -> m Info Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Info -> m Info Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Info -> m Info Source #
Show Info Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Info -> ShowS Source # show :: Info -> String Source # showList :: [ Info ] -> ShowS Source #
Generic Info Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Info :: Type -> Type Source # Methods from :: Info -> Rep Info x Source # to :: Rep Info x -> Info Source #
Semigroup Info Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Info -> Info -> Info Source # sconcat :: NonEmpty Info -> Info Source # stimes :: Integral b => b -> Info -> Info Source #
Monoid Info Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Info Source # mappend :: Info -> Info -> Info Source # mconcat :: [ Info ] -> Info Source #
ToJSON Info Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Info -> Value Source # toEncoding :: Info -> Encoding Source # toJSONList :: [ Info ] -> Value Source # toEncodingList :: [ Info ] -> Encoding Source #
FromJSON Info Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Info Source # parseJSONList :: Value -> Parser [ Info ] Source #
AesonDefaultValue Info Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Info Source #
SwaggerMonoid Info Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Info Source # swaggerMappend :: Info -> Info -> Info Source #
HasInfo OpenApi Info Source #
Instance details Defined in Data.OpenApi.Lens Methods info :: Lens' OpenApi Info Source #
HasVersion Info Text Source #
Instance details Defined in Data.OpenApi.Lens Methods version :: Lens' Info Text Source #
HasTitle Info Text Source #
Instance details Defined in Data.OpenApi.Lens Methods title :: Lens' Info Text Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
HasDescription Info ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Info ( Maybe Text ) Source #
HasTermsOfService Info ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods termsOfService :: Lens' Info ( Maybe Text ) Source #
HasLicense Info ( Maybe License ) Source #
Instance details Defined in Data.OpenApi.Lens Methods license :: Lens' Info ( Maybe License ) Source #
HasContact Info ( Maybe Contact ) Source #
Instance details Defined in Data.OpenApi.Lens Methods contact :: Lens' Info ( Maybe Contact ) Source #
type Rep Info Source #
Instance details Defined in Data.OpenApi.Internal type Rep Info = D1 (' MetaData "Info" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 _contactName :: Maybe Text The identifying name of the contact person/organization. _contactUrl :: Maybe URL The URL pointing to the contact information. _contactEmail :: Maybe Text The email address of the contact person/organization.

Instances

Instances details

Eq Contact Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Contact -> Contact -> Bool Source # (/=) :: Contact -> Contact -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Contact Source # toConstr :: Contact -> Constr Source # dataTypeOf :: Contact -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Contact ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Contact ) Source # gmapT :: ( forall b. Data b => b -> b) -> Contact -> Contact Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Contact -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Contact -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Contact -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Contact -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Contact -> m Contact Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Contact -> m Contact Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Contact -> m Contact Source #
Show Contact Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Contact -> ShowS Source # show :: Contact -> String Source # showList :: [ Contact ] -> ShowS Source #
Generic Contact Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Contact :: Type -> Type Source # Methods from :: Contact -> Rep Contact x Source # to :: Rep Contact x -> Contact Source #
Semigroup Contact Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Contact -> Contact -> Contact Source # sconcat :: NonEmpty Contact -> Contact Source # stimes :: Integral b => b -> Contact -> Contact Source #
Monoid Contact Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Contact Source # mappend :: Contact -> Contact -> Contact Source # mconcat :: [ Contact ] -> Contact Source #
ToJSON Contact Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Contact -> Value Source # toEncoding :: Contact -> Encoding Source # toJSONList :: [ Contact ] -> Value Source # toEncodingList :: [ Contact ] -> Encoding Source #
FromJSON Contact Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Contact Source # parseJSONList :: Value -> Parser [ Contact ] Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "email" k Contact Contact a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Contact Contact a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "name" k Contact Contact a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Contact Contact a b Source #
(k ~ A_Lens , a ~ Maybe URL , b ~ Maybe URL ) => LabelOptic "url" k Contact Contact a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Contact Contact a b Source #
HasUrl Contact ( Maybe URL ) Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' Contact ( Maybe URL ) Source #
HasContact Info ( Maybe Contact ) Source #
Instance details Defined in Data.OpenApi.Lens Methods contact :: Lens' Info ( Maybe Contact ) Source #
HasName Contact ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods name :: Lens' Contact ( Maybe Text ) Source #
HasEmail Contact ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods email :: Lens' Contact ( Maybe Text ) Source #
type Rep Contact Source #
Instance details Defined in Data.OpenApi.Internal type Rep Contact = D1 (' MetaData "Contact" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 _licenseName :: Text The license name used for the API. _licenseUrl :: Maybe URL A URL to the license used for the API.

Instances

Instances details

Eq License Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: License -> License -> Bool Source # (/=) :: License -> License -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c License Source # toConstr :: License -> Constr Source # dataTypeOf :: License -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c License ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c License ) Source # gmapT :: ( forall b. Data b => b -> b) -> License -> License Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> License -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> License -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> License -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> License -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> License -> m License Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> License -> m License Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> License -> m License Source #
Show License Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> License -> ShowS Source # show :: License -> String Source # showList :: [ License ] -> ShowS Source #
IsString License Source #
Instance details Defined in Data.OpenApi.Internal Methods fromString :: String -> License Source #
Generic License Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep License :: Type -> Type Source # Methods from :: License -> Rep License x Source # to :: Rep License x -> License Source #
ToJSON License Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: License -> Value Source # toEncoding :: License -> Encoding Source # toJSONList :: [ License ] -> Value Source # toEncodingList :: [ License ] -> Encoding Source #
FromJSON License Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser License Source # parseJSONList :: Value -> Parser [ License ] Source #
HasName License Text Source #
Instance details Defined in Data.OpenApi.Lens Methods name :: Lens' License Text Source #
(k ~ A_Lens , a ~ Text , b ~ Text ) => LabelOptic "name" k License License a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx License License a b Source #
(k ~ A_Lens , a ~ Maybe URL , b ~ Maybe URL ) => LabelOptic "url" k License License a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx License License a b Source #
HasUrl License ( Maybe URL ) Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' License ( Maybe URL ) Source #
HasLicense Info ( Maybe License ) Source #
Instance details Defined in Data.OpenApi.Lens Methods license :: Lens' Info ( Maybe License ) Source #
type Rep License Source #
Instance details Defined in Data.OpenApi.Internal type Rep License = D1 (' MetaData "License" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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

_pathItemSummary :: Maybe Text

An optional, string summary, intended to apply to all operations in this path.
_pathItemDescription :: Maybe Text

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

A definition of a GET operation on this path.
_pathItemPut :: Maybe Operation

A definition of a PUT operation on this path.
_pathItemPost :: Maybe Operation

A definition of a POST operation on this path.
_pathItemDelete :: Maybe Operation

A definition of a DELETE operation on this path.
_pathItemOptions :: Maybe Operation

A definition of a OPTIONS operation on this path.
_pathItemHead :: Maybe Operation

A definition of a HEAD operation on this path.
_pathItemPatch :: Maybe Operation

A definition of a PATCH operation on this path.
_pathItemTrace :: Maybe Operation

A definition of a TRACE operation on this path.
_pathItemServers :: [ Server ]

An alternative server array to service all operations in this path.
_pathItemParameters :: [ Referenced Param ]

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

Instances

Instances details

Eq PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: PathItem -> PathItem -> Bool Source # (/=) :: PathItem -> PathItem -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c PathItem Source # toConstr :: PathItem -> Constr Source # dataTypeOf :: PathItem -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c PathItem ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c PathItem ) Source # gmapT :: ( forall b. Data b => b -> b) -> PathItem -> PathItem Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> PathItem -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> PathItem -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> PathItem -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> PathItem -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> PathItem -> m PathItem Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> PathItem -> m PathItem Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> PathItem -> m PathItem Source #
Show PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> PathItem -> ShowS Source # show :: PathItem -> String Source # showList :: [ PathItem ] -> ShowS Source #
Generic PathItem Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep PathItem :: Type -> Type Source # Methods from :: PathItem -> Rep PathItem x Source # to :: Rep PathItem x -> PathItem Source #
Semigroup PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: PathItem -> PathItem -> PathItem Source # sconcat :: NonEmpty PathItem -> PathItem Source # stimes :: Integral b => b -> PathItem -> PathItem Source #
Monoid PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: PathItem Source # mappend :: PathItem -> PathItem -> PathItem Source # mconcat :: [ PathItem ] -> PathItem Source #
ToJSON PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: PathItem -> Value Source # toEncoding :: PathItem -> Encoding Source # toJSONList :: [ PathItem ] -> Value Source # toEncodingList :: [ PathItem ] -> Encoding Source #
FromJSON PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser PathItem Source # parseJSONList :: Value -> Parser [ PathItem ] Source #
Generic PathItem Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code PathItem :: [[ Type ]] Source # Methods from :: PathItem -> Rep PathItem Source # to :: Rep PathItem -> PathItem Source #
HasDatatypeInfo PathItem Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf PathItem :: DatatypeInfo Source # Methods datatypeInfo :: proxy PathItem -> DatatypeInfo ( Code PathItem ) Source #
HasSwaggerAesonOptions PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy PathItem -> SwaggerAesonOptions Source # aesonDefaults :: Proxy PathItem -> POP Maybe ( Code PathItem ) Source #
SwaggerMonoid PathItem Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: PathItem Source # swaggerMappend :: PathItem -> PathItem -> PathItem Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "delete" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "get" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "head" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "options" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ [ Referenced Param ], b ~ [ Referenced Param ]) => LabelOptic "parameters" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "patch" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "post" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "put" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ [ Server ], b ~ [ Server ]) => LabelOptic "servers" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "summary" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
(k ~ A_Lens , a ~ Maybe Operation , b ~ Maybe Operation ) => LabelOptic "trace" k PathItem PathItem a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx PathItem PathItem a b Source #
HasServers PathItem [ Server ] Source #
Instance details Defined in Data.OpenApi.Lens Methods servers :: Lens' PathItem [ Server ] Source #
HasParameters PathItem [ Referenced Param ] Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' PathItem [ Referenced Param ] Source #
HasDescription PathItem ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' PathItem ( Maybe Text ) Source #
HasTrace PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods trace :: Lens' PathItem ( Maybe Operation ) Source #
HasSummary PathItem ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods summary :: Lens' PathItem ( Maybe Text ) Source #
HasPut PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods put :: Lens' PathItem ( Maybe Operation ) Source #
HasPost PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods post :: Lens' PathItem ( Maybe Operation ) Source #
HasPatch PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods patch :: Lens' PathItem ( Maybe Operation ) Source #
HasOptions PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods options :: Lens' PathItem ( Maybe Operation ) Source #
HasHead PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods head_ :: Lens' PathItem ( Maybe Operation ) Source #
HasGet PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods get :: Lens' PathItem ( Maybe Operation ) Source #
HasDelete PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods delete :: Lens' PathItem ( Maybe Operation ) Source #
HasPaths OpenApi ( InsOrdHashMap FilePath PathItem ) Source #
Instance details Defined in Data.OpenApi.Lens Methods paths :: Lens' OpenApi ( InsOrdHashMap FilePath PathItem ) Source #
SwaggerMonoid ( InsOrdHashMap FilePath PathItem ) Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: InsOrdHashMap FilePath PathItem Source # swaggerMappend :: InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem -> InsOrdHashMap FilePath PathItem Source #
type Rep PathItem Source #
Instance details Defined in Data.OpenApi.Internal type Rep PathItem = D1 (' MetaData "PathItem" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code PathItem = '['[ Maybe Text , Maybe Text , Maybe Operation , Maybe Operation , Maybe Operation , Maybe Operation , Maybe Operation , Maybe Operation , Maybe Operation , Maybe Operation , [ Server ], [ Referenced Param ]]]
type DatatypeInfoOf PathItem Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf PathItem = ' ADT "Data.OpenApi.Internal" "PathItem" '[' Record "PathItem" '[' FieldInfo "_pathItemSummary", ' FieldInfo "_pathItemDescription", ' FieldInfo "_pathItemGet", ' FieldInfo "_pathItemPut", ' FieldInfo "_pathItemPost", ' FieldInfo "_pathItemDelete", ' FieldInfo "_pathItemOptions", ' FieldInfo "_pathItemHead", ' FieldInfo "_pathItemPatch", ' FieldInfo "_pathItemTrace", ' FieldInfo "_pathItemServers", ' FieldInfo "_pathItemParameters"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

Operations

data Operation 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 Methods (==) :: Operation -> Operation -> Bool Source # (/=) :: Operation -> Operation -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Operation Source # toConstr :: Operation -> Constr Source # dataTypeOf :: Operation -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Operation ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Operation ) Source # gmapT :: ( forall b. Data b => b -> b) -> Operation -> Operation Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Operation -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Operation -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Operation -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Operation -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Operation -> m Operation Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Operation -> m Operation Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Operation -> m Operation Source #
Show Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Operation -> ShowS Source # show :: Operation -> String Source # showList :: [ Operation ] -> ShowS Source #
Generic Operation Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Operation :: Type -> Type Source # Methods from :: Operation -> Rep Operation x Source # to :: Rep Operation x -> Operation Source #
Semigroup Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Operation -> Operation -> Operation Source # sconcat :: NonEmpty Operation -> Operation Source # stimes :: Integral b => b -> Operation -> Operation Source #
Monoid Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Operation Source # mappend :: Operation -> Operation -> Operation Source # mconcat :: [ Operation ] -> Operation Source #
ToJSON Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Operation -> Value Source # toEncoding :: Operation -> Encoding Source # toJSONList :: [ Operation ] -> Value Source # toEncodingList :: [ Operation ] -> Encoding Source #
FromJSON Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Operation Source # parseJSONList :: Value -> Parser [ Operation ] Source #
Generic Operation Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Operation :: [[ Type ]] Source # Methods from :: Operation -> Rep Operation Source # to :: Rep Operation -> Operation Source #
HasDatatypeInfo Operation Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Operation :: DatatypeInfo Source # Methods datatypeInfo :: proxy Operation -> DatatypeInfo ( Code Operation ) Source #
Ixed Operation Source #
Instance details Defined in Data.OpenApi.Lens Methods ix :: Index Operation -> Traversal' Operation ( IxValue Operation ) Source #
At Operation Source #
Instance details Defined in Data.OpenApi.Lens Methods at :: Index Operation -> Lens' Operation ( Maybe ( IxValue Operation )) Source #
Ixed Operation Source #
Instance details Defined in Data.OpenApi.Optics Associated Types type IxKind Operation Source # Methods ix :: Index Operation -> Optic' ( IxKind Operation ) NoIx Operation ( IxValue Operation ) Source #
At Operation Source #
Instance details Defined in Data.OpenApi.Optics Methods at :: Index Operation -> Lens' Operation ( Maybe ( IxValue Operation )) Source #
HasSwaggerAesonOptions Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Operation -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Operation -> POP Maybe ( Code Operation ) Source #
SwaggerMonoid Operation Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Operation Source # swaggerMappend :: Operation -> Operation -> Operation Source #
HasResponses Operation Responses Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Operation Responses Source #
(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 Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "deprecated" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ Maybe ExternalDocs , b ~ Maybe ExternalDocs ) => LabelOptic "externalDocs" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "operationId" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ [ Referenced Param ], b ~ [ Referenced Param ]) => LabelOptic "parameters" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(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 Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ Responses , b ~ Responses ) => LabelOptic "responses" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ [ SecurityRequirement ], b ~ [ SecurityRequirement ]) => LabelOptic "security" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ [ Server ], b ~ [ Server ]) => LabelOptic "servers" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "summary" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
(k ~ A_Lens , a ~ InsOrdHashSet TagName , b ~ InsOrdHashSet TagName ) => LabelOptic "tags" k Operation Operation a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Operation Operation a b Source #
HasTags Operation ( InsOrdHashSet TagName ) Source #
Instance details Defined in Data.OpenApi.Lens Methods tags :: Lens' Operation ( InsOrdHashSet TagName ) Source #
HasServers Operation [ Server ] Source #
Instance details Defined in Data.OpenApi.Lens Methods servers :: Lens' Operation [ Server ] Source #
HasSecurity Operation [ SecurityRequirement ] Source #
Instance details Defined in Data.OpenApi.Lens Methods security :: Lens' Operation [ SecurityRequirement ] Source #
HasExternalDocs Operation ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Operation ( Maybe ExternalDocs ) Source #
HasParameters Operation [ Referenced Param ] Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' Operation [ Referenced Param ] Source #
HasDescription Operation ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Operation ( Maybe Text ) Source #
HasTrace PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods trace :: Lens' PathItem ( Maybe Operation ) Source #
HasSummary Operation ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods summary :: Lens' Operation ( Maybe Text ) Source #
HasPut PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods put :: Lens' PathItem ( Maybe Operation ) Source #
HasPost PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods post :: Lens' PathItem ( Maybe Operation ) Source #
HasPatch PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods patch :: Lens' PathItem ( Maybe Operation ) Source #
HasOptions PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods options :: Lens' PathItem ( Maybe Operation ) Source #
HasHead PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods head_ :: Lens' PathItem ( Maybe Operation ) Source #
HasGet PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods get :: Lens' PathItem ( Maybe Operation ) Source #
HasDelete PathItem ( Maybe Operation ) Source #
Instance details Defined in Data.OpenApi.Lens Methods delete :: Lens' PathItem ( Maybe Operation ) Source #
HasRequestBody Operation ( Maybe ( Referenced RequestBody )) Source #
Instance details Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation ( Maybe ( Referenced RequestBody )) Source #
HasOperationId Operation ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods operationId :: Lens' Operation ( Maybe Text ) Source #
HasDeprecated Operation ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods deprecated :: Lens' Operation ( Maybe Bool ) Source #
HasCallbacks Operation ( InsOrdHashMap Text ( Referenced Callback )) Source #
Instance details Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation ( InsOrdHashMap Text ( Referenced Callback )) Source #
type Rep Operation Source #
Instance details Defined in Data.OpenApi.Internal type Rep Operation = D1 (' MetaData "Operation" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Operation = '['[ InsOrdHashSet TagName , Maybe Text , Maybe Text , Maybe ExternalDocs , Maybe Text , [ Referenced Param ], Maybe ( Referenced RequestBody ), Responses , InsOrdHashMap Text ( Referenced Callback ), Maybe Bool , [ SecurityRequirement ], [ Server ]]]
type DatatypeInfoOf Operation Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Operation = ' ADT "Data.OpenApi.Internal" "Operation" '[' Record "Operation" '[' FieldInfo "_operationTags", ' FieldInfo "_operationSummary", ' FieldInfo "_operationDescription", ' FieldInfo "_operationExternalDocs", ' FieldInfo "_operationOperationId", ' FieldInfo "_operationParameters", ' FieldInfo "_operationRequestBody", ' FieldInfo "_operationResponses", ' FieldInfo "_operationCallbacks", ' FieldInfo "_operationDeprecated", ' FieldInfo "_operationSecurity", ' FieldInfo "_operationServers"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]
type Index Operation Source #
Instance details Defined in Data.OpenApi.Lens type Index Operation = HttpStatusCode
type IxValue Operation Source #
Instance details Defined in Data.OpenApi.Lens type IxValue Operation = Referenced Response
type Index Operation Source #
Instance details Defined in Data.OpenApi.Optics type Index Operation = HttpStatusCode
type IxValue Operation Source #
Instance details Defined in Data.OpenApi.Optics type IxValue Operation = Referenced Response
type IxKind Operation Source #
Instance details Defined in Data.OpenApi.Optics type IxKind Operation = An_AffineTraversal

data Tag Source #

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

Constructors

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

Instances

Instances details

Eq Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Tag -> Tag -> Bool Source # (/=) :: Tag -> Tag -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Tag Source # toConstr :: Tag -> Constr Source # dataTypeOf :: Tag -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Tag ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Tag ) Source # gmapT :: ( forall b. Data b => b -> b) -> Tag -> Tag Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Tag -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Tag -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Tag -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Tag -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Tag -> m Tag Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Tag -> m Tag Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Tag -> m Tag Source #
Ord Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods compare :: Tag -> Tag -> Ordering Source # (<) :: Tag -> Tag -> Bool Source # (<=) :: Tag -> Tag -> Bool Source # (>) :: Tag -> Tag -> Bool Source # (>=) :: Tag -> Tag -> Bool Source # max :: Tag -> Tag -> Tag Source # min :: Tag -> Tag -> Tag Source #
Show Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Tag -> ShowS Source # show :: Tag -> String Source # showList :: [ Tag ] -> ShowS Source #
IsString Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods fromString :: String -> Tag Source #
Generic Tag Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Tag :: Type -> Type Source # Methods from :: Tag -> Rep Tag x Source # to :: Rep Tag x -> Tag Source #
Hashable Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods hashWithSalt :: Int -> Tag -> Int Source # hash :: Tag -> Int Source #
ToJSON Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Tag -> Value Source # toEncoding :: Tag -> Encoding Source # toJSONList :: [ Tag ] -> Value Source # toEncodingList :: [ Tag ] -> Encoding Source #
FromJSON Tag Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Tag Source # parseJSONList :: Value -> Parser [ Tag ] Source #
HasName Tag TagName Source #
Instance details Defined in Data.OpenApi.Lens Methods name :: Lens' Tag TagName Source #
(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 Source #
(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 Source #
(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 Source #
HasTags OpenApi ( InsOrdHashSet Tag ) Source #
Instance details Defined in Data.OpenApi.Lens Methods tags :: Lens' OpenApi ( InsOrdHashSet Tag ) Source #
HasExternalDocs Tag ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Tag ( Maybe ExternalDocs ) Source #
HasDescription Tag ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Tag ( Maybe Text ) Source #
type Rep Tag Source #
Instance details Defined in Data.OpenApi.Internal type Rep Tag = D1 (' MetaData "Tag" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 #

Constructors

OpenApiString :: OpenApiType
OpenApiNumber :: OpenApiType
OpenApiInteger :: OpenApiType
OpenApiBoolean :: OpenApiType
OpenApiArray :: OpenApiType
OpenApiNull :: OpenApiType
OpenApiObject :: OpenApiType

Instances

Instances details

Eq OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OpenApiType -> OpenApiType -> Bool Source # (/=) :: OpenApiType -> OpenApiType -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OpenApiType Source # toConstr :: OpenApiType -> Constr Source # dataTypeOf :: OpenApiType -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OpenApiType ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OpenApiType ) Source # gmapT :: ( forall b. Data b => b -> b) -> OpenApiType -> OpenApiType Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OpenApiType -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OpenApiType -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OpenApiType -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OpenApiType -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OpenApiType -> m OpenApiType Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OpenApiType -> m OpenApiType Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OpenApiType -> m OpenApiType Source #
Show OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OpenApiType -> ShowS Source # show :: OpenApiType -> String Source # showList :: [ OpenApiType ] -> ShowS Source #
Generic OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OpenApiType :: Type -> Type Source # Methods from :: OpenApiType -> Rep OpenApiType x Source # to :: Rep OpenApiType x -> OpenApiType Source #
ToJSON OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OpenApiType -> Value Source # toEncoding :: OpenApiType -> Encoding Source # toJSONList :: [ OpenApiType ] -> Value Source # toEncodingList :: [ OpenApiType ] -> Encoding Source #
FromJSON OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OpenApiType Source # parseJSONList :: Value -> Parser [ OpenApiType ] Source #
AesonDefaultValue OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OpenApiType Source #
SwaggerMonoid OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: OpenApiType Source # swaggerMappend :: OpenApiType -> OpenApiType -> OpenApiType Source #
HasType NamedSchema ( Maybe OpenApiType ) Source #
Instance details Defined in Data.OpenApi.Lens Methods type_ :: Lens' NamedSchema ( Maybe OpenApiType ) Source #
HasType Schema ( Maybe OpenApiType ) Source #
Instance details Defined in Data.OpenApi.Lens Methods type_ :: Lens' Schema ( Maybe OpenApiType ) Source #
type Rep OpenApiType Source #
Instance details Defined in Data.OpenApi.Internal type Rep OpenApiType = D1 (' MetaData "OpenApiType" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' False ) (( C1 (' MetaCons "OpenApiString" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: ( C1 (' MetaCons "OpenApiNumber" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "OpenApiInteger" ' PrefixI ' False ) ( U1 :: Type -> Type ))) :+: (( C1 (' MetaCons "OpenApiBoolean" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "OpenApiArray" ' PrefixI ' False ) ( U1 :: Type -> Type )) :+: ( C1 (' MetaCons "OpenApiNull" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "OpenApiObject" ' PrefixI ' False ) ( U1 :: Type -> Type ))))

type Format = Text Source #

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 Source # (/=) :: Style -> Style -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Style Source # toConstr :: Style -> Constr Source # dataTypeOf :: Style -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Style ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Style ) Source # gmapT :: ( forall b. Data b => b -> b) -> Style -> Style Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Style -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Style -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Style -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Style -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Style -> m Style Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Style -> m Style Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Style -> m Style Source #
Show Style Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Style -> ShowS Source # show :: Style -> String Source # showList :: [ Style ] -> ShowS Source #
Generic Style Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Style :: Type -> Type Source # Methods from :: Style -> Rep Style x Source # to :: Rep Style x -> Style Source #
ToJSON Style Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Style -> Value Source # toEncoding :: Style -> Encoding Source # toJSONList :: [ Style ] -> Value Source # toEncodingList :: [ Style ] -> Encoding Source #
FromJSON Style Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Style Source # parseJSONList :: Value -> Parser [ Style ] Source #
HasStyle Param ( Maybe Style ) Source #
Instance details Defined in Data.OpenApi.Lens Methods style :: Lens' Param ( Maybe Style ) Source #
HasStyle Encoding ( Maybe Style ) Source #
Instance details Defined in Data.OpenApi.Lens Methods style :: Lens' Encoding ( Maybe Style ) Source #
type Rep Style Source #
Instance details Defined in Data.OpenApi.Internal type Rep Style = D1 (' MetaData "Style" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Source # (/=) :: Param -> Param -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Param Source # toConstr :: Param -> Constr Source # dataTypeOf :: Param -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Param ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Param ) Source # gmapT :: ( forall b. Data b => b -> b) -> Param -> Param Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Param -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Param -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Param -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Param -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Param -> m Param Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Param -> m Param Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Param -> m Param Source #
Show Param Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Param -> ShowS Source # show :: Param -> String Source # showList :: [ Param ] -> ShowS Source #
Generic Param Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Param :: Type -> Type Source # Methods from :: Param -> Rep Param x Source # to :: Rep Param x -> Param Source #
Semigroup Param Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Param -> Param -> Param Source # sconcat :: NonEmpty Param -> Param Source # stimes :: Integral b => b -> Param -> Param Source #
Monoid Param Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Param Source # mappend :: Param -> Param -> Param Source # mconcat :: [ Param ] -> Param Source #
ToJSON Param Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Param -> Value Source # toEncoding :: Param -> Encoding Source # toJSONList :: [ Param ] -> Value Source # toEncodingList :: [ Param ] -> Encoding Source #
FromJSON Param Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Param Source # parseJSONList :: Value -> Parser [ Param ] Source #
Generic Param Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Param :: [[ Type ]] Source # Methods from :: Param -> Rep Param Source # to :: Rep Param -> Param Source #
HasDatatypeInfo Param Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Param :: DatatypeInfo Source # Methods datatypeInfo :: proxy Param -> DatatypeInfo ( Code Param ) Source #
HasSwaggerAesonOptions Param Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Param -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Param -> POP Maybe ( Code Param ) Source #
SwaggerMonoid Param Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Param Source # swaggerMappend :: Param -> Param -> Param Source #
HasName Param Text Source #
Instance details Defined in Data.OpenApi.Lens Methods name :: Lens' Param Text Source #
HasIn Param ParamLocation Source #
Instance details Defined in Data.OpenApi.Lens Methods in_ :: Lens' Param ParamLocation Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
HasParameters Operation [ Referenced Param ] Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' Operation [ Referenced Param ] Source #
HasParameters PathItem [ Referenced Param ] Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' PathItem [ Referenced Param ] Source #
HasParameters Components ( Definitions Param ) Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' Components ( Definitions Param ) Source #
HasDescription Param ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Param ( Maybe Text ) Source #
HasRequired Param ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods required :: Lens' Param ( Maybe Bool ) Source #
HasSchema Param ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' Param ( Maybe ( Referenced Schema )) Source #
HasExample Param ( Maybe Value ) Source #
Instance details Defined in Data.OpenApi.Lens Methods example :: Lens' Param ( Maybe Value ) Source #
HasDeprecated Param ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods deprecated :: Lens' Param ( Maybe Bool ) Source #
HasStyle Param ( Maybe Style ) Source #
Instance details Defined in Data.OpenApi.Lens Methods style :: Lens' Param ( Maybe Style ) Source #
HasExplode Param ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods explode :: Lens' Param ( Maybe Bool ) Source #
HasAllowReserved Param ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods allowReserved :: Lens' Param ( Maybe Bool ) Source #
HasAllowEmptyValue Param ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods allowEmptyValue :: Lens' Param ( Maybe Bool ) Source #
HasExamples Param ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Param ( InsOrdHashMap Text ( Referenced Example )) Source #
ToJSON ( Referenced Param ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Param -> Value Source # toEncoding :: Referenced Param -> Encoding Source # toJSONList :: [ Referenced Param ] -> Value Source # toEncodingList :: [ Referenced Param ] -> Encoding Source #
FromJSON ( Referenced Param ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Param ) Source # parseJSONList :: Value -> Parser [ Referenced Param ] Source #
type Rep Param Source #
Instance details Defined in Data.OpenApi.Internal type Rep Param = D1 (' MetaData "Param" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Param = '['[ Text , Maybe Text , Maybe Bool , Maybe Bool , ParamLocation , Maybe Bool , Maybe Bool , Maybe ( Referenced Schema ), Maybe Style , Maybe Bool , Maybe Value , InsOrdHashMap Text ( Referenced Example )]]
type DatatypeInfoOf Param Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Param = ' ADT "Data.OpenApi.Internal" "Param" '[' Record "Param" '[' FieldInfo "_paramName", ' FieldInfo "_paramDescription", ' FieldInfo "_paramRequired", ' FieldInfo "_paramDeprecated", ' FieldInfo "_paramIn", ' FieldInfo "_paramAllowEmptyValue", ' FieldInfo "_paramAllowReserved", ' FieldInfo "_paramSchema", ' FieldInfo "_paramStyle", ' FieldInfo "_paramExplode", ' FieldInfo "_paramExample", ' FieldInfo "_paramExamples"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

data ParamLocation 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 Methods (==) :: ParamLocation -> ParamLocation -> Bool Source # (/=) :: ParamLocation -> ParamLocation -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ParamLocation Source # toConstr :: ParamLocation -> Constr Source # dataTypeOf :: ParamLocation -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ParamLocation ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ParamLocation ) Source # gmapT :: ( forall b. Data b => b -> b) -> ParamLocation -> ParamLocation Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ParamLocation -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ParamLocation -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ParamLocation -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ParamLocation -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ParamLocation -> m ParamLocation Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ParamLocation -> m ParamLocation Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ParamLocation -> m ParamLocation Source #
Show ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ParamLocation -> ShowS Source # show :: ParamLocation -> String Source # showList :: [ ParamLocation ] -> ShowS Source #
Generic ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep ParamLocation :: Type -> Type Source # Methods from :: ParamLocation -> Rep ParamLocation x Source # to :: Rep ParamLocation x -> ParamLocation Source #
ToJSON ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: ParamLocation -> Value Source # toEncoding :: ParamLocation -> Encoding Source # toJSONList :: [ ParamLocation ] -> Value Source # toEncodingList :: [ ParamLocation ] -> Encoding Source #
FromJSON ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ParamLocation Source # parseJSONList :: Value -> Parser [ ParamLocation ] Source #
AesonDefaultValue ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe ParamLocation Source #
SwaggerMonoid ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: ParamLocation Source # swaggerMappend :: ParamLocation -> ParamLocation -> ParamLocation Source #
HasIn Param ParamLocation Source #
Instance details Defined in Data.OpenApi.Lens Methods in_ :: Lens' Param ParamLocation Source #
type Rep ParamLocation Source #
Instance details Defined in Data.OpenApi.Internal type Rep ParamLocation = D1 (' MetaData "ParamLocation" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' False ) (( C1 (' MetaCons "ParamQuery" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ParamHeader" ' PrefixI ' False ) ( U1 :: Type -> Type )) :+: ( C1 (' MetaCons "ParamPath" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ParamCookie" ' PrefixI ' False ) ( U1 :: Type -> Type )))

type ParamName = Text Source #

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.

Constructors

Header
Fields _headerDescription :: Maybe HeaderName A short description of the header. _headerRequired :: Maybe Bool _headerDeprecated :: Maybe Bool _headerAllowEmptyValue :: Maybe Bool _headerExplode :: Maybe Bool _headerExample :: Maybe Value _headerExamples :: InsOrdHashMap Text ( Referenced Example ) _headerSchema :: Maybe ( Referenced Schema )

Instances

type HeaderName = Text Source #

data Example Source #

Constructors

Example

Fields

_exampleSummary :: Maybe Text

Short description for the example.
_exampleDescription :: Maybe Text

Long description for the example. CommonMark syntax MAY be used for rich text representation.
_exampleValue :: Maybe Value

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

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

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

Instances

Instances details

Eq Example Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Example -> Example -> Bool Source # (/=) :: Example -> Example -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Example Source # toConstr :: Example -> Constr Source # dataTypeOf :: Example -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Example ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Example ) Source # gmapT :: ( forall b. Data b => b -> b) -> Example -> Example Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Example -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Example -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Example -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Example -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Example -> m Example Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Example -> m Example Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Example -> m Example Source #
Show Example Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Example -> ShowS Source # show :: Example -> String Source # showList :: [ Example ] -> ShowS Source #
Generic Example Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Example :: Type -> Type Source # Methods from :: Example -> Rep Example x Source # to :: Rep Example x -> Example Source #
ToJSON Example Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Example -> Value Source # toEncoding :: Example -> Encoding Source # toJSONList :: [ Example ] -> Value Source # toEncodingList :: [ Example ] -> Encoding Source #
FromJSON Example Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Example Source # parseJSONList :: Value -> Parser [ Example ] Source #
Generic Example Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Example :: [[ Type ]] Source # Methods from :: Example -> Rep Example Source # to :: Rep Example -> Example Source #
HasDatatypeInfo Example Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Example :: DatatypeInfo Source # Methods datatypeInfo :: proxy Example -> DatatypeInfo ( Code Example ) Source #
HasSwaggerAesonOptions Example Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Example -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Example -> POP Maybe ( Code Example ) Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k Example Example a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Example Example a b Source #
(k ~ A_Lens , a ~ Maybe URL , b ~ Maybe URL ) => LabelOptic "externalValue" k Example Example a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Example Example a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "summary" k Example Example a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Example Example a b Source #
(k ~ A_Lens , a ~ Maybe Value , b ~ Maybe Value ) => LabelOptic "value" k Example Example a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Example Example a b Source #
HasExamples Components ( Definitions Example ) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Components ( Definitions Example ) Source #
HasDescription Example ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Example ( Maybe Text ) Source #
HasSummary Example ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods summary :: Lens' Example ( Maybe Text ) Source #
HasValue Example ( Maybe Value ) Source #
Instance details Defined in Data.OpenApi.Lens Methods value :: Lens' Example ( Maybe Value ) Source #
HasExternalValue Example ( Maybe URL ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalValue :: Lens' Example ( Maybe URL ) Source #
HasExamples Header ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Header ( InsOrdHashMap Text ( Referenced Example )) Source #
HasExamples Param ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Param ( InsOrdHashMap Text ( Referenced Example )) Source #
HasExamples MediaTypeObject ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject ( InsOrdHashMap Text ( Referenced Example )) Source #
ToJSON ( Referenced Example ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Example -> Value Source # toEncoding :: Referenced Example -> Encoding Source # toJSONList :: [ Referenced Example ] -> Value Source # toEncodingList :: [ Referenced Example ] -> Encoding Source #
FromJSON ( Referenced Example ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Example ) Source # parseJSONList :: Value -> Parser [ Referenced Example ] Source #
type Rep Example Source #
Instance details Defined in Data.OpenApi.Internal type Rep Example = D1 (' MetaData "Example" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Example = '['[ Maybe Text , Maybe Text , Maybe Value , Maybe URL ]]
type DatatypeInfoOf Example Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Example = ' ADT "Data.OpenApi.Internal" "Example" '[' Record "Example" '[' FieldInfo "_exampleSummary", ' FieldInfo "_exampleDescription", ' FieldInfo "_exampleValue", ' FieldInfo "_exampleExternalValue"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

data RequestBody Source #

Describes a single request body.

Constructors

RequestBody

Fields

_requestBodyDescription :: Maybe Text

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

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

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

Instances

Instances details

Eq RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: RequestBody -> RequestBody -> Bool Source # (/=) :: RequestBody -> RequestBody -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c RequestBody Source # toConstr :: RequestBody -> Constr Source # dataTypeOf :: RequestBody -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c RequestBody ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c RequestBody ) Source # gmapT :: ( forall b. Data b => b -> b) -> RequestBody -> RequestBody Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> RequestBody -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> RequestBody -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> RequestBody -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> RequestBody -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> RequestBody -> m RequestBody Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> RequestBody -> m RequestBody Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> RequestBody -> m RequestBody Source #
Show RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> RequestBody -> ShowS Source # show :: RequestBody -> String Source # showList :: [ RequestBody ] -> ShowS Source #
Generic RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep RequestBody :: Type -> Type Source # Methods from :: RequestBody -> Rep RequestBody x Source # to :: Rep RequestBody x -> RequestBody Source #
Semigroup RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: RequestBody -> RequestBody -> RequestBody Source # sconcat :: NonEmpty RequestBody -> RequestBody Source # stimes :: Integral b => b -> RequestBody -> RequestBody Source #
Monoid RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: RequestBody Source # mappend :: RequestBody -> RequestBody -> RequestBody Source # mconcat :: [ RequestBody ] -> RequestBody Source #
ToJSON RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: RequestBody -> Value Source # toEncoding :: RequestBody -> Encoding Source # toJSONList :: [ RequestBody ] -> Value Source # toEncodingList :: [ RequestBody ] -> Encoding Source #
FromJSON RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser RequestBody Source # parseJSONList :: Value -> Parser [ RequestBody ] Source #
Generic RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code RequestBody :: [[ Type ]] Source # Methods from :: RequestBody -> Rep RequestBody Source # to :: Rep RequestBody -> RequestBody Source #
HasDatatypeInfo RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf RequestBody :: DatatypeInfo Source # Methods datatypeInfo :: proxy RequestBody -> DatatypeInfo ( Code RequestBody ) Source #
HasSwaggerAesonOptions RequestBody Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy RequestBody -> SwaggerAesonOptions Source # aesonDefaults :: Proxy RequestBody -> POP Maybe ( Code RequestBody ) Source #
(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 Methods labelOptic :: Optic k NoIx RequestBody RequestBody a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k RequestBody RequestBody a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx RequestBody RequestBody a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "required" k RequestBody RequestBody a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx RequestBody RequestBody a b Source #
HasRequestBodies Components ( Definitions RequestBody ) Source #
Instance details Defined in Data.OpenApi.Lens Methods requestBodies :: Lens' Components ( Definitions RequestBody ) Source #
HasDescription RequestBody ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' RequestBody ( Maybe Text ) Source #
HasRequired RequestBody ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods required :: Lens' RequestBody ( Maybe Bool ) Source #
HasRequestBody Operation ( Maybe ( Referenced RequestBody )) Source #
Instance details Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation ( Maybe ( Referenced RequestBody )) Source #
HasContent RequestBody ( InsOrdHashMap MediaType MediaTypeObject ) Source #
Instance details Defined in Data.OpenApi.Lens Methods content :: Lens' RequestBody ( InsOrdHashMap MediaType MediaTypeObject ) Source #
ToJSON ( Referenced RequestBody ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced RequestBody -> Value Source # toEncoding :: Referenced RequestBody -> Encoding Source # toJSONList :: [ Referenced RequestBody ] -> Value Source # toEncodingList :: [ Referenced RequestBody ] -> Encoding Source #
FromJSON ( Referenced RequestBody ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced RequestBody ) Source # parseJSONList :: Value -> Parser [ Referenced RequestBody ] Source #
type Rep RequestBody Source #
Instance details Defined in Data.OpenApi.Internal type Rep RequestBody = D1 (' MetaData "RequestBody" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code RequestBody = '['[ Maybe Text , InsOrdHashMap MediaType MediaTypeObject , Maybe Bool ]]
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

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

Example of the media type. The example object SHOULD be in the correct format as specified by the media type.
_mediaTypeObjectExamples :: InsOrdHashMap Text ( Referenced Example )

Examples of the media type. Each example object SHOULD match the media type and specified schema if present.
_mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding

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

Instances

Instances details

Eq MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: MediaTypeObject -> MediaTypeObject -> Bool Source # (/=) :: MediaTypeObject -> MediaTypeObject -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c MediaTypeObject Source # toConstr :: MediaTypeObject -> Constr Source # dataTypeOf :: MediaTypeObject -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c MediaTypeObject ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c MediaTypeObject ) Source # gmapT :: ( forall b. Data b => b -> b) -> MediaTypeObject -> MediaTypeObject Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> MediaTypeObject -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> MediaTypeObject -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> MediaTypeObject -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> MediaTypeObject -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> MediaTypeObject -> m MediaTypeObject Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> MediaTypeObject -> m MediaTypeObject Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> MediaTypeObject -> m MediaTypeObject Source #
Show MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> MediaTypeObject -> ShowS Source # show :: MediaTypeObject -> String Source # showList :: [ MediaTypeObject ] -> ShowS Source #
Generic MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep MediaTypeObject :: Type -> Type Source # Methods from :: MediaTypeObject -> Rep MediaTypeObject x Source # to :: Rep MediaTypeObject x -> MediaTypeObject Source #
Semigroup MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: MediaTypeObject -> MediaTypeObject -> MediaTypeObject Source # sconcat :: NonEmpty MediaTypeObject -> MediaTypeObject Source # stimes :: Integral b => b -> MediaTypeObject -> MediaTypeObject Source #
Monoid MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: MediaTypeObject Source # mappend :: MediaTypeObject -> MediaTypeObject -> MediaTypeObject Source # mconcat :: [ MediaTypeObject ] -> MediaTypeObject Source #
ToJSON MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: MediaTypeObject -> Value Source # toEncoding :: MediaTypeObject -> Encoding Source # toJSONList :: [ MediaTypeObject ] -> Value Source # toEncodingList :: [ MediaTypeObject ] -> Encoding Source #
FromJSON MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser MediaTypeObject Source # parseJSONList :: Value -> Parser [ MediaTypeObject ] Source #
Generic MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code MediaTypeObject :: [[ Type ]] Source # Methods from :: MediaTypeObject -> Rep MediaTypeObject Source # to :: Rep MediaTypeObject -> MediaTypeObject Source #
HasDatatypeInfo MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf MediaTypeObject :: DatatypeInfo Source # Methods datatypeInfo :: proxy MediaTypeObject -> DatatypeInfo ( Code MediaTypeObject ) Source #
HasSwaggerAesonOptions MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy MediaTypeObject -> SwaggerAesonOptions Source # aesonDefaults :: Proxy MediaTypeObject -> POP Maybe ( Code MediaTypeObject ) Source #
(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 Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b Source #
(k ~ A_Lens , a ~ Maybe Value , b ~ Maybe Value ) => LabelOptic "example" k MediaTypeObject MediaTypeObject a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b Source #
(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 Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b Source #
(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 Methods labelOptic :: Optic k NoIx MediaTypeObject MediaTypeObject a b Source #
HasSchema MediaTypeObject ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject ( Maybe ( Referenced Schema )) Source #
HasExample MediaTypeObject ( Maybe Value ) Source #
Instance details Defined in Data.OpenApi.Lens Methods example :: Lens' MediaTypeObject ( Maybe Value ) Source #
HasExamples MediaTypeObject ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject ( InsOrdHashMap Text ( Referenced Example )) Source #
HasContent Response ( InsOrdHashMap MediaType MediaTypeObject ) Source #
Instance details Defined in Data.OpenApi.Lens Methods content :: Lens' Response ( InsOrdHashMap MediaType MediaTypeObject ) Source #
HasContent RequestBody ( InsOrdHashMap MediaType MediaTypeObject ) Source #
Instance details Defined in Data.OpenApi.Lens Methods content :: Lens' RequestBody ( InsOrdHashMap MediaType MediaTypeObject ) Source #
HasEncoding MediaTypeObject ( InsOrdHashMap Text Encoding ) Source #
Instance details Defined in Data.OpenApi.Lens Methods encoding :: Lens' MediaTypeObject ( InsOrdHashMap Text Encoding ) Source #
type Rep MediaTypeObject Source #
Instance details Defined in Data.OpenApi.Internal type Rep MediaTypeObject = D1 (' MetaData "MediaTypeObject" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code MediaTypeObject = '['[ Maybe ( Referenced Schema ), Maybe Value , InsOrdHashMap Text ( Referenced Example ), InsOrdHashMap Text Encoding ]]
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 binary – application/octet-stream ; for other primitive types – text/plain ; for object - application/json ; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json ), a wildcard media type (e.g. image/* ), or a comma-separated list of the two types.
_encodingHeaders :: InsOrdHashMap Text ( Referenced Header )

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

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

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

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

Instances

Instances details

Eq Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Encoding -> Encoding -> Bool Source # (/=) :: Encoding -> Encoding -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Encoding Source # toConstr :: Encoding -> Constr Source # dataTypeOf :: Encoding -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Encoding ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Encoding ) Source # gmapT :: ( forall b. Data b => b -> b) -> Encoding -> Encoding Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Encoding -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Encoding -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Encoding -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Encoding -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Encoding -> m Encoding Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Encoding -> m Encoding Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Encoding -> m Encoding Source #
Show Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Encoding -> ShowS Source # show :: Encoding -> String Source # showList :: [ Encoding ] -> ShowS Source #
Generic Encoding Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Encoding :: Type -> Type Source # Methods from :: Encoding -> Rep Encoding x Source # to :: Rep Encoding x -> Encoding Source #
Semigroup Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Encoding -> Encoding -> Encoding Source # sconcat :: NonEmpty Encoding -> Encoding Source # stimes :: Integral b => b -> Encoding -> Encoding Source #
Monoid Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Encoding Source # mappend :: Encoding -> Encoding -> Encoding Source # mconcat :: [ Encoding ] -> Encoding Source #
ToJSON Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Encoding -> Value Source # toEncoding :: Encoding -> Encoding0 Source # toJSONList :: [ Encoding ] -> Value Source # toEncodingList :: [ Encoding ] -> Encoding0 Source #
FromJSON Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Encoding Source # parseJSONList :: Value -> Parser [ Encoding ] Source #
Generic Encoding Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Encoding :: [[ Type ]] Source # Methods from :: Encoding -> Rep Encoding Source # to :: Rep Encoding -> Encoding Source #
HasDatatypeInfo Encoding Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Encoding :: DatatypeInfo Source # Methods datatypeInfo :: proxy Encoding -> DatatypeInfo ( Code Encoding ) Source #
HasSwaggerAesonOptions Encoding Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Encoding -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Encoding -> POP Maybe ( Code Encoding ) Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "allowReserved" k Encoding Encoding a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Encoding Encoding a b Source #
(k ~ A_Lens , a ~ Maybe MediaType , b ~ Maybe MediaType ) => LabelOptic "contentType" k Encoding Encoding a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Encoding Encoding a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "explode" k Encoding Encoding a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Encoding Encoding a b Source #
(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 Methods labelOptic :: Optic k NoIx Encoding Encoding a b Source #
(k ~ A_Lens , a ~ Maybe Style , b ~ Maybe Style ) => LabelOptic "style" k Encoding Encoding a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Encoding Encoding a b Source #
HasStyle Encoding ( Maybe Style ) Source #
Instance details Defined in Data.OpenApi.Lens Methods style :: Lens' Encoding ( Maybe Style ) Source #
HasExplode Encoding ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods explode :: Lens' Encoding ( Maybe Bool ) Source #
HasAllowReserved Encoding ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods allowReserved :: Lens' Encoding ( Maybe Bool ) Source #
HasContentType Encoding ( Maybe MediaType ) Source #
Instance details Defined in Data.OpenApi.Lens Methods contentType :: Lens' Encoding ( Maybe MediaType ) Source #
HasHeaders Encoding ( InsOrdHashMap Text ( Referenced Header )) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding ( InsOrdHashMap Text ( Referenced Header )) Source #
HasEncoding MediaTypeObject ( InsOrdHashMap Text Encoding ) Source #
Instance details Defined in Data.OpenApi.Lens Methods encoding :: Lens' MediaTypeObject ( InsOrdHashMap Text Encoding ) Source #
type Rep Encoding Source #
Instance details Defined in Data.OpenApi.Internal type Rep Encoding = D1 (' MetaData "Encoding" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Encoding = '['[ Maybe MediaType , InsOrdHashMap Text ( Referenced Header ), Maybe Style , Maybe Bool , Maybe Bool ]]
type DatatypeInfoOf Encoding Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Encoding = ' ADT "Data.OpenApi.Internal" "Encoding" '[' Record "Encoding" '[' FieldInfo "_encodingContentType", ' FieldInfo "_encodingHeaders", ' FieldInfo "_encodingStyle", ' FieldInfo "_encodingExplode", ' FieldInfo "_encodingAllowReserved"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

Schemas

data Schema Source #

Constructors

Schema

Fields

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

Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) Unlike JSON Schema this value MUST conform to the defined type for this parameter.
_schemaType :: Maybe OpenApiType
_schemaFormat :: Maybe Format
_schemaItems :: Maybe OpenApiItems
_schemaMaximum :: Maybe Scientific
_schemaExclusiveMaximum :: Maybe Bool
_schemaMinimum :: Maybe Scientific
_schemaExclusiveMinimum :: Maybe Bool
_schemaMaxLength :: Maybe Integer
_schemaMinLength :: Maybe Integer
_schemaPattern :: Maybe Pattern
_schemaMaxItems :: Maybe Integer
_schemaMinItems :: Maybe Integer
_schemaUniqueItems :: Maybe Bool
_schemaEnum :: Maybe [ Value ]
_schemaMultipleOf :: Maybe Scientific

Instances

Instances details

Eq Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Schema -> Schema -> Bool Source # (/=) :: Schema -> Schema -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Schema Source # toConstr :: Schema -> Constr Source # dataTypeOf :: Schema -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Schema ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Schema ) Source # gmapT :: ( forall b. Data b => b -> b) -> Schema -> Schema Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Schema -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Schema -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Schema -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Schema -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Schema -> m Schema Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Schema -> m Schema Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Schema -> m Schema Source #
Show Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Schema -> ShowS Source # show :: Schema -> String Source # showList :: [ Schema ] -> ShowS Source #
Generic Schema Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Schema :: Type -> Type Source # Methods from :: Schema -> Rep Schema x Source # to :: Rep Schema x -> Schema Source #
Semigroup Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Schema -> Schema -> Schema Source # sconcat :: NonEmpty Schema -> Schema Source # stimes :: Integral b => b -> Schema -> Schema Source #
Monoid Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Schema Source # mappend :: Schema -> Schema -> Schema Source # mconcat :: [ Schema ] -> Schema Source #
ToJSON Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Schema -> Value Source # toEncoding :: Schema -> Encoding Source # toJSONList :: [ Schema ] -> Value Source # toEncodingList :: [ Schema ] -> Encoding Source #
FromJSON Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Schema Source # parseJSONList :: Value -> Parser [ Schema ] Source #
Generic Schema Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Schema :: [[ Type ]] Source # Methods from :: Schema -> Rep Schema Source # to :: Rep Schema -> Schema Source #
HasDatatypeInfo Schema Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Schema :: DatatypeInfo Source # Methods datatypeInfo :: proxy Schema -> DatatypeInfo ( Code Schema ) Source #
HasSwaggerAesonOptions Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Schema -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Schema -> POP Maybe ( Code Schema ) Source #
SwaggerMonoid Schema Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Schema Source # swaggerMappend :: Schema -> Schema -> Schema Source #
HasSchema NamedSchema Schema Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' NamedSchema Schema Source #
(k ~ A_Lens , a ~ Maybe AdditionalProperties , b ~ Maybe AdditionalProperties ) => LabelOptic "additionalProperties" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(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 Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(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 Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Value , b ~ Maybe Value ) => LabelOptic "default" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "deprecated" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Discriminator , b ~ Maybe Discriminator ) => LabelOptic "discriminator" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe [ Value ], b ~ Maybe [ Value ]) => LabelOptic "enum" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Value , b ~ Maybe Value ) => LabelOptic "example" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "exclusiveMaximum" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "exclusiveMinimum" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe ExternalDocs , b ~ Maybe ExternalDocs ) => LabelOptic "externalDocs" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Format , b ~ Maybe Format ) => LabelOptic "format" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe OpenApiItems , b ~ Maybe OpenApiItems ) => LabelOptic "items" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "maxItems" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "maxLength" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "maxProperties" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Scientific , b ~ Maybe Scientific ) => LabelOptic "maximum" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "minItems" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "minLength" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "minProperties" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Scientific , b ~ Maybe Scientific ) => LabelOptic "minimum" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Scientific , b ~ Maybe Scientific ) => LabelOptic "multipleOf" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(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 Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "nullable" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(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 Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Pattern , b ~ Maybe Pattern ) => LabelOptic "pattern" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(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 Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "readOnly" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ [ ParamName ], b ~ [ ParamName ]) => LabelOptic "required" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "title" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe OpenApiType , b ~ Maybe OpenApiType ) => LabelOptic "type" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "uniqueItems" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "writeOnly" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
(k ~ A_Lens , a ~ Maybe Xml , b ~ Maybe Xml ) => LabelOptic "xml" k Schema Schema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Schema Schema a b Source #
HasExternalDocs Schema ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Schema ( Maybe ExternalDocs ) Source #
HasSchemas Components ( Definitions Schema ) Source #
Instance details Defined in Data.OpenApi.Lens Methods schemas :: Lens' Components ( Definitions Schema ) Source #
HasDescription Schema ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Schema ( Maybe Text ) Source #
HasRequired Schema [ ParamName ] Source #
Instance details Defined in Data.OpenApi.Lens Methods required :: Lens' Schema [ ParamName ] Source #
HasSchema Header ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' Header ( Maybe ( Referenced Schema )) Source #
HasSchema Param ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' Param ( Maybe ( Referenced Schema )) Source #
HasSchema MediaTypeObject ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject ( Maybe ( Referenced Schema )) Source #
HasExample Schema ( Maybe Value ) Source #
Instance details Defined in Data.OpenApi.Lens Methods example :: Lens' Schema ( Maybe Value ) Source #
HasTitle Schema ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods title :: Lens' Schema ( Maybe Text ) Source #
HasDeprecated Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods deprecated :: Lens' Schema ( Maybe Bool ) Source #
HasXml Schema ( Maybe Xml ) Source #
Instance details Defined in Data.OpenApi.Lens Methods xml :: Lens' Schema ( Maybe Xml ) Source #
HasWriteOnly Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods writeOnly :: Lens' Schema ( Maybe Bool ) Source #
HasUniqueItems Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods uniqueItems :: Lens' Schema ( Maybe Bool ) Source #
HasType Schema ( Maybe OpenApiType ) Source #
Instance details Defined in Data.OpenApi.Lens Methods type_ :: Lens' Schema ( Maybe OpenApiType ) Source #
HasReadOnly Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods readOnly :: Lens' Schema ( Maybe Bool ) Source #
HasPattern Schema ( Maybe Pattern ) Source #
Instance details Defined in Data.OpenApi.Lens Methods pattern :: Lens' Schema ( Maybe Pattern ) Source #
HasOneOf Schema ( Maybe [ Referenced Schema ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods oneOf :: Lens' Schema ( Maybe [ Referenced Schema ]) Source #
HasNullable Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods nullable :: Lens' Schema ( Maybe Bool ) Source #
HasNot Schema ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods not_ :: Lens' Schema ( Maybe ( Referenced Schema )) Source #
HasMultipleOf Schema ( Maybe Scientific ) Source #
Instance details Defined in Data.OpenApi.Lens Methods multipleOf :: Lens' Schema ( Maybe Scientific ) Source #
HasMinimum Schema ( Maybe Scientific ) Source #
Instance details Defined in Data.OpenApi.Lens Methods minimum_ :: Lens' Schema ( Maybe Scientific ) Source #
HasMinProperties Schema ( Maybe Integer ) Source #
Instance details Defined in Data.OpenApi.Lens Methods minProperties :: Lens' Schema ( Maybe Integer ) Source #
HasMinLength Schema ( Maybe Integer ) Source #
Instance details Defined in Data.OpenApi.Lens Methods minLength :: Lens' Schema ( Maybe Integer ) Source #
HasMinItems Schema ( Maybe Integer ) Source #
Instance details Defined in Data.OpenApi.Lens Methods minItems :: Lens' Schema ( Maybe Integer ) Source #
HasMaximum Schema ( Maybe Scientific ) Source #
Instance details Defined in Data.OpenApi.Lens Methods maximum_ :: Lens' Schema ( Maybe Scientific ) Source #
HasMaxProperties Schema ( Maybe Integer ) Source #
Instance details Defined in Data.OpenApi.Lens Methods maxProperties :: Lens' Schema ( Maybe Integer ) Source #
HasMaxLength Schema ( Maybe Integer ) Source #
Instance details Defined in Data.OpenApi.Lens Methods maxLength :: Lens' Schema ( Maybe Integer ) Source #
HasMaxItems Schema ( Maybe Integer ) Source #
Instance details Defined in Data.OpenApi.Lens Methods maxItems :: Lens' Schema ( Maybe Integer ) Source #
HasItems Schema ( Maybe OpenApiItems ) Source #
Instance details Defined in Data.OpenApi.Lens Methods items :: Lens' Schema ( Maybe OpenApiItems ) Source #
HasFormat Schema ( Maybe Format ) Source #
Instance details Defined in Data.OpenApi.Lens Methods format :: Lens' Schema ( Maybe Format ) Source #
HasExclusiveMinimum Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods exclusiveMinimum :: Lens' Schema ( Maybe Bool ) Source #
HasExclusiveMaximum Schema ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods exclusiveMaximum :: Lens' Schema ( Maybe Bool ) Source #
HasEnum Schema ( Maybe [ Value ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods enum_ :: Lens' Schema ( Maybe [ Value ]) Source #
HasDiscriminator Schema ( Maybe Discriminator ) Source #
Instance details Defined in Data.OpenApi.Lens Methods discriminator :: Lens' Schema ( Maybe Discriminator ) Source #
HasDefault Schema ( Maybe Value ) Source #
Instance details Defined in Data.OpenApi.Lens Methods default_ :: Lens' Schema ( Maybe Value ) Source #
HasAnyOf Schema ( Maybe [ Referenced Schema ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods anyOf :: Lens' Schema ( Maybe [ Referenced Schema ]) Source #
HasAllOf Schema ( Maybe [ Referenced Schema ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods allOf :: Lens' Schema ( Maybe [ Referenced Schema ]) Source #
HasAdditionalProperties Schema ( Maybe AdditionalProperties ) Source #
Instance details Defined in Data.OpenApi.Lens Methods additionalProperties :: Lens' Schema ( Maybe AdditionalProperties ) Source #
HasProperties Schema ( InsOrdHashMap Text ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods properties :: Lens' Schema ( InsOrdHashMap Text ( Referenced Schema )) Source #
ToJSON ( Referenced Schema ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Schema -> Value Source # toEncoding :: Referenced Schema -> Encoding Source # toJSONList :: [ Referenced Schema ] -> Value Source # toEncodingList :: [ Referenced Schema ] -> Encoding Source #
FromJSON ( Referenced Schema ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Schema ) Source # parseJSONList :: Value -> Parser [ Referenced Schema ] Source #
type Rep Schema Source #
Instance details Defined in Data.OpenApi.Internal type Rep Schema = D1 (' MetaData "Schema" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Schema = '['[ Maybe Text , Maybe Text , [ ParamName ], Maybe Bool , Maybe [ Referenced Schema ], Maybe [ Referenced Schema ], Maybe ( Referenced Schema ), Maybe [ Referenced Schema ], InsOrdHashMap Text ( Referenced Schema ), Maybe AdditionalProperties , Maybe Discriminator , Maybe Bool , Maybe Bool , Maybe Xml , Maybe ExternalDocs , Maybe Value , Maybe Bool , Maybe Integer , Maybe Integer , Maybe Value , Maybe OpenApiType , Maybe Format , Maybe OpenApiItems , Maybe Scientific , Maybe Bool , Maybe Scientific , Maybe Bool , Maybe Integer , Maybe Integer , Maybe Pattern , Maybe Integer , Maybe Integer , Maybe Bool , Maybe [ Value ], Maybe Scientific ]]
type DatatypeInfoOf Schema 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.

Constructors

NamedSchema
Fields _namedSchemaName :: Maybe Text _namedSchemaSchema :: Schema

Instances

Instances details

Eq NamedSchema Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: NamedSchema -> NamedSchema -> Bool Source # (/=) :: NamedSchema -> NamedSchema -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c NamedSchema Source # toConstr :: NamedSchema -> Constr Source # dataTypeOf :: NamedSchema -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c NamedSchema ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c NamedSchema ) Source # gmapT :: ( forall b. Data b => b -> b) -> NamedSchema -> NamedSchema Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> NamedSchema -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> NamedSchema -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> NamedSchema -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> NamedSchema -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> NamedSchema -> m NamedSchema Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> NamedSchema -> m NamedSchema Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> NamedSchema -> m NamedSchema Source #
Show NamedSchema Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> NamedSchema -> ShowS Source # show :: NamedSchema -> String Source # showList :: [ NamedSchema ] -> ShowS Source #
Generic NamedSchema Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep NamedSchema :: Type -> Type Source # Methods from :: NamedSchema -> Rep NamedSchema x Source # to :: Rep NamedSchema x -> NamedSchema Source #
HasSchema NamedSchema Schema Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' NamedSchema Schema Source #
(a ~ Maybe Value , b ~ Maybe Value ) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe [ Value ], b ~ Maybe [ Value ]) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Format , b ~ Maybe Format ) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe OpenApiItems , b ~ Maybe OpenApiItems ) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Scientific , b ~ Maybe Scientific ) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Integer , b ~ Maybe Integer ) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Scientific , b ~ Maybe Scientific ) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Scientific , b ~ Maybe Scientific ) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "name" k NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(k ~ A_Lens , a ~ Schema , b ~ Schema ) => LabelOptic "schema" k NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe OpenApiType , b ~ Maybe OpenApiType ) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
(a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Lens NoIx NamedSchema NamedSchema a b Source #
HasName NamedSchema ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods name :: Lens' NamedSchema ( Maybe Text ) Source #
HasType NamedSchema ( Maybe OpenApiType ) Source #
Instance details Defined in Data.OpenApi.Lens Methods type_ :: Lens' NamedSchema ( Maybe OpenApiType ) Source #
type Rep NamedSchema Source #
Instance details Defined in Data.OpenApi.Internal type Rep NamedSchema = D1 (' MetaData "NamedSchema" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Schema s.

OpenApiItemsArray should be used to specify tuple Schema s.

Constructors

OpenApiItemsObject :: Referenced Schema -> OpenApiItems
OpenApiItemsArray :: [ Referenced Schema ] -> OpenApiItems

Instances

Instances details

Eq OpenApiItems Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OpenApiItems -> OpenApiItems -> Bool Source # (/=) :: OpenApiItems -> OpenApiItems -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OpenApiItems Source # toConstr :: OpenApiItems -> Constr Source # dataTypeOf :: OpenApiItems -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OpenApiItems ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OpenApiItems ) Source # gmapT :: ( forall b. Data b => b -> b) -> OpenApiItems -> OpenApiItems Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OpenApiItems -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OpenApiItems -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OpenApiItems -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OpenApiItems -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OpenApiItems -> m OpenApiItems Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OpenApiItems -> m OpenApiItems Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OpenApiItems -> m OpenApiItems Source #
Show OpenApiItems Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OpenApiItems -> ShowS Source # show :: OpenApiItems -> String Source # showList :: [ OpenApiItems ] -> ShowS Source #
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 Methods toJSON :: OpenApiItems -> Value Source # toEncoding :: OpenApiItems -> Encoding Source # toJSONList :: [ OpenApiItems ] -> Value Source # toEncodingList :: [ OpenApiItems ] -> Encoding Source #
FromJSON OpenApiItems Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OpenApiItems Source # parseJSONList :: Value -> Parser [ OpenApiItems ] Source #
(a ~ [ Referenced Schema ], b ~ [ Referenced Schema ]) => LabelOptic "_OpenApiItemsArray" A_Review OpenApiItems OpenApiItems a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Review NoIx OpenApiItems OpenApiItems a b Source #
(a ~ Referenced Schema , b ~ Referenced Schema ) => LabelOptic "_OpenApiItemsObject" A_Review OpenApiItems OpenApiItems a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic A_Review NoIx OpenApiItems OpenApiItems a b Source #
HasSchema s Schema => HasItems s ( Maybe OpenApiItems ) Source #
Instance details Defined in Data.OpenApi.Lens Methods items :: Lens' s ( Maybe OpenApiItems ) Source #
HasItems Schema ( Maybe OpenApiItems ) Source #
Instance details Defined in Data.OpenApi.Lens Methods items :: Lens' Schema ( Maybe OpenApiItems ) Source #

data Xml Source #

Constructors

Xml

Fields

_xmlName :: Maybe Text

Replaces the name of the element/attribute used for the described schema property. When defined within the 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 Source # (/=) :: Xml -> Xml -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Xml Source # toConstr :: Xml -> Constr Source # dataTypeOf :: Xml -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Xml ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Xml ) Source # gmapT :: ( forall b. Data b => b -> b) -> Xml -> Xml Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Xml -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Xml -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Xml -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Xml -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Xml -> m Xml Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Xml -> m Xml Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Xml -> m Xml Source #
Show Xml Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Xml -> ShowS Source # show :: Xml -> String Source # showList :: [ Xml ] -> ShowS Source #
Generic Xml Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Xml :: Type -> Type Source # Methods from :: Xml -> Rep Xml x Source # to :: Rep Xml x -> Xml Source #
ToJSON Xml Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Xml -> Value Source # toEncoding :: Xml -> Encoding Source # toJSONList :: [ Xml ] -> Value Source # toEncodingList :: [ Xml ] -> Encoding Source #
FromJSON Xml Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Xml Source # parseJSONList :: Value -> Parser [ Xml ] Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
(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 Source #
HasName Xml ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods name :: Lens' Xml ( Maybe Text ) Source #
HasXml Schema ( Maybe Xml ) Source #
Instance details Defined in Data.OpenApi.Lens Methods xml :: Lens' Schema ( Maybe Xml ) Source #
HasWrapped Xml ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods wrapped :: Lens' Xml ( Maybe Bool ) Source #
HasPrefix Xml ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods prefix :: Lens' Xml ( Maybe Text ) Source #
HasNamespace Xml ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods namespace :: Lens' Xml ( Maybe Text ) Source #
HasAttribute Xml ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods attribute :: Lens' Xml ( Maybe Bool ) Source #
type Rep Xml Source #
Instance details Defined in Data.OpenApi.Internal type Rep Xml = D1 (' MetaData "Xml" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 #

Constructors

AdditionalPropertiesAllowed Bool
AdditionalPropertiesSchema ( Referenced Schema )

Instances

Instances details

Eq AdditionalProperties Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: AdditionalProperties -> AdditionalProperties -> Bool Source # (/=) :: AdditionalProperties -> AdditionalProperties -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c AdditionalProperties Source # toConstr :: AdditionalProperties -> Constr Source # dataTypeOf :: AdditionalProperties -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c AdditionalProperties ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c AdditionalProperties ) Source # gmapT :: ( forall b. Data b => b -> b) -> AdditionalProperties -> AdditionalProperties Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> AdditionalProperties -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> AdditionalProperties -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> AdditionalProperties -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> AdditionalProperties -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> AdditionalProperties -> m AdditionalProperties Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> AdditionalProperties -> m AdditionalProperties Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> AdditionalProperties -> m AdditionalProperties Source #
Show AdditionalProperties Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> AdditionalProperties -> ShowS Source # show :: AdditionalProperties -> String Source # showList :: [ AdditionalProperties ] -> ShowS Source #
ToJSON AdditionalProperties Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: AdditionalProperties -> Value Source # toEncoding :: AdditionalProperties -> Encoding Source # toJSONList :: [ AdditionalProperties ] -> Value Source # toEncodingList :: [ AdditionalProperties ] -> Encoding Source #
FromJSON AdditionalProperties Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser AdditionalProperties Source # parseJSONList :: Value -> Parser [ AdditionalProperties ] Source #
HasAdditionalProperties Schema ( Maybe AdditionalProperties ) Source #
Instance details Defined in Data.OpenApi.Lens Methods additionalProperties :: Lens' Schema ( Maybe AdditionalProperties ) Source #

data Discriminator Source #

Constructors

Discriminator
Fields _discriminatorPropertyName :: Text The name of the property in the payload that will hold the discriminator value. _discriminatorMapping :: InsOrdHashMap Text Text An object to hold mappings between payload values and schema names or references.

Instances

Instances details

Eq Discriminator Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Discriminator -> Discriminator -> Bool Source # (/=) :: Discriminator -> Discriminator -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Discriminator Source # toConstr :: Discriminator -> Constr Source # dataTypeOf :: Discriminator -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Discriminator ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Discriminator ) Source # gmapT :: ( forall b. Data b => b -> b) -> Discriminator -> Discriminator Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Discriminator -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Discriminator -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Discriminator -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Discriminator -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Discriminator -> m Discriminator Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Discriminator -> m Discriminator Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Discriminator -> m Discriminator Source #
Show Discriminator Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Discriminator -> ShowS Source # show :: Discriminator -> String Source # showList :: [ Discriminator ] -> ShowS Source #
Generic Discriminator Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Discriminator :: Type -> Type Source # Methods from :: Discriminator -> Rep Discriminator x Source # to :: Rep Discriminator x -> Discriminator Source #
ToJSON Discriminator Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Discriminator -> Value Source # toEncoding :: Discriminator -> Encoding Source # toJSONList :: [ Discriminator ] -> Value Source # toEncodingList :: [ Discriminator ] -> Encoding Source #
FromJSON Discriminator Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Discriminator Source # parseJSONList :: Value -> Parser [ Discriminator ] Source #
HasPropertyName Discriminator Text Source #
Instance details Defined in Data.OpenApi.Lens Methods propertyName :: Lens' Discriminator Text Source #
(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 Methods labelOptic :: Optic k NoIx Discriminator Discriminator a b Source #
(k ~ A_Lens , a ~ Text , b ~ Text ) => LabelOptic "propertyName" k Discriminator Discriminator a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Discriminator Discriminator a b Source #
HasDiscriminator Schema ( Maybe Discriminator ) Source #
Instance details Defined in Data.OpenApi.Lens Methods discriminator :: Lens' Schema ( Maybe Discriminator ) Source #
HasMapping Discriminator ( InsOrdHashMap Text Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods mapping :: Lens' Discriminator ( InsOrdHashMap Text Text ) Source #
type Rep Discriminator Source #
Instance details Defined in Data.OpenApi.Internal type Rep Discriminator = D1 (' MetaData "Discriminator" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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

_responsesDefault :: Maybe ( Referenced Response )

The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses.
_responsesResponses :: InsOrdHashMap HttpStatusCode ( Referenced Response )

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

Instances

Instances details

Eq Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Responses -> Responses -> Bool Source # (/=) :: Responses -> Responses -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Responses Source # toConstr :: Responses -> Constr Source # dataTypeOf :: Responses -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Responses ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Responses ) Source # gmapT :: ( forall b. Data b => b -> b) -> Responses -> Responses Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Responses -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Responses -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Responses -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Responses -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Responses -> m Responses Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Responses -> m Responses Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Responses -> m Responses Source #
Show Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Responses -> ShowS Source # show :: Responses -> String Source # showList :: [ Responses ] -> ShowS Source #
Generic Responses Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Responses :: Type -> Type Source # Methods from :: Responses -> Rep Responses x Source # to :: Rep Responses x -> Responses Source #
Semigroup Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Responses -> Responses -> Responses Source # sconcat :: NonEmpty Responses -> Responses Source # stimes :: Integral b => b -> Responses -> Responses Source #
Monoid Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Responses Source # mappend :: Responses -> Responses -> Responses Source # mconcat :: [ Responses ] -> Responses Source #
ToJSON Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Responses -> Value Source # toEncoding :: Responses -> Encoding Source # toJSONList :: [ Responses ] -> Value Source # toEncodingList :: [ Responses ] -> Encoding Source #
FromJSON Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Responses Source # parseJSONList :: Value -> Parser [ Responses ] Source #
Generic Responses Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Responses :: [[ Type ]] Source # Methods from :: Responses -> Rep Responses Source # to :: Rep Responses -> Responses Source #
HasDatatypeInfo Responses Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Responses :: DatatypeInfo Source # Methods datatypeInfo :: proxy Responses -> DatatypeInfo ( Code Responses ) Source #
Ixed Responses Source #
Instance details Defined in Data.OpenApi.Lens Methods ix :: Index Responses -> Traversal' Responses ( IxValue Responses ) Source #
At Responses Source #
Instance details Defined in Data.OpenApi.Lens Methods at :: Index Responses -> Lens' Responses ( Maybe ( IxValue Responses )) Source #
Ixed Responses Source #
Instance details Defined in Data.OpenApi.Optics Associated Types type IxKind Responses Source # Methods ix :: Index Responses -> Optic' ( IxKind Responses ) NoIx Responses ( IxValue Responses ) Source #
At Responses Source #
Instance details Defined in Data.OpenApi.Optics Methods at :: Index Responses -> Lens' Responses ( Maybe ( IxValue Responses )) Source #
AesonDefaultValue Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Responses Source #
HasSwaggerAesonOptions Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Responses -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Responses -> POP Maybe ( Code Responses ) Source #
SwaggerMonoid Responses Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Responses Source # swaggerMappend :: Responses -> Responses -> Responses Source #
HasResponses Operation Responses Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Operation Responses Source #
(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 Methods labelOptic :: Optic k NoIx Responses Responses a b Source #
(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 Methods labelOptic :: Optic k NoIx Responses Responses a b Source #
HasDefault Responses ( Maybe ( Referenced Response )) Source #
Instance details Defined in Data.OpenApi.Lens Methods default_ :: Lens' Responses ( Maybe ( Referenced Response )) Source #
HasResponses Responses ( InsOrdHashMap HttpStatusCode ( Referenced Response )) Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses ( InsOrdHashMap HttpStatusCode ( Referenced Response )) Source #
type Rep Responses Source #
Instance details Defined in Data.OpenApi.Internal type Rep Responses = D1 (' MetaData "Responses" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Responses = '['[ Maybe ( Referenced Response ), InsOrdHashMap HttpStatusCode ( Referenced Response )]]
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 Index Responses = HttpStatusCode
type IxValue Responses Source #
Instance details Defined in Data.OpenApi.Lens type IxValue Responses = Referenced Response
type Index Responses Source #
Instance details Defined in Data.OpenApi.Optics type Index Responses = HttpStatusCode
type IxValue Responses Source #
Instance details Defined in Data.OpenApi.Optics type IxValue Responses = Referenced Response
type IxKind Responses Source #
Instance details Defined in Data.OpenApi.Optics type IxKind Responses = An_AffineTraversal

data Response Source #

Describes a single response from an API Operation.

Constructors

Response

Fields

_responseDescription :: Text

A short description of the response. CommonMark syntax can be used for rich text representation.
_responseContent :: InsOrdHashMap MediaType MediaTypeObject

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

Maps a header name to its definition.
_responseLinks :: InsOrdHashMap Text ( Referenced Link )

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

Instances

Instances details

Eq Response Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Response -> Response -> Bool Source # (/=) :: Response -> Response -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Response Source # toConstr :: Response -> Constr Source # dataTypeOf :: Response -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Response ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Response ) Source # gmapT :: ( forall b. Data b => b -> b) -> Response -> Response Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Response -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Response -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Response -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Response -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Response -> m Response Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Response -> m Response Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Response -> m Response Source #
Show Response Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Response -> ShowS Source # show :: Response -> String Source # showList :: [ Response ] -> ShowS Source #
IsString Response Source #
Instance details Defined in Data.OpenApi.Internal Methods fromString :: String -> Response Source #
Generic Response Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Response :: Type -> Type Source # Methods from :: Response -> Rep Response x Source # to :: Rep Response x -> Response Source #
Semigroup Response Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Response -> Response -> Response Source # sconcat :: NonEmpty Response -> Response Source # stimes :: Integral b => b -> Response -> Response Source #
Monoid Response Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Response Source # mappend :: Response -> Response -> Response Source # mconcat :: [ Response ] -> Response Source #
ToJSON Response Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Response -> Value Source # toEncoding :: Response -> Encoding Source # toJSONList :: [ Response ] -> Value Source # toEncodingList :: [ Response ] -> Encoding Source #
FromJSON Response Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Response Source # parseJSONList :: Value -> Parser [ Response ] Source #
Generic Response Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Response :: [[ Type ]] Source # Methods from :: Response -> Rep Response Source # to :: Rep Response -> Response Source #
HasDatatypeInfo Response Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Response :: DatatypeInfo Source # Methods datatypeInfo :: proxy Response -> DatatypeInfo ( Code Response ) Source #
HasSwaggerAesonOptions Response Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Response -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Response -> POP Maybe ( Code Response ) Source #
SwaggerMonoid Response Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Response Source # swaggerMappend :: Response -> Response -> Response Source #
HasDescription Response Text Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Response Text Source #
(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 Methods labelOptic :: Optic k NoIx Response Response a b Source #
(k ~ A_Lens , a ~ Text , b ~ Text ) => LabelOptic "description" k Response Response a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Response Response a b Source #
(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 Methods labelOptic :: Optic k NoIx Response Response a b Source #
(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 Methods labelOptic :: Optic k NoIx Response Response a b Source #
HasResponses Components ( Definitions Response ) Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Components ( Definitions Response ) Source #
HasDefault Responses ( Maybe ( Referenced Response )) Source #
Instance details Defined in Data.OpenApi.Lens Methods default_ :: Lens' Responses ( Maybe ( Referenced Response )) Source #
HasResponses Responses ( InsOrdHashMap HttpStatusCode ( Referenced Response )) Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses ( InsOrdHashMap HttpStatusCode ( Referenced Response )) Source #
HasLinks Response ( InsOrdHashMap Text ( Referenced Link )) Source #
Instance details Defined in Data.OpenApi.Lens Methods links :: Lens' Response ( InsOrdHashMap Text ( Referenced Link )) Source #
HasHeaders Response ( InsOrdHashMap HeaderName ( Referenced Header )) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Response ( InsOrdHashMap HeaderName ( Referenced Header )) Source #
HasContent Response ( InsOrdHashMap MediaType MediaTypeObject ) Source #
Instance details Defined in Data.OpenApi.Lens Methods content :: Lens' Response ( InsOrdHashMap MediaType MediaTypeObject ) Source #
ToJSON ( Referenced Response ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Response -> Value Source # toEncoding :: Referenced Response -> Encoding Source # toJSONList :: [ Referenced Response ] -> Value Source # toEncodingList :: [ Referenced Response ] -> Encoding Source #
FromJSON ( Referenced Response ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Response ) Source # parseJSONList :: Value -> Parser [ Referenced Response ] Source #
type Rep Response Source #
Instance details Defined in Data.OpenApi.Internal type Rep Response = D1 (' MetaData "Response" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code Response = '['[ Text , InsOrdHashMap MediaType MediaTypeObject , InsOrdHashMap HeaderName ( Referenced Header ), InsOrdHashMap Text ( Referenced Link )]]
type DatatypeInfoOf Response Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Response = ' ADT "Data.OpenApi.Internal" "Response" '[' Record "Response" '[' FieldInfo "_responseDescription", ' FieldInfo "_responseContent", ' FieldInfo "_responseHeaders", ' FieldInfo "_responseLinks"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

type HttpStatusCode = Int Source #

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

_linkOperationRef :: Maybe Text

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

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

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

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

A description of the link.
_linkServer :: Maybe Server

A server object to be used by the target operation.

Instances

Instances details

Eq Link Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Link -> Link -> Bool Source # (/=) :: Link -> Link -> Bool Source #
Data Link 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) -> Link -> c Link Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Link Source # toConstr :: Link -> Constr Source # dataTypeOf :: Link -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Link ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Link ) Source # gmapT :: ( forall b. Data b => b -> b) -> Link -> Link Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Link -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Link -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Link -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Link -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Link -> m Link Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Link -> m Link Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Link -> m Link Source #
Show Link Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Link -> ShowS Source # show :: Link -> String Source # showList :: [ Link ] -> ShowS Source #
Generic Link Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Link :: Type -> Type Source # Methods from :: Link -> Rep Link x Source # to :: Rep Link x -> Link Source #
ToJSON Link Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Link -> Value Source # toEncoding :: Link -> Encoding Source # toJSONList :: [ Link ] -> Value Source # toEncodingList :: [ Link ] -> Encoding Source #
FromJSON Link Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Link Source # parseJSONList :: Value -> Parser [ Link ] Source #
Generic Link Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Link :: [[ Type ]] Source # Methods from :: Link -> Rep Link Source # to :: Rep Link -> Link Source #
HasDatatypeInfo Link Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Link :: DatatypeInfo Source # Methods datatypeInfo :: proxy Link -> DatatypeInfo ( Code Link ) Source #
AesonDefaultValue Link Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe Link Source #
HasSwaggerAesonOptions Link Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Link -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Link -> POP Maybe ( Code Link ) Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k Link Link a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Link Link a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "operationId" k Link Link a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Link Link a b Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "operationRef" k Link Link a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Link Link a b Source #
(k ~ A_Lens , a ~ InsOrdHashMap Text ExpressionOrValue , b ~ InsOrdHashMap Text ExpressionOrValue ) => LabelOptic "parameters" k Link Link a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Link Link a b Source #
(k ~ A_Lens , a ~ Maybe ExpressionOrValue , b ~ Maybe ExpressionOrValue ) => LabelOptic "requestBody" k Link Link a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Link Link a b Source #
(k ~ A_Lens , a ~ Maybe Server , b ~ Maybe Server ) => LabelOptic "server" k Link Link a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Link Link a b Source #
HasLinks Components ( Definitions Link ) Source #
Instance details Defined in Data.OpenApi.Lens Methods links :: Lens' Components ( Definitions Link ) Source #
HasDescription Link ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Link ( Maybe Text ) Source #
HasRequestBody Link ( Maybe ExpressionOrValue ) Source #
Instance details Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Link ( Maybe ExpressionOrValue ) Source #
HasOperationId Link ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods operationId :: Lens' Link ( Maybe Text ) Source #
HasServer Link ( Maybe Server ) Source #
Instance details Defined in Data.OpenApi.Lens Methods server :: Lens' Link ( Maybe Server ) Source #
HasOperationRef Link ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods operationRef :: Lens' Link ( Maybe Text ) Source #
HasParameters Link ( InsOrdHashMap Text ExpressionOrValue ) Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' Link ( InsOrdHashMap Text ExpressionOrValue ) Source #
HasLinks Response ( InsOrdHashMap Text ( Referenced Link )) Source #
Instance details Defined in Data.OpenApi.Lens Methods links :: Lens' Response ( InsOrdHashMap Text ( Referenced Link )) Source #
ToJSON ( Referenced Link ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Link -> Value Source # toEncoding :: Referenced Link -> Encoding Source # toJSONList :: [ Referenced Link ] -> Value Source # toEncodingList :: [ Referenced Link ] -> Encoding Source #
FromJSON ( Referenced Link ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Link ) Source # parseJSONList :: Value -> Parser [ Referenced Link ] Source #
type Rep Link Source #
Instance details Defined in Data.OpenApi.Internal type Rep Link = D1 (' MetaData "Link" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' False ) ( C1 (' MetaCons "Link" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "_linkOperationRef") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Text )) :: ( S1 (' MetaSel (' Just "_linkOperationId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Text )) :: S1 (' MetaSel (' Just "_linkParameters") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( InsOrdHashMap Text ExpressionOrValue )))) :: ( S1 (' MetaSel (' Just "_linkRequestBody") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe ExpressionOrValue )) :: ( S1 (' MetaSel (' Just "_linkDescription") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Text )) :*: S1 (' MetaSel (' Just "_linkServer") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Server ))))))
type Code Link Source #
Instance details Defined in Data.OpenApi.Internal type Code Link = '['[ Maybe Text , Maybe Text , InsOrdHashMap Text ExpressionOrValue , Maybe ExpressionOrValue , Maybe Text , Maybe Server ]]
type DatatypeInfoOf Link Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Link = ' ADT "Data.OpenApi.Internal" "Link" '[' Record "Link" '[' FieldInfo "_linkOperationRef", ' FieldInfo "_linkOperationId", ' FieldInfo "_linkParameters", ' FieldInfo "_linkRequestBody", ' FieldInfo "_linkDescription", ' FieldInfo "_linkServer"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

newtype Callback 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.

Constructors

Callback ( InsOrdHashMap Text PathItem )

Instances

Instances details

Eq Callback Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Callback -> Callback -> Bool Source # (/=) :: Callback -> Callback -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Callback Source # toConstr :: Callback -> Constr Source # dataTypeOf :: Callback -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Callback ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Callback ) Source # gmapT :: ( forall b. Data b => b -> b) -> Callback -> Callback Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Callback -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Callback -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Callback -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Callback -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Callback -> m Callback Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Callback -> m Callback Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Callback -> m Callback Source #
Show Callback Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Callback -> ShowS Source # show :: Callback -> String Source # showList :: [ Callback ] -> ShowS Source #
Generic Callback Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Callback :: Type -> Type Source # Methods from :: Callback -> Rep Callback x Source # to :: Rep Callback x -> Callback Source #
ToJSON Callback Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Callback -> Value Source # toEncoding :: Callback -> Encoding Source # toJSONList :: [ Callback ] -> Value Source # toEncodingList :: [ Callback ] -> Encoding Source #
FromJSON Callback Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Callback Source # parseJSONList :: Value -> Parser [ Callback ] Source #
HasCallbacks Components ( Definitions Callback ) Source #
Instance details Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Components ( Definitions Callback ) Source #
HasCallbacks Operation ( InsOrdHashMap Text ( Referenced Callback )) Source #
Instance details Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation ( InsOrdHashMap Text ( Referenced Callback )) Source #
ToJSON ( Referenced Callback ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Callback -> Value Source # toEncoding :: Referenced Callback -> Encoding Source # toJSONList :: [ Referenced Callback ] -> Value Source # toEncodingList :: [ Referenced Callback ] -> Encoding Source #
FromJSON ( Referenced Callback ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Callback ) Source # parseJSONList :: Value -> Parser [ Referenced Callback ] Source #
type Rep Callback Source #
Instance details Defined in Data.OpenApi.Internal type Rep Callback = D1 (' MetaData "Callback" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 _securitySchemeType :: SecuritySchemeType The type of the security scheme. _securitySchemeDescription :: Maybe Text A short description for security scheme.

Instances

Instances details

Eq SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: SecurityScheme -> SecurityScheme -> Bool Source # (/=) :: SecurityScheme -> SecurityScheme -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c SecurityScheme Source # toConstr :: SecurityScheme -> Constr Source # dataTypeOf :: SecurityScheme -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c SecurityScheme ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c SecurityScheme ) Source # gmapT :: ( forall b. Data b => b -> b) -> SecurityScheme -> SecurityScheme Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> SecurityScheme -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> SecurityScheme -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> SecurityScheme -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> SecurityScheme -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> SecurityScheme -> m SecurityScheme Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecurityScheme -> m SecurityScheme Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecurityScheme -> m SecurityScheme Source #
Show SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecurityScheme -> ShowS Source # show :: SecurityScheme -> String Source # showList :: [ SecurityScheme ] -> ShowS Source #
Generic SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep SecurityScheme :: Type -> Type Source # Methods from :: SecurityScheme -> Rep SecurityScheme x Source # to :: Rep SecurityScheme x -> SecurityScheme Source #
Semigroup SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: SecurityScheme -> SecurityScheme -> SecurityScheme Source # sconcat :: NonEmpty SecurityScheme -> SecurityScheme Source # stimes :: Integral b => b -> SecurityScheme -> SecurityScheme Source #
ToJSON SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: SecurityScheme -> Value Source # toEncoding :: SecurityScheme -> Encoding Source # toJSONList :: [ SecurityScheme ] -> Value Source # toEncodingList :: [ SecurityScheme ] -> Encoding Source #
FromJSON SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecurityScheme Source # parseJSONList :: Value -> Parser [ SecurityScheme ] Source #
Generic SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code SecurityScheme :: [[ Type ]] Source # Methods from :: SecurityScheme -> Rep SecurityScheme Source # to :: Rep SecurityScheme -> SecurityScheme Source #
HasDatatypeInfo SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf SecurityScheme :: DatatypeInfo Source # Methods datatypeInfo :: proxy SecurityScheme -> DatatypeInfo ( Code SecurityScheme ) Source #
HasSwaggerAesonOptions SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy SecurityScheme -> SwaggerAesonOptions Source # aesonDefaults :: Proxy SecurityScheme -> POP Maybe ( Code SecurityScheme ) Source #
HasType SecurityScheme SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Lens Methods type_ :: Lens' SecurityScheme SecuritySchemeType Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k SecurityScheme SecurityScheme a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b Source #
(k ~ A_Lens , a ~ SecuritySchemeType , b ~ SecuritySchemeType ) => LabelOptic "type" k SecurityScheme SecurityScheme a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecurityScheme SecurityScheme a b Source #
HasDescription SecurityScheme ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' SecurityScheme ( Maybe Text ) Source #
type Rep SecurityScheme Source #
Instance details Defined in Data.OpenApi.Internal type Rep SecurityScheme = D1 (' MetaData "SecurityScheme" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code SecurityScheme = '['[ SecuritySchemeType , Maybe Text ]]
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"
}

Constructors

SecuritySchemeHttp HttpSchemeType
SecuritySchemeApiKey ApiKeyParams
SecuritySchemeOAuth2 OAuth2Flows
SecuritySchemeOpenIdConnect URL

Instances

Instances details

Eq SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: SecuritySchemeType -> SecuritySchemeType -> Bool Source # (/=) :: SecuritySchemeType -> SecuritySchemeType -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c SecuritySchemeType Source # toConstr :: SecuritySchemeType -> Constr Source # dataTypeOf :: SecuritySchemeType -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c SecuritySchemeType ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c SecuritySchemeType ) Source # gmapT :: ( forall b. Data b => b -> b) -> SecuritySchemeType -> SecuritySchemeType Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> SecuritySchemeType -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> SecuritySchemeType -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> SecuritySchemeType -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> SecuritySchemeType -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> SecuritySchemeType -> m SecuritySchemeType Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecuritySchemeType -> m SecuritySchemeType Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecuritySchemeType -> m SecuritySchemeType Source #
Show SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecuritySchemeType -> ShowS Source # show :: SecuritySchemeType -> String Source # showList :: [ SecuritySchemeType ] -> ShowS Source #
Generic SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep SecuritySchemeType :: Type -> Type Source # Methods from :: SecuritySchemeType -> Rep SecuritySchemeType x Source # to :: Rep SecuritySchemeType x -> SecuritySchemeType Source #
ToJSON SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: SecuritySchemeType -> Value Source # toEncoding :: SecuritySchemeType -> Encoding Source # toJSONList :: [ SecuritySchemeType ] -> Value Source # toEncodingList :: [ SecuritySchemeType ] -> Encoding Source #
FromJSON SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecuritySchemeType Source # parseJSONList :: Value -> Parser [ SecuritySchemeType ] Source #
AesonDefaultValue SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe SecuritySchemeType Source #
HasType SecurityScheme SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Lens Methods type_ :: Lens' SecurityScheme SecuritySchemeType Source #
(k ~ A_Prism , a ~ ApiKeyParams , b ~ ApiKeyParams ) => LabelOptic "_SecuritySchemeApiKey" k SecuritySchemeType SecuritySchemeType a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b Source #
(k ~ A_Prism , a ~ HttpSchemeType , b ~ HttpSchemeType ) => LabelOptic "_SecuritySchemeHttp" k SecuritySchemeType SecuritySchemeType a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b Source #
(k ~ A_Prism , a ~ OAuth2Flows , b ~ OAuth2Flows ) => LabelOptic "_SecuritySchemeOAuth2" k SecuritySchemeType SecuritySchemeType a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b Source #
(k ~ A_Prism , a ~ URL , b ~ URL ) => LabelOptic "_SecuritySchemeOpenIdConnect" k SecuritySchemeType SecuritySchemeType a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx SecuritySchemeType SecuritySchemeType a b Source #
type Rep SecuritySchemeType Source #
Instance details Defined in Data.OpenApi.Internal type Rep SecuritySchemeType = D1 (' MetaData "SecuritySchemeType" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 #

Constructors

HttpSchemeBearer ( Maybe BearerFormat )
HttpSchemeBasic
HttpSchemeCustom Text

Instances

Instances details

Eq HttpSchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: HttpSchemeType -> HttpSchemeType -> Bool Source # (/=) :: HttpSchemeType -> HttpSchemeType -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c HttpSchemeType Source # toConstr :: HttpSchemeType -> Constr Source # dataTypeOf :: HttpSchemeType -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c HttpSchemeType ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c HttpSchemeType ) Source # gmapT :: ( forall b. Data b => b -> b) -> HttpSchemeType -> HttpSchemeType Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> HttpSchemeType -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> HttpSchemeType -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> HttpSchemeType -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> HttpSchemeType -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> HttpSchemeType -> m HttpSchemeType Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> HttpSchemeType -> m HttpSchemeType Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> HttpSchemeType -> m HttpSchemeType Source #
Show HttpSchemeType Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> HttpSchemeType -> ShowS Source # show :: HttpSchemeType -> String Source # showList :: [ HttpSchemeType ] -> ShowS Source #
Generic HttpSchemeType Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep HttpSchemeType :: Type -> Type Source # Methods from :: HttpSchemeType -> Rep HttpSchemeType x Source # to :: Rep HttpSchemeType x -> HttpSchemeType Source #
type Rep HttpSchemeType Source #
Instance details Defined in Data.OpenApi.Internal type Rep HttpSchemeType = D1 (' MetaData "HttpSchemeType" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 #

Constructors

SecurityDefinitions ( Definitions SecurityScheme )

Instances

Instances details

Eq SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: SecurityDefinitions -> SecurityDefinitions -> Bool Source # (/=) :: SecurityDefinitions -> SecurityDefinitions -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c SecurityDefinitions Source # toConstr :: SecurityDefinitions -> Constr Source # dataTypeOf :: SecurityDefinitions -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c SecurityDefinitions ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c SecurityDefinitions ) Source # gmapT :: ( forall b. Data b => b -> b) -> SecurityDefinitions -> SecurityDefinitions Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> SecurityDefinitions -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> SecurityDefinitions -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> SecurityDefinitions -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> SecurityDefinitions -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> SecurityDefinitions -> m SecurityDefinitions Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecurityDefinitions -> m SecurityDefinitions Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecurityDefinitions -> m SecurityDefinitions Source #
Show SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecurityDefinitions -> ShowS Source # show :: SecurityDefinitions -> String Source # showList :: [ SecurityDefinitions ] -> ShowS Source #
Generic SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep SecurityDefinitions :: Type -> Type Source # Methods from :: SecurityDefinitions -> Rep SecurityDefinitions x Source # to :: Rep SecurityDefinitions x -> SecurityDefinitions Source #
Semigroup SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions Source # sconcat :: NonEmpty SecurityDefinitions -> SecurityDefinitions Source # stimes :: Integral b => b -> SecurityDefinitions -> SecurityDefinitions Source #
Monoid SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: SecurityDefinitions Source # mappend :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions Source # mconcat :: [ SecurityDefinitions ] -> SecurityDefinitions Source #
ToJSON SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: SecurityDefinitions -> Value Source # toEncoding :: SecurityDefinitions -> Encoding Source # toJSONList :: [ SecurityDefinitions ] -> Value Source # toEncodingList :: [ SecurityDefinitions ] -> Encoding Source #
FromJSON SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecurityDefinitions Source # parseJSONList :: Value -> Parser [ SecurityDefinitions ] Source #
AesonDefaultValue SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe SecurityDefinitions Source #
SwaggerMonoid SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: SecurityDefinitions Source # swaggerMappend :: SecurityDefinitions -> SecurityDefinitions -> SecurityDefinitions Source #
HasSecuritySchemes Components SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Lens Methods securitySchemes :: Lens' Components SecurityDefinitions Source #
type Rep SecurityDefinitions Source #
Instance details Defined in Data.OpenApi.Internal type Rep SecurityDefinitions = D1 (' MetaData "SecurityDefinitions" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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).

Constructors

SecurityRequirement
Fields getSecurityRequirement :: InsOrdHashMap Text [ Text ]

Instances

Instances details

Eq SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: SecurityRequirement -> SecurityRequirement -> Bool Source # (/=) :: SecurityRequirement -> SecurityRequirement -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c SecurityRequirement Source # toConstr :: SecurityRequirement -> Constr Source # dataTypeOf :: SecurityRequirement -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c SecurityRequirement ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c SecurityRequirement ) Source # gmapT :: ( forall b. Data b => b -> b) -> SecurityRequirement -> SecurityRequirement Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> SecurityRequirement -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> SecurityRequirement -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> SecurityRequirement -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> SecurityRequirement -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> SecurityRequirement -> m SecurityRequirement Source #
Read SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods readsPrec :: Int -> ReadS SecurityRequirement Source # readList :: ReadS [ SecurityRequirement ] Source # readPrec :: ReadPrec SecurityRequirement Source # readListPrec :: ReadPrec [ SecurityRequirement ] Source #
Show SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> SecurityRequirement -> ShowS Source # show :: SecurityRequirement -> String Source # showList :: [ SecurityRequirement ] -> ShowS Source #
Semigroup SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement Source # sconcat :: NonEmpty SecurityRequirement -> SecurityRequirement Source # stimes :: Integral b => b -> SecurityRequirement -> SecurityRequirement Source #
Monoid SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: SecurityRequirement Source # mappend :: SecurityRequirement -> SecurityRequirement -> SecurityRequirement Source # mconcat :: [ SecurityRequirement ] -> SecurityRequirement Source #
ToJSON SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: SecurityRequirement -> Value Source # toEncoding :: SecurityRequirement -> Encoding Source # toJSONList :: [ SecurityRequirement ] -> Value Source # toEncodingList :: [ SecurityRequirement ] -> Encoding Source #
FromJSON SecurityRequirement Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser SecurityRequirement Source # parseJSONList :: Value -> Parser [ SecurityRequirement ] Source #
HasSecurity Operation [ SecurityRequirement ] Source #
Instance details Defined in Data.OpenApi.Lens Methods security :: Lens' Operation [ SecurityRequirement ] Source #
HasSecurity OpenApi [ SecurityRequirement ] Source #
Instance details Defined in Data.OpenApi.Lens Methods security :: Lens' OpenApi [ SecurityRequirement ] Source #

API key

data ApiKeyParams Source #

Constructors

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

Instances

Instances details

Eq ApiKeyParams Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: ApiKeyParams -> ApiKeyParams -> Bool Source # (/=) :: ApiKeyParams -> ApiKeyParams -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ApiKeyParams Source # toConstr :: ApiKeyParams -> Constr Source # dataTypeOf :: ApiKeyParams -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ApiKeyParams ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ApiKeyParams ) Source # gmapT :: ( forall b. Data b => b -> b) -> ApiKeyParams -> ApiKeyParams Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ApiKeyParams -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ApiKeyParams -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ApiKeyParams -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ApiKeyParams -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ApiKeyParams -> m ApiKeyParams Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ApiKeyParams -> m ApiKeyParams Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ApiKeyParams -> m ApiKeyParams Source #
Show ApiKeyParams Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ApiKeyParams -> ShowS Source # show :: ApiKeyParams -> String Source # showList :: [ ApiKeyParams ] -> ShowS Source #
Generic ApiKeyParams Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep ApiKeyParams :: Type -> Type Source # Methods from :: ApiKeyParams -> Rep ApiKeyParams x Source # to :: Rep ApiKeyParams x -> ApiKeyParams Source #
ToJSON ApiKeyParams Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: ApiKeyParams -> Value Source # toEncoding :: ApiKeyParams -> Encoding Source # toJSONList :: [ ApiKeyParams ] -> Value Source # toEncodingList :: [ ApiKeyParams ] -> Encoding Source #
FromJSON ApiKeyParams Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ApiKeyParams Source # parseJSONList :: Value -> Parser [ ApiKeyParams ] Source #
type Rep ApiKeyParams Source #
Instance details Defined in Data.OpenApi.Internal type Rep ApiKeyParams = D1 (' MetaData "ApiKeyParams" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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.

Constructors

ApiKeyQuery
ApiKeyHeader
ApiKeyCookie

Instances

Instances details

Eq ApiKeyLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: ApiKeyLocation -> ApiKeyLocation -> Bool Source # (/=) :: ApiKeyLocation -> ApiKeyLocation -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ApiKeyLocation Source # toConstr :: ApiKeyLocation -> Constr Source # dataTypeOf :: ApiKeyLocation -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ApiKeyLocation ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ApiKeyLocation ) Source # gmapT :: ( forall b. Data b => b -> b) -> ApiKeyLocation -> ApiKeyLocation Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ApiKeyLocation -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ApiKeyLocation -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ApiKeyLocation -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ApiKeyLocation -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ApiKeyLocation -> m ApiKeyLocation Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ApiKeyLocation -> m ApiKeyLocation Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ApiKeyLocation -> m ApiKeyLocation Source #
Show ApiKeyLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ApiKeyLocation -> ShowS Source # show :: ApiKeyLocation -> String Source # showList :: [ ApiKeyLocation ] -> ShowS Source #
Generic ApiKeyLocation Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep ApiKeyLocation :: Type -> Type Source # Methods from :: ApiKeyLocation -> Rep ApiKeyLocation x Source # to :: Rep ApiKeyLocation x -> ApiKeyLocation Source #
ToJSON ApiKeyLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: ApiKeyLocation -> Value Source # toEncoding :: ApiKeyLocation -> Encoding Source # toJSONList :: [ ApiKeyLocation ] -> Value Source # toEncodingList :: [ ApiKeyLocation ] -> Encoding Source #
FromJSON ApiKeyLocation Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ApiKeyLocation Source # parseJSONList :: Value -> Parser [ ApiKeyLocation ] Source #
type Rep ApiKeyLocation Source #
Instance details Defined in Data.OpenApi.Internal type Rep ApiKeyLocation = D1 (' MetaData "ApiKeyLocation" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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

_oAuth2FlowsImplicit :: Maybe ( OAuth2Flow OAuth2ImplicitFlow )

Configuration for the OAuth Implicit flow
_oAuth2FlowsPassword :: Maybe ( OAuth2Flow OAuth2PasswordFlow )

Configuration for the OAuth Resource Owner Password flow
_oAuth2FlowsClientCredentials :: Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )

Configuration for the OAuth Client Credentials flow
_oAuth2FlowsAuthorizationCode :: Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )

Configuration for the OAuth Authorization Code flow

Instances

Instances details

Eq OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OAuth2Flows -> OAuth2Flows -> Bool Source # (/=) :: OAuth2Flows -> OAuth2Flows -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OAuth2Flows Source # toConstr :: OAuth2Flows -> Constr Source # dataTypeOf :: OAuth2Flows -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OAuth2Flows ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OAuth2Flows ) Source # gmapT :: ( forall b. Data b => b -> b) -> OAuth2Flows -> OAuth2Flows Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2Flows -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2Flows -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OAuth2Flows -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OAuth2Flows -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OAuth2Flows -> m OAuth2Flows Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2Flows -> m OAuth2Flows Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2Flows -> m OAuth2Flows Source #
Show OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2Flows -> ShowS Source # show :: OAuth2Flows -> String Source # showList :: [ OAuth2Flows ] -> ShowS Source #
Generic OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OAuth2Flows :: Type -> Type Source # Methods from :: OAuth2Flows -> Rep OAuth2Flows x Source # to :: Rep OAuth2Flows x -> OAuth2Flows Source #
Semigroup OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: OAuth2Flows -> OAuth2Flows -> OAuth2Flows Source # sconcat :: NonEmpty OAuth2Flows -> OAuth2Flows Source # stimes :: Integral b => b -> OAuth2Flows -> OAuth2Flows Source #
Monoid OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: OAuth2Flows Source # mappend :: OAuth2Flows -> OAuth2Flows -> OAuth2Flows Source # mconcat :: [ OAuth2Flows ] -> OAuth2Flows Source #
ToJSON OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2Flows -> Value Source # toEncoding :: OAuth2Flows -> Encoding Source # toJSONList :: [ OAuth2Flows ] -> Value Source # toEncodingList :: [ OAuth2Flows ] -> Encoding Source #
FromJSON OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2Flows Source # parseJSONList :: Value -> Parser [ OAuth2Flows ] Source #
Generic OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code OAuth2Flows :: [[ Type ]] Source # Methods from :: OAuth2Flows -> Rep OAuth2Flows Source # to :: Rep OAuth2Flows -> OAuth2Flows Source #
HasDatatypeInfo OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf OAuth2Flows :: DatatypeInfo Source # Methods datatypeInfo :: proxy OAuth2Flows -> DatatypeInfo ( Code OAuth2Flows ) Source #
HasSwaggerAesonOptions OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy OAuth2Flows -> SwaggerAesonOptions Source # aesonDefaults :: Proxy OAuth2Flows -> POP Maybe ( Code OAuth2Flows ) Source #
(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 Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b Source #
(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 Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b Source #
(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 Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b Source #
(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 Methods labelOptic :: Optic k NoIx OAuth2Flows OAuth2Flows a b Source #
HasPassword OAuth2Flows ( Maybe ( OAuth2Flow OAuth2PasswordFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2PasswordFlow )) Source #
HasImplicit OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ImplicitFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ImplicitFlow )) Source #
HasClientCredentials OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods clientCredentials :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )) Source #
HasAuthorizationCode OAuth2Flows ( Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods authorizationCode :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )) Source #
type Rep OAuth2Flows Source #
Instance details Defined in Data.OpenApi.Internal type Rep OAuth2Flows = D1 (' MetaData "OAuth2Flows" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code OAuth2Flows = '['[ Maybe ( OAuth2Flow OAuth2ImplicitFlow ), Maybe ( OAuth2Flow OAuth2PasswordFlow ), Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow ), Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )]]
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 _oAuth2Params :: p _oAath2RefreshUrl :: Maybe URL The URL to be used for obtaining refresh tokens. _oAuth2Scopes :: InsOrdHashMap Text Text The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.

Instances

Instances details

HasPassword OAuth2Flows ( Maybe ( OAuth2Flow OAuth2PasswordFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2PasswordFlow )) Source #
HasImplicit OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ImplicitFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ImplicitFlow )) Source #
HasClientCredentials OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods clientCredentials :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )) Source #
HasAuthorizationCode OAuth2Flows ( Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods authorizationCode :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )) Source #
Eq p => Eq ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OAuth2Flow p -> OAuth2Flow p -> Bool Source # (/=) :: OAuth2Flow p -> OAuth2Flow p -> Bool Source #
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) Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ( OAuth2Flow p) Source # toConstr :: OAuth2Flow p -> Constr Source # dataTypeOf :: OAuth2Flow p -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ( OAuth2Flow p)) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ( OAuth2Flow p)) Source # gmapT :: ( forall b. Data b => b -> b) -> OAuth2Flow p -> OAuth2Flow p Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2Flow p -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2Flow p -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OAuth2Flow p -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OAuth2Flow p -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OAuth2Flow p -> m ( OAuth2Flow p) Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2Flow p -> m ( OAuth2Flow p) Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2Flow p -> m ( OAuth2Flow p) Source #
Show p => Show ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2Flow p -> ShowS Source # show :: OAuth2Flow p -> String Source # showList :: [ OAuth2Flow p] -> ShowS Source #
Generic ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep ( OAuth2Flow p) :: Type -> Type Source # Methods from :: OAuth2Flow p -> Rep ( OAuth2Flow p) x Source # to :: Rep ( OAuth2Flow p) x -> OAuth2Flow p Source #
Semigroup ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: OAuth2Flow p -> OAuth2Flow p -> OAuth2Flow p Source # sconcat :: NonEmpty ( OAuth2Flow p) -> OAuth2Flow p Source # stimes :: Integral b => b -> OAuth2Flow p -> OAuth2Flow p Source #
( Eq p, ToJSON p, AesonDefaultValue p) => ToJSON ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2Flow p -> Value Source # toEncoding :: OAuth2Flow p -> Encoding Source # toJSONList :: [ OAuth2Flow p] -> Value Source # toEncodingList :: [ OAuth2Flow p] -> Encoding Source #
( Eq p, FromJSON p, AesonDefaultValue p) => FromJSON ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( OAuth2Flow p) Source # parseJSONList :: Value -> Parser [ OAuth2Flow p] Source #
Generic ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code ( OAuth2Flow p) :: [[ Type ]] Source # Methods from :: OAuth2Flow p -> Rep ( OAuth2Flow p) Source # to :: Rep ( OAuth2Flow p) -> OAuth2Flow p Source #
HasDatatypeInfo ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf ( OAuth2Flow p) :: DatatypeInfo Source # Methods datatypeInfo :: proxy ( OAuth2Flow p) -> DatatypeInfo ( Code ( OAuth2Flow p)) Source #
AesonDefaultValue p => AesonDefaultValue ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe ( OAuth2Flow p) Source #
AesonDefaultValue p => HasSwaggerAesonOptions ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy ( OAuth2Flow p) -> SwaggerAesonOptions Source # aesonDefaults :: Proxy ( OAuth2Flow p) -> POP Maybe ( Code ( OAuth2Flow p)) Source #
type Rep ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal type Rep ( OAuth2Flow p) = D1 (' MetaData "OAuth2Flow" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 Code ( OAuth2Flow p) = '['[p, Maybe URL , InsOrdHashMap Text Text ]]
type DatatypeInfoOf ( OAuth2Flow p) Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf ( OAuth2Flow p) = ' ADT "Data.OpenApi.Internal" "OAuth2Flow" '[' Record "OAuth2Flow" '[' FieldInfo "_oAuth2Params", ' FieldInfo "_oAath2RefreshUrl", ' FieldInfo "_oAuth2Scopes"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

newtype OAuth2ImplicitFlow Source #

Constructors

OAuth2ImplicitFlow
Fields _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL

Instances

Instances details

Eq OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OAuth2ImplicitFlow -> OAuth2ImplicitFlow -> Bool Source # (/=) :: OAuth2ImplicitFlow -> OAuth2ImplicitFlow -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OAuth2ImplicitFlow Source # toConstr :: OAuth2ImplicitFlow -> Constr Source # dataTypeOf :: OAuth2ImplicitFlow -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OAuth2ImplicitFlow ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OAuth2ImplicitFlow ) Source # gmapT :: ( forall b. Data b => b -> b) -> OAuth2ImplicitFlow -> OAuth2ImplicitFlow Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2ImplicitFlow -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2ImplicitFlow -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OAuth2ImplicitFlow -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OAuth2ImplicitFlow -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OAuth2ImplicitFlow -> m OAuth2ImplicitFlow Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2ImplicitFlow -> m OAuth2ImplicitFlow Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2ImplicitFlow -> m OAuth2ImplicitFlow Source #
Show OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2ImplicitFlow -> ShowS Source # show :: OAuth2ImplicitFlow -> String Source # showList :: [ OAuth2ImplicitFlow ] -> ShowS Source #
Generic OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OAuth2ImplicitFlow :: Type -> Type Source # Methods from :: OAuth2ImplicitFlow -> Rep OAuth2ImplicitFlow x Source # to :: Rep OAuth2ImplicitFlow x -> OAuth2ImplicitFlow Source #
ToJSON OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2ImplicitFlow -> Value Source # toEncoding :: OAuth2ImplicitFlow -> Encoding Source # toJSONList :: [ OAuth2ImplicitFlow ] -> Value Source # toEncodingList :: [ OAuth2ImplicitFlow ] -> Encoding Source #
FromJSON OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2ImplicitFlow Source # parseJSONList :: Value -> Parser [ OAuth2ImplicitFlow ] Source #
AesonDefaultValue OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2ImplicitFlow Source #
HasAuthorizationUrl OAuth2ImplicitFlow AuthorizationURL Source #
Instance details Defined in Data.OpenApi.Lens Methods authorizationUrl :: Lens' OAuth2ImplicitFlow AuthorizationURL Source #
(k ~ An_Iso , a ~ AuthorizationURL , b ~ AuthorizationURL ) => LabelOptic "authorizationUrl" k OAuth2ImplicitFlow OAuth2ImplicitFlow a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2ImplicitFlow OAuth2ImplicitFlow a b Source #
HasImplicit OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ImplicitFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ImplicitFlow )) Source #
type Rep OAuth2ImplicitFlow Source #
Instance details Defined in Data.OpenApi.Internal type Rep OAuth2ImplicitFlow = D1 (' MetaData "OAuth2ImplicitFlow" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' True ) ( C1 (' MetaCons "OAuth2ImplicitFlow" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "_oAuth2ImplicitFlowAuthorizationUrl") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 AuthorizationURL )))

newtype OAuth2PasswordFlow Source #

Constructors

OAuth2PasswordFlow
Fields _oAuth2PasswordFlowTokenUrl :: TokenURL

Instances

Instances details

Eq OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OAuth2PasswordFlow -> OAuth2PasswordFlow -> Bool Source # (/=) :: OAuth2PasswordFlow -> OAuth2PasswordFlow -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OAuth2PasswordFlow Source # toConstr :: OAuth2PasswordFlow -> Constr Source # dataTypeOf :: OAuth2PasswordFlow -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OAuth2PasswordFlow ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OAuth2PasswordFlow ) Source # gmapT :: ( forall b. Data b => b -> b) -> OAuth2PasswordFlow -> OAuth2PasswordFlow Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2PasswordFlow -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2PasswordFlow -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OAuth2PasswordFlow -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OAuth2PasswordFlow -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OAuth2PasswordFlow -> m OAuth2PasswordFlow Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2PasswordFlow -> m OAuth2PasswordFlow Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2PasswordFlow -> m OAuth2PasswordFlow Source #
Show OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2PasswordFlow -> ShowS Source # show :: OAuth2PasswordFlow -> String Source # showList :: [ OAuth2PasswordFlow ] -> ShowS Source #
Generic OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OAuth2PasswordFlow :: Type -> Type Source # Methods from :: OAuth2PasswordFlow -> Rep OAuth2PasswordFlow x Source # to :: Rep OAuth2PasswordFlow x -> OAuth2PasswordFlow Source #
ToJSON OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2PasswordFlow -> Value Source # toEncoding :: OAuth2PasswordFlow -> Encoding Source # toJSONList :: [ OAuth2PasswordFlow ] -> Value Source # toEncodingList :: [ OAuth2PasswordFlow ] -> Encoding Source #
FromJSON OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2PasswordFlow Source # parseJSONList :: Value -> Parser [ OAuth2PasswordFlow ] Source #
AesonDefaultValue OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2PasswordFlow Source #
HasTokenUrl OAuth2PasswordFlow TokenURL Source #
Instance details Defined in Data.OpenApi.Lens Methods tokenUrl :: Lens' OAuth2PasswordFlow TokenURL Source #
(k ~ An_Iso , a ~ TokenURL , b ~ TokenURL ) => LabelOptic "tokenUrl" k OAuth2PasswordFlow OAuth2PasswordFlow a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2PasswordFlow OAuth2PasswordFlow a b Source #
HasPassword OAuth2Flows ( Maybe ( OAuth2Flow OAuth2PasswordFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2PasswordFlow )) Source #
type Rep OAuth2PasswordFlow Source #
Instance details Defined in Data.OpenApi.Internal type Rep OAuth2PasswordFlow = D1 (' MetaData "OAuth2PasswordFlow" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' True ) ( C1 (' MetaCons "OAuth2PasswordFlow" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "_oAuth2PasswordFlowTokenUrl") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TokenURL )))

newtype OAuth2ClientCredentialsFlow Source #

Constructors

OAuth2ClientCredentialsFlow
Fields _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL

Instances

Instances details

Eq OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow -> Bool Source # (/=) :: OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OAuth2ClientCredentialsFlow Source # toConstr :: OAuth2ClientCredentialsFlow -> Constr Source # dataTypeOf :: OAuth2ClientCredentialsFlow -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OAuth2ClientCredentialsFlow ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OAuth2ClientCredentialsFlow ) Source # gmapT :: ( forall b. Data b => b -> b) -> OAuth2ClientCredentialsFlow -> OAuth2ClientCredentialsFlow Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2ClientCredentialsFlow -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2ClientCredentialsFlow -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OAuth2ClientCredentialsFlow -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OAuth2ClientCredentialsFlow -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OAuth2ClientCredentialsFlow -> m OAuth2ClientCredentialsFlow Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2ClientCredentialsFlow -> m OAuth2ClientCredentialsFlow Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2ClientCredentialsFlow -> m OAuth2ClientCredentialsFlow Source #
Show OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2ClientCredentialsFlow -> ShowS Source # show :: OAuth2ClientCredentialsFlow -> String Source # showList :: [ OAuth2ClientCredentialsFlow ] -> ShowS Source #
Generic OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OAuth2ClientCredentialsFlow :: Type -> Type Source # Methods from :: OAuth2ClientCredentialsFlow -> Rep OAuth2ClientCredentialsFlow x Source # to :: Rep OAuth2ClientCredentialsFlow x -> OAuth2ClientCredentialsFlow Source #
ToJSON OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2ClientCredentialsFlow -> Value Source # toEncoding :: OAuth2ClientCredentialsFlow -> Encoding Source # toJSONList :: [ OAuth2ClientCredentialsFlow ] -> Value Source # toEncodingList :: [ OAuth2ClientCredentialsFlow ] -> Encoding Source #
FromJSON OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2ClientCredentialsFlow Source # parseJSONList :: Value -> Parser [ OAuth2ClientCredentialsFlow ] Source #
AesonDefaultValue OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2ClientCredentialsFlow Source #
HasTokenUrl OAuth2ClientCredentialsFlow TokenURL Source #
Instance details Defined in Data.OpenApi.Lens Methods tokenUrl :: Lens' OAuth2ClientCredentialsFlow TokenURL Source #
(k ~ An_Iso , a ~ TokenURL , b ~ TokenURL ) => LabelOptic "tokenUrl" k OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2ClientCredentialsFlow OAuth2ClientCredentialsFlow a b Source #
HasClientCredentials OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods clientCredentials :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2ClientCredentialsFlow )) Source #
type Rep OAuth2ClientCredentialsFlow Source #
Instance details Defined in Data.OpenApi.Internal type Rep OAuth2ClientCredentialsFlow = D1 (' MetaData "OAuth2ClientCredentialsFlow" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' True ) ( C1 (' MetaCons "OAuth2ClientCredentialsFlow" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "_oAuth2ClientCredentialsFlowTokenUrl") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 TokenURL )))

data OAuth2AuthorizationCodeFlow Source #

Constructors

OAuth2AuthorizationCodeFlow
Fields _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL _oAuth2AuthorizationCodeFlowTokenUrl :: TokenURL

Instances

Instances details

Eq OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow -> Bool Source # (/=) :: OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c OAuth2AuthorizationCodeFlow Source # toConstr :: OAuth2AuthorizationCodeFlow -> Constr Source # dataTypeOf :: OAuth2AuthorizationCodeFlow -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c OAuth2AuthorizationCodeFlow ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c OAuth2AuthorizationCodeFlow ) Source # gmapT :: ( forall b. Data b => b -> b) -> OAuth2AuthorizationCodeFlow -> OAuth2AuthorizationCodeFlow Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2AuthorizationCodeFlow -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> OAuth2AuthorizationCodeFlow -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> OAuth2AuthorizationCodeFlow -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> OAuth2AuthorizationCodeFlow -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> OAuth2AuthorizationCodeFlow -> m OAuth2AuthorizationCodeFlow Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2AuthorizationCodeFlow -> m OAuth2AuthorizationCodeFlow Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> OAuth2AuthorizationCodeFlow -> m OAuth2AuthorizationCodeFlow Source #
Show OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> OAuth2AuthorizationCodeFlow -> ShowS Source # show :: OAuth2AuthorizationCodeFlow -> String Source # showList :: [ OAuth2AuthorizationCodeFlow ] -> ShowS Source #
Generic OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep OAuth2AuthorizationCodeFlow :: Type -> Type Source # Methods from :: OAuth2AuthorizationCodeFlow -> Rep OAuth2AuthorizationCodeFlow x Source # to :: Rep OAuth2AuthorizationCodeFlow x -> OAuth2AuthorizationCodeFlow Source #
ToJSON OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: OAuth2AuthorizationCodeFlow -> Value Source # toEncoding :: OAuth2AuthorizationCodeFlow -> Encoding Source # toJSONList :: [ OAuth2AuthorizationCodeFlow ] -> Value Source # toEncodingList :: [ OAuth2AuthorizationCodeFlow ] -> Encoding Source #
FromJSON OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser OAuth2AuthorizationCodeFlow Source # parseJSONList :: Value -> Parser [ OAuth2AuthorizationCodeFlow ] Source #
AesonDefaultValue OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe OAuth2AuthorizationCodeFlow Source #
HasAuthorizationUrl OAuth2AuthorizationCodeFlow AuthorizationURL Source #
Instance details Defined in Data.OpenApi.Lens Methods authorizationUrl :: Lens' OAuth2AuthorizationCodeFlow AuthorizationURL Source #
HasTokenUrl OAuth2AuthorizationCodeFlow TokenURL Source #
Instance details Defined in Data.OpenApi.Lens Methods tokenUrl :: Lens' OAuth2AuthorizationCodeFlow TokenURL Source #
(k ~ A_Lens , a ~ AuthorizationURL , b ~ AuthorizationURL ) => LabelOptic "authorizationUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source #
(k ~ A_Lens , a ~ TokenURL , b ~ TokenURL ) => LabelOptic "tokenUrl" k OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx OAuth2AuthorizationCodeFlow OAuth2AuthorizationCodeFlow a b Source #
HasAuthorizationCode OAuth2Flows ( Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )) Source #
Instance details Defined in Data.OpenApi.Lens Methods authorizationCode :: Lens' OAuth2Flows ( Maybe ( OAuth2Flow OAuth2AuthorizationCodeFlow )) Source #
type Rep OAuth2AuthorizationCodeFlow Source #
Instance details Defined in Data.OpenApi.Internal type Rep OAuth2AuthorizationCodeFlow = D1 (' MetaData "OAuth2AuthorizationCodeFlow" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 _externalDocsDescription :: Maybe Text A short description of the target documentation. CommonMark syntax MAY be used for rich text representation. _externalDocsUrl :: URL The URL for the target documentation.

Instances

Instances details

Eq ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: ExternalDocs -> ExternalDocs -> Bool Source # (/=) :: ExternalDocs -> ExternalDocs -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ExternalDocs Source # toConstr :: ExternalDocs -> Constr Source # dataTypeOf :: ExternalDocs -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ExternalDocs ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ExternalDocs ) Source # gmapT :: ( forall b. Data b => b -> b) -> ExternalDocs -> ExternalDocs Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ExternalDocs -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ExternalDocs -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> ExternalDocs -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> ExternalDocs -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ExternalDocs -> m ExternalDocs Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ExternalDocs -> m ExternalDocs Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ExternalDocs -> m ExternalDocs Source #
Ord ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods compare :: ExternalDocs -> ExternalDocs -> Ordering Source # (<) :: ExternalDocs -> ExternalDocs -> Bool Source # (<=) :: ExternalDocs -> ExternalDocs -> Bool Source # (>) :: ExternalDocs -> ExternalDocs -> Bool Source # (>=) :: ExternalDocs -> ExternalDocs -> Bool Source # max :: ExternalDocs -> ExternalDocs -> ExternalDocs Source # min :: ExternalDocs -> ExternalDocs -> ExternalDocs Source #
Show ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> ExternalDocs -> ShowS Source # show :: ExternalDocs -> String Source # showList :: [ ExternalDocs ] -> ShowS Source #
Generic ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep ExternalDocs :: Type -> Type Source # Methods from :: ExternalDocs -> Rep ExternalDocs x Source # to :: Rep ExternalDocs x -> ExternalDocs Source #
Semigroup ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: ExternalDocs -> ExternalDocs -> ExternalDocs Source # sconcat :: NonEmpty ExternalDocs -> ExternalDocs Source # stimes :: Integral b => b -> ExternalDocs -> ExternalDocs Source #
Monoid ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: ExternalDocs Source # mappend :: ExternalDocs -> ExternalDocs -> ExternalDocs Source # mconcat :: [ ExternalDocs ] -> ExternalDocs Source #
Hashable ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods hashWithSalt :: Int -> ExternalDocs -> Int Source # hash :: ExternalDocs -> Int Source #
ToJSON ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: ExternalDocs -> Value Source # toEncoding :: ExternalDocs -> Encoding Source # toJSONList :: [ ExternalDocs ] -> Value Source # toEncodingList :: [ ExternalDocs ] -> Encoding Source #
FromJSON ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ExternalDocs Source # parseJSONList :: Value -> Parser [ ExternalDocs ] Source #
SwaggerMonoid ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: ExternalDocs Source # swaggerMappend :: ExternalDocs -> ExternalDocs -> ExternalDocs Source #
HasUrl ExternalDocs URL Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' ExternalDocs URL Source #
(k ~ A_Lens , a ~ Maybe Text , b ~ Maybe Text ) => LabelOptic "description" k ExternalDocs ExternalDocs a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b Source #
(k ~ A_Lens , a ~ URL , b ~ URL ) => LabelOptic "url" k ExternalDocs ExternalDocs a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx ExternalDocs ExternalDocs a b Source #
HasExternalDocs Tag ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Tag ( Maybe ExternalDocs ) Source #
HasExternalDocs Schema ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Schema ( Maybe ExternalDocs ) Source #
HasExternalDocs Operation ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Operation ( Maybe ExternalDocs ) Source #
HasExternalDocs OpenApi ( Maybe ExternalDocs ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' OpenApi ( Maybe ExternalDocs ) Source #
HasDescription ExternalDocs ( Maybe Text ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' ExternalDocs ( Maybe Text ) Source #
type Rep ExternalDocs Source #
Instance details Defined in Data.OpenApi.Internal type Rep ExternalDocs = D1 (' MetaData "ExternalDocs" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' 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 getReference :: Text

Instances

Instances details

Eq Reference Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Reference -> Reference -> Bool Source # (/=) :: Reference -> Reference -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Reference Source # toConstr :: Reference -> Constr Source # dataTypeOf :: Reference -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Reference ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Reference ) Source # gmapT :: ( forall b. Data b => b -> b) -> Reference -> Reference Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Reference -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Reference -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Reference -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Reference -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Reference -> m Reference Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Reference -> m Reference Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Reference -> m Reference Source #
Show Reference Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Reference -> ShowS Source # show :: Reference -> String Source # showList :: [ Reference ] -> ShowS Source #
ToJSON Reference Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Reference -> Value Source # toEncoding :: Reference -> Encoding Source # toJSONList :: [ Reference ] -> Value Source # toEncodingList :: [ Reference ] -> Encoding Source #
FromJSON Reference Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Reference Source # parseJSONList :: Value -> Parser [ Reference ] Source #

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 Source # (<$) :: a -> Referenced b -> Referenced a Source #
(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 Source #
(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 Source #
HasParameters Operation [ Referenced Param ] Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' Operation [ Referenced Param ] Source #
HasParameters PathItem [ Referenced Param ] Source #
Instance details Defined in Data.OpenApi.Lens Methods parameters :: Lens' PathItem [ Referenced Param ] Source #
HasSchema Header ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' Header ( Maybe ( Referenced Schema )) Source #
HasSchema Param ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' Param ( Maybe ( Referenced Schema )) Source #
HasSchema MediaTypeObject ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject ( Maybe ( Referenced Schema )) Source #
HasRequestBody Operation ( Maybe ( Referenced RequestBody )) Source #
Instance details Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation ( Maybe ( Referenced RequestBody )) Source #
HasOneOf Schema ( Maybe [ Referenced Schema ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods oneOf :: Lens' Schema ( Maybe [ Referenced Schema ]) Source #
HasNot Schema ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods not_ :: Lens' Schema ( Maybe ( Referenced Schema )) Source #
HasDefault Responses ( Maybe ( Referenced Response )) Source #
Instance details Defined in Data.OpenApi.Lens Methods default_ :: Lens' Responses ( Maybe ( Referenced Response )) Source #
HasAnyOf Schema ( Maybe [ Referenced Schema ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods anyOf :: Lens' Schema ( Maybe [ Referenced Schema ]) Source #
HasAllOf Schema ( Maybe [ Referenced Schema ]) Source #
Instance details Defined in Data.OpenApi.Lens Methods allOf :: Lens' Schema ( Maybe [ Referenced Schema ]) Source #
HasResponses Responses ( InsOrdHashMap HttpStatusCode ( Referenced Response )) Source #
Instance details Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses ( InsOrdHashMap HttpStatusCode ( Referenced Response )) Source #
HasLinks Response ( InsOrdHashMap Text ( Referenced Link )) Source #
Instance details Defined in Data.OpenApi.Lens Methods links :: Lens' Response ( InsOrdHashMap Text ( Referenced Link )) Source #
HasHeaders Response ( InsOrdHashMap HeaderName ( Referenced Header )) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Response ( InsOrdHashMap HeaderName ( Referenced Header )) Source #
HasHeaders Encoding ( InsOrdHashMap Text ( Referenced Header )) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding ( InsOrdHashMap Text ( Referenced Header )) Source #
HasExamples Header ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Header ( InsOrdHashMap Text ( Referenced Example )) Source #
HasExamples Param ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Param ( InsOrdHashMap Text ( Referenced Example )) Source #
HasExamples MediaTypeObject ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject ( InsOrdHashMap Text ( Referenced Example )) Source #
HasCallbacks Operation ( InsOrdHashMap Text ( Referenced Callback )) Source #
Instance details Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation ( InsOrdHashMap Text ( Referenced Callback )) Source #
HasProperties Schema ( InsOrdHashMap Text ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods properties :: Lens' Schema ( InsOrdHashMap Text ( Referenced Schema )) Source #
Eq a => Eq ( Referenced a) Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Referenced a -> Referenced a -> Bool Source # (/=) :: Referenced a -> Referenced a -> Bool Source #
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) Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ( Referenced a) Source # toConstr :: Referenced a -> Constr Source # dataTypeOf :: Referenced a -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ( Referenced a)) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ( Referenced a)) Source # gmapT :: ( forall b. Data b => b -> b) -> Referenced a -> Referenced a Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Referenced a -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Referenced a -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Referenced a -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Referenced a -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Referenced a -> m ( Referenced a) Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Referenced a -> m ( Referenced a) Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Referenced a -> m ( Referenced a) Source #
Show a => Show ( Referenced a) Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Referenced a -> ShowS Source # show :: Referenced a -> String Source # showList :: [ Referenced a] -> ShowS Source #
IsString a => IsString ( Referenced a) Source #
Instance details Defined in Data.OpenApi.Internal Methods fromString :: String -> Referenced a Source #
ToJSON ( Referenced Header ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Header -> Value Source # toEncoding :: Referenced Header -> Encoding Source # toJSONList :: [ Referenced Header ] -> Value Source # toEncodingList :: [ Referenced Header ] -> Encoding Source #
ToJSON ( Referenced Callback ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Callback -> Value Source # toEncoding :: Referenced Callback -> Encoding Source # toJSONList :: [ Referenced Callback ] -> Value Source # toEncodingList :: [ Referenced Callback ] -> Encoding Source #
ToJSON ( Referenced Response ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Response -> Value Source # toEncoding :: Referenced Response -> Encoding Source # toJSONList :: [ Referenced Response ] -> Value Source # toEncodingList :: [ Referenced Response ] -> Encoding Source #
ToJSON ( Referenced Schema ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Schema -> Value Source # toEncoding :: Referenced Schema -> Encoding Source # toJSONList :: [ Referenced Schema ] -> Value Source # toEncodingList :: [ Referenced Schema ] -> Encoding Source #
ToJSON ( Referenced Link ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Link -> Value Source # toEncoding :: Referenced Link -> Encoding Source # toJSONList :: [ Referenced Link ] -> Value Source # toEncodingList :: [ Referenced Link ] -> Encoding Source #
ToJSON ( Referenced Example ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Example -> Value Source # toEncoding :: Referenced Example -> Encoding Source # toJSONList :: [ Referenced Example ] -> Value Source # toEncodingList :: [ Referenced Example ] -> Encoding Source #
ToJSON ( Referenced Param ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Param -> Value Source # toEncoding :: Referenced Param -> Encoding Source # toJSONList :: [ Referenced Param ] -> Value Source # toEncodingList :: [ Referenced Param ] -> Encoding Source #
ToJSON ( Referenced RequestBody ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced RequestBody -> Value Source # toEncoding :: Referenced RequestBody -> Encoding Source # toJSONList :: [ Referenced RequestBody ] -> Value Source # toEncodingList :: [ Referenced RequestBody ] -> Encoding Source #
FromJSON ( Referenced Header ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Header ) Source # parseJSONList :: Value -> Parser [ Referenced Header ] Source #
FromJSON ( Referenced Callback ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Callback ) Source # parseJSONList :: Value -> Parser [ Referenced Callback ] Source #
FromJSON ( Referenced Response ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Response ) Source # parseJSONList :: Value -> Parser [ Referenced Response ] Source #
FromJSON ( Referenced Schema ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Schema ) Source # parseJSONList :: Value -> Parser [ Referenced Schema ] Source #
FromJSON ( Referenced Link ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Link ) Source # parseJSONList :: Value -> Parser [ Referenced Link ] Source #
FromJSON ( Referenced Example ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Example ) Source # parseJSONList :: Value -> Parser [ Referenced Example ] Source #
FromJSON ( Referenced Param ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Param ) Source # parseJSONList :: Value -> Parser [ Referenced Param ] Source #
FromJSON ( Referenced RequestBody ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced RequestBody ) Source # parseJSONList :: Value -> Parser [ Referenced RequestBody ] Source #
Monoid a => SwaggerMonoid ( Referenced a) Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: Referenced a Source # swaggerMappend :: Referenced a -> Referenced a -> Referenced a Source #

Miscellaneous

newtype MimeList Source #

Constructors

MimeList
Fields getMimeList :: [ MediaType ]

Instances

Instances details

Eq MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: MimeList -> MimeList -> Bool Source # (/=) :: MimeList -> MimeList -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c MimeList Source # toConstr :: MimeList -> Constr Source # dataTypeOf :: MimeList -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c MimeList ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c MimeList ) Source # gmapT :: ( forall b. Data b => b -> b) -> MimeList -> MimeList Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> MimeList -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> MimeList -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> MimeList -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> MimeList -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> MimeList -> m MimeList Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> MimeList -> m MimeList Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> MimeList -> m MimeList Source #
Show MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> MimeList -> ShowS Source # show :: MimeList -> String Source # showList :: [ MimeList ] -> ShowS Source #
Semigroup MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: MimeList -> MimeList -> MimeList Source # sconcat :: NonEmpty MimeList -> MimeList Source # stimes :: Integral b => b -> MimeList -> MimeList Source #
Monoid MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: MimeList Source # mappend :: MimeList -> MimeList -> MimeList Source # mconcat :: [ MimeList ] -> MimeList Source #
ToJSON MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: MimeList -> Value Source # toEncoding :: MimeList -> Encoding Source # toJSONList :: [ MimeList ] -> Value Source # toEncodingList :: [ MimeList ] -> Encoding Source #
FromJSON MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser MimeList Source # parseJSONList :: Value -> Parser [ MimeList ] Source #
AesonDefaultValue MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods defaultValue :: Maybe MimeList Source #
SwaggerMonoid MimeList Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: MimeList Source # swaggerMappend :: MimeList -> MimeList -> MimeList Source #

newtype URL Source #

Constructors

URL
Fields getUrl :: Text

Instances

Instances details

Eq URL Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: URL -> URL -> Bool Source # (/=) :: URL -> URL -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c URL Source # toConstr :: URL -> Constr Source # dataTypeOf :: URL -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c URL ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c URL ) Source # gmapT :: ( forall b. Data b => b -> b) -> URL -> URL Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> URL -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> URL -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> URL -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> URL -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> URL -> m URL Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> URL -> m URL Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> URL -> m URL Source #
Ord URL Source #
Instance details Defined in Data.OpenApi.Internal Methods compare :: URL -> URL -> Ordering Source # (<) :: URL -> URL -> Bool Source # (<=) :: URL -> URL -> Bool Source # (>) :: URL -> URL -> Bool Source # (>=) :: URL -> URL -> Bool Source # max :: URL -> URL -> URL Source # min :: URL -> URL -> URL Source #
Show URL Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> URL -> ShowS Source # show :: URL -> String Source # showList :: [ URL ] -> ShowS Source #
Hashable URL Source #
Instance details Defined in Data.OpenApi.Internal Methods hashWithSalt :: Int -> URL -> Int Source # hash :: URL -> Int Source #
ToJSON URL Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: URL -> Value Source # toEncoding :: URL -> Encoding Source # toJSONList :: [ URL ] -> Value Source # toEncodingList :: [ URL ] -> Encoding Source #
FromJSON URL Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser URL Source # parseJSONList :: Value -> Parser [ URL ] Source #
SwaggerMonoid URL Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerMempty :: URL Source # swaggerMappend :: URL -> URL -> URL Source #
HasUrl ExternalDocs URL Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' ExternalDocs URL Source #
HasUrl License ( Maybe URL ) Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' License ( Maybe URL ) Source #
HasUrl Contact ( Maybe URL ) Source #
Instance details Defined in Data.OpenApi.Lens Methods url :: Lens' Contact ( Maybe URL ) Source #
HasExternalValue Example ( Maybe URL ) Source #
Instance details Defined in Data.OpenApi.Lens Methods externalValue :: Lens' Example ( Maybe URL ) Source #

Eq Header Source #
Instance details Defined in Data.OpenApi.Internal Methods (==) :: Header -> Header -> Bool Source # (/=) :: Header -> Header -> Bool Source #
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 Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Header Source # toConstr :: Header -> Constr Source # dataTypeOf :: Header -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Header ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Header ) Source # gmapT :: ( forall b. Data b => b -> b) -> Header -> Header Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Header -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Header -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Header -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Header -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Header -> m Header Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Header -> m Header Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Header -> m Header Source #
Show Header Source #
Instance details Defined in Data.OpenApi.Internal Methods showsPrec :: Int -> Header -> ShowS Source # show :: Header -> String Source # showList :: [ Header ] -> ShowS Source #
Generic Header Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Rep Header :: Type -> Type Source # Methods from :: Header -> Rep Header x Source # to :: Rep Header x -> Header Source #
Semigroup Header Source #
Instance details Defined in Data.OpenApi.Internal Methods (<>) :: Header -> Header -> Header Source # sconcat :: NonEmpty Header -> Header Source # stimes :: Integral b => b -> Header -> Header Source #
Monoid Header Source #
Instance details Defined in Data.OpenApi.Internal Methods mempty :: Header Source # mappend :: Header -> Header -> Header Source # mconcat :: [ Header ] -> Header Source #
ToJSON Header Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Header -> Value Source # toEncoding :: Header -> Encoding Source # toJSONList :: [ Header ] -> Value Source # toEncodingList :: [ Header ] -> Encoding Source #
FromJSON Header Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser Header Source # parseJSONList :: Value -> Parser [ Header ] Source #
Generic Header Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type Code Header :: [[ Type ]] Source # Methods from :: Header -> Rep Header Source # to :: Rep Header -> Header Source #
HasDatatypeInfo Header Source #
Instance details Defined in Data.OpenApi.Internal Associated Types type DatatypeInfoOf Header :: DatatypeInfo Source # Methods datatypeInfo :: proxy Header -> DatatypeInfo ( Code Header ) Source #
HasSwaggerAesonOptions Header Source #
Instance details Defined in Data.OpenApi.Internal Methods swaggerAesonOptions :: Proxy Header -> SwaggerAesonOptions Source # aesonDefaults :: Proxy Header -> POP Maybe ( Code Header ) Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "allowEmptyValue" k Header Header a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Header Header a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "deprecated" k Header Header a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Header Header a b Source #
(k ~ A_Lens , a ~ Maybe HeaderName , b ~ Maybe HeaderName ) => LabelOptic "description" k Header Header a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Header Header a b Source #
(k ~ A_Lens , a ~ Maybe Value , b ~ Maybe Value ) => LabelOptic "example" k Header Header a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Header Header a b Source #
(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 Methods labelOptic :: Optic k NoIx Header Header a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "explode" k Header Header a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Header Header a b Source #
(k ~ A_Lens , a ~ Maybe Bool , b ~ Maybe Bool ) => LabelOptic "required" k Header Header a b Source #
Instance details Defined in Data.OpenApi.Optics Methods labelOptic :: Optic k NoIx Header Header a b Source #
(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 Methods labelOptic :: Optic k NoIx Header Header a b Source #
HasHeaders Components ( Definitions Header ) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Components ( Definitions Header ) Source #
HasDescription Header ( Maybe HeaderName ) Source #
Instance details Defined in Data.OpenApi.Lens Methods description :: Lens' Header ( Maybe HeaderName ) Source #
HasRequired Header ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods required :: Lens' Header ( Maybe Bool ) Source #
HasSchema Header ( Maybe ( Referenced Schema )) Source #
Instance details Defined in Data.OpenApi.Lens Methods schema :: Lens' Header ( Maybe ( Referenced Schema )) Source #
HasExample Header ( Maybe Value ) Source #
Instance details Defined in Data.OpenApi.Lens Methods example :: Lens' Header ( Maybe Value ) Source #
HasDeprecated Header ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods deprecated :: Lens' Header ( Maybe Bool ) Source #
HasExplode Header ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods explode :: Lens' Header ( Maybe Bool ) Source #
HasAllowEmptyValue Header ( Maybe Bool ) Source #
Instance details Defined in Data.OpenApi.Lens Methods allowEmptyValue :: Lens' Header ( Maybe Bool ) Source #
HasHeaders Response ( InsOrdHashMap HeaderName ( Referenced Header )) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Response ( InsOrdHashMap HeaderName ( Referenced Header )) Source #
HasHeaders Encoding ( InsOrdHashMap Text ( Referenced Header )) Source #
Instance details Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding ( InsOrdHashMap Text ( Referenced Header )) Source #
HasExamples Header ( InsOrdHashMap Text ( Referenced Example )) Source #
Instance details Defined in Data.OpenApi.Lens Methods examples :: Lens' Header ( InsOrdHashMap Text ( Referenced Example )) Source #
ToJSON ( Referenced Header ) Source #
Instance details Defined in Data.OpenApi.Internal Methods toJSON :: Referenced Header -> Value Source # toEncoding :: Referenced Header -> Encoding Source # toJSONList :: [ Referenced Header ] -> Value Source # toEncodingList :: [ Referenced Header ] -> Encoding Source #
FromJSON ( Referenced Header ) Source #
Instance details Defined in Data.OpenApi.Internal Methods parseJSON :: Value -> Parser ( Referenced Header ) Source # parseJSONList :: Value -> Parser [ Referenced Header ] Source #
type Rep Header Source #
Instance details Defined in Data.OpenApi.Internal type Rep Header = D1 (' MetaData "Header" "Data.OpenApi.Internal" "openapi3-3.2.3-DDms5mjbCFD41v1R6d21dC" ' False ) ( C1 (' MetaCons "Header" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "_headerDescription") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe HeaderName )) :: S1 (' MetaSel (' Just "_headerRequired") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Bool ))) :: ( S1 (' MetaSel (' Just "_headerDeprecated") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Bool )) :: S1 (' MetaSel (' Just "_headerAllowEmptyValue") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Bool )))) :: (( S1 (' MetaSel (' Just "_headerExplode") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Bool )) :: S1 (' MetaSel (' Just "_headerExample") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Value ))) :: ( S1 (' MetaSel (' Just "_headerExamples") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( InsOrdHashMap Text ( Referenced Example ))) :*: S1 (' MetaSel (' Just "_headerSchema") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe ( Referenced Schema )))))))
type Code Header Source #
Instance details Defined in Data.OpenApi.Internal type Code Header = '['[ Maybe HeaderName , Maybe Bool , Maybe Bool , Maybe Bool , Maybe Bool , Maybe Value , InsOrdHashMap Text ( Referenced Example ), Maybe ( Referenced Schema )]]
type DatatypeInfoOf Header Source #
Instance details Defined in Data.OpenApi.Internal type DatatypeInfoOf Header = ' ADT "Data.OpenApi.Internal" "Header" '[' Record "Header" '[' FieldInfo "_headerDescription", ' FieldInfo "_headerRequired", ' FieldInfo "_headerDeprecated", ' FieldInfo "_headerAllowEmptyValue", ' FieldInfo "_headerExplode", ' FieldInfo "_headerExample", ' FieldInfo "_headerExamples", ' FieldInfo "_headerSchema"]] '['[' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy , ' StrictnessInfo ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ]]

How to use this library

Monoid instances

Lenses and prisms

Schema specification

Manipulation

Validation

Re-exports

Swagger specification

Instances

Instances

Instances

Instances

Info types

Instances

Instances

Instances

PathItem

Instances

Operations

Instances

Instances

Types and formats

Instances

Instances

Parameters

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Schemas

Instances

Instances

Instances

Instances

Instances

Instances

Responses

Instances

Instances

Instances

Instances

Security

Instances

Instances

Instances

Instances

Instances

API key

Instances

Instances

OAuth2

Instances

Instances

Instances

Instances

Instances

Instances

External documentation

Instances

References

Instances

Instances

Miscellaneous

Instances

Instances

`Monoid` instances