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

Data.Swagger.Lens

Contents

Classy lenses
Prisms
Orphan instances

Description

Lenses and prisms for Swagger.

Synopsis

class HasBasePath s a | s -> a where
- basePath :: Lens' s a
class HasConsumes s a | s -> a where
- consumes :: Lens' s a
class HasDefinitions s a | s -> a where
- definitions :: Lens' s a
class HasExternalDocs s a | s -> a where
- externalDocs :: Lens' s a
class HasHost s a | s -> a where
- host :: Lens' s a
class HasInfo s a | s -> a where
- info :: Lens' s a
class HasParameters s a | s -> a where
- parameters :: Lens' s a
class HasPaths s a | s -> a where
- paths :: Lens' s a
class HasProduces s a | s -> a where
- produces :: Lens' s a
class HasResponses s a | s -> a where
- responses :: Lens' s a
class HasSchemes s a | s -> a where
- schemes :: Lens' s a
class HasSecurity s a | s -> a where
- security :: Lens' s a
class HasSecurityDefinitions s a | s -> a where
- securityDefinitions :: Lens' s a
class HasTags s a | s -> a where
- tags :: Lens' s a
class HasName s a | s -> a where
- name :: Lens' s a
class HasPort s a | s -> a where
- port :: Lens' s a
class HasContact s a | s -> a where
- contact :: Lens' s a
class HasDescription s a | s -> a where
- description :: Lens' s a
class HasLicense s a | s -> a where
- license :: Lens' s a
class HasTermsOfService s a | s -> a where
- termsOfService :: Lens' s a
class HasTitle s a | s -> a where
- title :: Lens' s a
class HasVersion s a | s -> a where
- version :: Lens' s a
class HasEmail s a | s -> a where
- email :: Lens' s a
class HasUrl s a | s -> a where
- url :: Lens' s a
class HasDelete s a | s -> a where
- delete :: Lens' s a
class HasGet s a | s -> a where
- get :: Lens' s a
class HasHead s a | s -> a where
- head_ :: Lens' s a
class HasOptions s a | s -> a where
- options :: Lens' s a
class HasPatch s a | s -> a where
- patch :: Lens' s a
class HasPost s a | s -> a where
- post :: Lens' s a
class HasPut s a | s -> a where
- put :: Lens' s a
class HasDeprecated s a | s -> a where
- deprecated :: Lens' s a
class HasOperationId s a | s -> a where
- operationId :: Lens' s a
class HasSummary s a | s -> a where
- summary :: Lens' s a
class HasRequired s a | s -> a where
- required :: Lens' s a
class HasSchema s a | s -> a where
- schema :: Lens' s a
class HasAllowEmptyValue s a | s -> a where
- allowEmptyValue :: Lens' s a
class HasIn s a | s -> a where
- in_ :: Lens' s a
class HasParamSchema s a | s -> a where
- paramSchema :: Lens' s a
class HasAdditionalProperties s a | s -> a where
- additionalProperties :: Lens' s a
class HasAllOf s a | s -> a where
- allOf :: Lens' s a
class HasDiscriminator s a | s -> a where
- discriminator :: Lens' s a
class HasExample s a | s -> a where
- example :: Lens' s a
class HasMaxProperties s a | s -> a where
- maxProperties :: Lens' s a
class HasMinProperties s a | s -> a where
- minProperties :: Lens' s a
class HasProperties s a | s -> a where
- properties :: Lens' s a
class HasReadOnly s a | s -> a where
- readOnly :: Lens' s a
class HasXml s a | s -> a where
- xml :: Lens' s a
class HasDefault s a | s -> a where
- default_ :: Lens' s a
class HasEnum s a | s -> a where
- enum_ :: Lens' s a
class HasExclusiveMaximum s a | s -> a where
- exclusiveMaximum :: Lens' s a
class HasExclusiveMinimum s a | s -> a where
- exclusiveMinimum :: Lens' s a
class HasFormat s a | s -> a where
- format :: Lens' s a
class HasItems s a | s -> a where
- items :: Lens' s a
class HasMaxItems s a | s -> a where
- maxItems :: Lens' s a
class HasMaxLength s a | s -> a where
- maxLength :: Lens' s a
class HasMaximum s a | s -> a where
- maximum_ :: Lens' s a
class HasMinItems s a | s -> a where
- minItems :: Lens' s a
class HasMinLength s a | s -> a where
- minLength :: Lens' s a
class HasMinimum s a | s -> a where
- minimum_ :: Lens' s a
class HasMultipleOf s a | s -> a where
- multipleOf :: Lens' s a
class HasPattern s a | s -> a where
- pattern :: Lens' s a
class HasType s a | s -> a where
- type_ :: Lens' s a
class HasUniqueItems s a | s -> a where
- uniqueItems :: Lens' s a
class HasAttribute s a | s -> a where
- attribute :: Lens' s a
class HasNamespace s a | s -> a where
- namespace :: Lens' s a
class HasPrefix s a | s -> a where
- prefix :: Lens' s a
class HasWrapped s a | s -> a where
- wrapped :: Lens' s a
class HasExamples s a | s -> a where
- examples :: Lens' s a
class HasHeaders s a | s -> a where
- headers :: Lens' s a
_ParamOther :: Prism' ParamAnySchema ParamOtherSchema
_ParamBody :: Prism' ParamAnySchema (Referenced Schema)
_SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Params
_SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams
_SecuritySchemeBasic :: Prism' SecuritySchemeType ()
_Inline :: forall a a. Prism (Referenced a) (Referenced a) a a
_Ref :: forall a. Prism' (Referenced a) Reference
_SwaggerItemsArray :: Review (SwaggerItems SwaggerKindSchema) [Referenced Schema]
_SwaggerItemsObject :: Review (SwaggerItems SwaggerKindSchema) (Referenced Schema)
_SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t)

Classy lenses

class HasBasePath s a | s -> a where Source #

Methods

basePath :: Lens' s a Source #

Instances

HasBasePath Swagger (Maybe FilePath) Source #
Instance details Defined in Data.Swagger.Lens Methods basePath :: Lens' Swagger (Maybe FilePath) Source #

class HasConsumes s a | s -> a where Source #

Methods

consumes :: Lens' s a Source #

Instances

HasConsumes Swagger MimeList Source #
Instance details Defined in Data.Swagger.Lens Methods consumes :: Lens' Swagger MimeList Source #
HasConsumes Operation (Maybe MimeList) Source #
Instance details Defined in Data.Swagger.Lens Methods consumes :: Lens' Operation (Maybe MimeList) Source #

class HasDefinitions s a | s -> a where Source #

Methods

definitions :: Lens' s a Source #

Instances

HasDefinitions Swagger (Definitions Schema) Source #
Instance details Defined in Data.Swagger.Lens Methods definitions :: Lens' Swagger (Definitions Schema) Source #

class HasExternalDocs s a | s -> a where Source #

Methods

externalDocs :: Lens' s a Source #

Instances

HasExternalDocs Tag (Maybe ExternalDocs) Source #
Instance details Defined in Data.Swagger.Lens Methods externalDocs :: Lens' Tag (Maybe ExternalDocs) Source #
HasExternalDocs Schema (Maybe ExternalDocs) Source #
Instance details Defined in Data.Swagger.Lens Methods externalDocs :: Lens' Schema (Maybe ExternalDocs) Source #
HasExternalDocs Operation (Maybe ExternalDocs) Source #
Instance details Defined in Data.Swagger.Lens Methods externalDocs :: Lens' Operation (Maybe ExternalDocs) Source #
HasExternalDocs Swagger (Maybe ExternalDocs) Source #
Instance details Defined in Data.Swagger.Lens Methods externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source #

class HasHost s a | s -> a where Source #

Methods

host :: Lens' s a Source #

Instances

HasHost Swagger (Maybe Host) Source #
Instance details Defined in Data.Swagger.Lens Methods host :: Lens' Swagger (Maybe Host) Source #

class HasInfo s a | s -> a where Source #

Methods

info :: Lens' s a Source #

Instances

HasInfo Swagger Info Source #
Instance details Defined in Data.Swagger.Lens Methods info :: Lens' Swagger Info Source #

class HasParameters s a | s -> a where Source #

Methods

parameters :: Lens' s a Source #

Instances

HasParameters Operation [Referenced Param] Source #
Instance details Defined in Data.Swagger.Lens Methods parameters :: Lens' Operation [Referenced Param] Source #
HasParameters PathItem [Referenced Param] Source #
Instance details Defined in Data.Swagger.Lens Methods parameters :: Lens' PathItem [Referenced Param] Source #
HasParameters Swagger (Definitions Param) Source #
Instance details Defined in Data.Swagger.Lens Methods parameters :: Lens' Swagger (Definitions Param) Source #

class HasPaths s a | s -> a where Source #

Methods

paths :: Lens' s a Source #

Instances

HasPaths Swagger (InsOrdHashMap FilePath PathItem) Source #
Instance details Defined in Data.Swagger.Lens Methods paths :: Lens' Swagger (InsOrdHashMap FilePath PathItem) Source #

class HasProduces s a | s -> a where Source #

Methods

produces :: Lens' s a Source #

Instances

HasProduces Swagger MimeList Source #
Instance details Defined in Data.Swagger.Lens Methods produces :: Lens' Swagger MimeList Source #
HasProduces Operation (Maybe MimeList) Source #
Instance details Defined in Data.Swagger.Lens Methods produces :: Lens' Operation (Maybe MimeList) Source #

class HasResponses s a | s -> a where Source #

Methods

responses :: Lens' s a Source #

Instances

HasResponses Operation Responses Source #
Instance details Defined in Data.Swagger.Lens Methods responses :: Lens' Operation Responses Source #
HasResponses Swagger (Definitions Response) Source #
Instance details Defined in Data.Swagger.Lens Methods responses :: Lens' Swagger (Definitions Response) Source #
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #
Instance details Defined in Data.Swagger.Lens Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source #

class HasSchemes s a | s -> a where Source #

Methods

schemes :: Lens' s a Source #

Instances

HasSchemes Operation (Maybe [Scheme]) Source #
Instance details Defined in Data.Swagger.Lens Methods schemes :: Lens' Operation (Maybe [Scheme]) Source #
HasSchemes Swagger (Maybe [Scheme]) Source #
Instance details Defined in Data.Swagger.Lens Methods schemes :: Lens' Swagger (Maybe [Scheme]) Source #

class HasSecurity s a | s -> a where Source #

Methods

security :: Lens' s a Source #

Instances

HasSecurity Operation [SecurityRequirement] Source #
Instance details Defined in Data.Swagger.Lens Methods security :: Lens' Operation [SecurityRequirement] Source #
HasSecurity Swagger [SecurityRequirement] Source #
Instance details Defined in Data.Swagger.Lens Methods security :: Lens' Swagger [SecurityRequirement] Source #

class HasSecurityDefinitions s a | s -> a where Source #

Methods

securityDefinitions :: Lens' s a Source #

Instances

HasSecurityDefinitions Swagger SecurityDefinitions Source #
Instance details Defined in Data.Swagger.Lens Methods securityDefinitions :: Lens' Swagger SecurityDefinitions Source #

class HasTags s a | s -> a where Source #

Methods

tags :: Lens' s a Source #

Instances

HasTags Operation (InsOrdHashSet TagName) Source #
Instance details Defined in Data.Swagger.Lens Methods tags :: Lens' Operation (InsOrdHashSet TagName) Source #
HasTags Swagger (InsOrdHashSet Tag) Source #
Instance details Defined in Data.Swagger.Lens Methods tags :: Lens' Swagger (InsOrdHashSet Tag) Source #

class HasName s a | s -> a where Source #

Methods

name :: Lens' s a Source #

Instances

HasName Tag TagName Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' Tag TagName Source #
HasName Param Text Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' Param Text Source #
HasName Host HostName Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' Host HostName Source #
HasName License Text Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' License Text Source #
HasName Xml (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' Xml (Maybe Text) Source #
HasName NamedSchema (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' NamedSchema (Maybe Text) Source #
HasName Contact (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods name :: Lens' Contact (Maybe Text) Source #

class HasPort s a | s -> a where Source #

Methods

port :: Lens' s a Source #

Instances

HasPort Host (Maybe PortNumber) Source #
Instance details Defined in Data.Swagger.Lens Methods port :: Lens' Host (Maybe PortNumber) Source #

class HasContact s a | s -> a where Source #

Methods

contact :: Lens' s a Source #

Instances

HasContact Info (Maybe Contact) Source #
Instance details Defined in Data.Swagger.Lens Methods contact :: Lens' Info (Maybe Contact) Source #

class HasDescription s a | s -> a where Source #

Methods

description :: Lens' s a Source #

Instances

HasDescription Response Text Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Response Text Source #
HasDescription ExternalDocs (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' ExternalDocs (Maybe Text) Source #
HasDescription Tag (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Tag (Maybe Text) Source #
HasDescription SecurityScheme (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' SecurityScheme (Maybe Text) Source #
HasDescription Header (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Header (Maybe Text) Source #
HasDescription Schema (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Schema (Maybe Text) Source #
HasDescription Param (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Param (Maybe Text) Source #
HasDescription Operation (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Operation (Maybe Text) Source #
HasDescription Info (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods description :: Lens' Info (Maybe Text) Source #

class HasLicense s a | s -> a where Source #

Methods

license :: Lens' s a Source #

Instances

HasLicense Info (Maybe License) Source #
Instance details Defined in Data.Swagger.Lens Methods license :: Lens' Info (Maybe License) Source #

class HasTermsOfService s a | s -> a where Source #

Methods

termsOfService :: Lens' s a Source #

Instances

HasTermsOfService Info (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods termsOfService :: Lens' Info (Maybe Text) Source #

class HasTitle s a | s -> a where Source #

Methods

title :: Lens' s a Source #

Instances

HasTitle Info Text Source #
Instance details Defined in Data.Swagger.Lens Methods title :: Lens' Info Text Source #
HasTitle Schema (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods title :: Lens' Schema (Maybe Text) Source #

class HasVersion s a | s -> a where Source #

Methods

version :: Lens' s a Source #

Instances

HasVersion Info Text Source #
Instance details Defined in Data.Swagger.Lens Methods version :: Lens' Info Text Source #

class HasEmail s a | s -> a where Source #

Methods

email :: Lens' s a Source #

Instances

HasEmail Contact (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods email :: Lens' Contact (Maybe Text) Source #

class HasUrl s a | s -> a where Source #

Methods

url :: Lens' s a Source #

Instances

HasUrl ExternalDocs URL Source #
Instance details Defined in Data.Swagger.Lens Methods url :: Lens' ExternalDocs URL Source #
HasUrl License (Maybe URL) Source #
Instance details Defined in Data.Swagger.Lens Methods url :: Lens' License (Maybe URL) Source #
HasUrl Contact (Maybe URL) Source #
Instance details Defined in Data.Swagger.Lens Methods url :: Lens' Contact (Maybe URL) Source #

class HasDelete s a | s -> a where Source #

Methods

delete :: Lens' s a Source #

Instances

HasDelete PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods delete :: Lens' PathItem (Maybe Operation) Source #

class HasGet s a | s -> a where Source #

Methods

get :: Lens' s a Source #

Instances

HasGet PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods get :: Lens' PathItem (Maybe Operation) Source #

class HasHead s a | s -> a where Source #

Methods

head_ :: Lens' s a Source #

Instances

HasHead PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods head_ :: Lens' PathItem (Maybe Operation) Source #

class HasOptions s a | s -> a where Source #

Methods

options :: Lens' s a Source #

Instances

HasOptions PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods options :: Lens' PathItem (Maybe Operation) Source #

class HasPatch s a | s -> a where Source #

Methods

patch :: Lens' s a Source #

Instances

HasPatch PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods patch :: Lens' PathItem (Maybe Operation) Source #

class HasPost s a | s -> a where Source #

Methods

post :: Lens' s a Source #

Instances

HasPost PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods post :: Lens' PathItem (Maybe Operation) Source #

class HasPut s a | s -> a where Source #

Methods

put :: Lens' s a Source #

Instances

HasPut PathItem (Maybe Operation) Source #
Instance details Defined in Data.Swagger.Lens Methods put :: Lens' PathItem (Maybe Operation) Source #

class HasDeprecated s a | s -> a where Source #

Methods

deprecated :: Lens' s a Source #

Instances

HasDeprecated Operation (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods deprecated :: Lens' Operation (Maybe Bool) Source #

class HasOperationId s a | s -> a where Source #

Methods

operationId :: Lens' s a Source #

Instances

HasOperationId Operation (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods operationId :: Lens' Operation (Maybe Text) Source #

class HasSummary s a | s -> a where Source #

Methods

summary :: Lens' s a Source #

Instances

HasSummary Operation (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods summary :: Lens' Operation (Maybe Text) Source #

class HasRequired s a | s -> a where Source #

Methods

required :: Lens' s a Source #

Instances

HasRequired Schema [ParamName] Source #
Instance details Defined in Data.Swagger.Lens Methods required :: Lens' Schema [ParamName] Source #
HasRequired Param (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods required :: Lens' Param (Maybe Bool) Source #

class HasSchema s a | s -> a where Source #

Methods

schema :: Lens' s a Source #

Instances

HasSchema NamedSchema Schema Source #
Instance details Defined in Data.Swagger.Lens Methods schema :: Lens' NamedSchema Schema Source #
HasSchema Param ParamAnySchema Source #
Instance details Defined in Data.Swagger.Lens Methods schema :: Lens' Param ParamAnySchema Source #
HasSchema Response (Maybe (Referenced Schema)) Source #
Instance details Defined in Data.Swagger.Lens Methods schema :: Lens' Response (Maybe (Referenced Schema)) Source #

class HasAllowEmptyValue s a | s -> a where Source #

Methods

allowEmptyValue :: Lens' s a Source #

Instances

HasAllowEmptyValue ParamOtherSchema (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods allowEmptyValue :: Lens' ParamOtherSchema (Maybe Bool) Source #

class HasIn s a | s -> a where Source #

Methods

in_ :: Lens' s a Source #

Instances

HasIn ParamOtherSchema ParamLocation Source #
Instance details Defined in Data.Swagger.Lens Methods in_ :: Lens' ParamOtherSchema ParamLocation Source #

class HasParamSchema s a | s -> a where Source #

Methods

paramSchema :: Lens' s a Source #

Instances

HasParamSchema Header (ParamSchema (SwaggerKindNormal Header)) Source #
Instance details Defined in Data.Swagger.Lens Methods paramSchema :: Lens' Header (ParamSchema (SwaggerKindNormal Header)) Source #
HasParamSchema NamedSchema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source #
Instance details Defined in Data.Swagger.Lens Methods paramSchema :: Lens' NamedSchema (ParamSchema SwaggerKindSchema) Source #
HasParamSchema Schema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source #
Instance details Defined in Data.Swagger.Lens Methods paramSchema :: Lens' Schema (ParamSchema SwaggerKindSchema) Source #
HasParamSchema ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source #
Instance details Defined in Data.Swagger.Lens Methods paramSchema :: Lens' ParamOtherSchema (ParamSchema SwaggerKindParamOtherSchema) Source #

class HasAdditionalProperties s a | s -> a where Source #

Methods

additionalProperties :: Lens' s a Source #

Instances

HasAdditionalProperties Schema (Maybe AdditionalProperties) Source #
Instance details Defined in Data.Swagger.Lens Methods additionalProperties :: Lens' Schema (Maybe AdditionalProperties) Source #

class HasAllOf s a | s -> a where Source #

Methods

allOf :: Lens' s a Source #

Instances

HasAllOf Schema (Maybe [Referenced Schema]) Source #
Instance details Defined in Data.Swagger.Lens Methods allOf :: Lens' Schema (Maybe [Referenced Schema]) Source #

class HasDiscriminator s a | s -> a where Source #

Methods

discriminator :: Lens' s a Source #

Instances

HasDiscriminator Schema (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods discriminator :: Lens' Schema (Maybe Text) Source #

class HasExample s a | s -> a where Source #

Methods

example :: Lens' s a Source #

Instances

HasExample Schema (Maybe Value) Source #
Instance details Defined in Data.Swagger.Lens Methods example :: Lens' Schema (Maybe Value) Source #

class HasMaxProperties s a | s -> a where Source #

Methods

maxProperties :: Lens' s a Source #

Instances

HasMaxProperties Schema (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods maxProperties :: Lens' Schema (Maybe Integer) Source #

class HasMinProperties s a | s -> a where Source #

Methods

minProperties :: Lens' s a Source #

Instances

HasMinProperties Schema (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods minProperties :: Lens' Schema (Maybe Integer) Source #

class HasProperties s a | s -> a where Source #

Methods

properties :: Lens' s a Source #

Instances

HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source #
Instance details Defined in Data.Swagger.Lens Methods properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source #

class HasReadOnly s a | s -> a where Source #

Methods

readOnly :: Lens' s a Source #

Instances

HasReadOnly Schema (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods readOnly :: Lens' Schema (Maybe Bool) Source #

class HasXml s a | s -> a where Source #

Methods

xml :: Lens' s a Source #

Instances

HasXml Schema (Maybe Xml) Source #
Instance details Defined in Data.Swagger.Lens Methods xml :: Lens' Schema (Maybe Xml) Source #

class HasDefault s a | s -> a where Source #

Methods

default_ :: Lens' s a Source #

Instances

HasDefault Header (Maybe Value) Source #
Instance details Defined in Data.Swagger.Lens Methods default_ :: Lens' Header (Maybe Value) Source #
HasDefault Responses (Maybe (Referenced Response)) Source #
Instance details Defined in Data.Swagger.Lens Methods default_ :: Lens' Responses (Maybe (Referenced Response)) Source #
HasDefault Schema (Maybe Value) Source #
Instance details Defined in Data.Swagger.Lens Methods default_ :: Lens' Schema (Maybe Value) Source #
HasDefault ParamOtherSchema (Maybe Value) Source #
Instance details Defined in Data.Swagger.Lens Methods default_ :: Lens' ParamOtherSchema (Maybe Value) Source #
HasDefault (ParamSchema t) (Maybe Value) Source #
Instance details Defined in Data.Swagger.Lens Methods default_ :: Lens' (ParamSchema t) (Maybe Value) Source #

class HasEnum s a | s -> a where Source #

Methods

enum_ :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasEnum s (Maybe [Value]) Source #
Instance details Defined in Data.Swagger.Lens Methods enum_ :: Lens' s (Maybe [Value]) Source #
HasEnum (ParamSchema t) (Maybe [Value]) Source #
Instance details Defined in Data.Swagger.Lens Methods enum_ :: Lens' (ParamSchema t) (Maybe [Value]) Source #

class HasExclusiveMaximum s a | s -> a where Source #

Methods

exclusiveMaximum :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasExclusiveMaximum s (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods exclusiveMaximum :: Lens' s (Maybe Bool) Source #
HasExclusiveMaximum (ParamSchema t) (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods exclusiveMaximum :: Lens' (ParamSchema t) (Maybe Bool) Source #

class HasExclusiveMinimum s a | s -> a where Source #

Methods

exclusiveMinimum :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasExclusiveMinimum s (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods exclusiveMinimum :: Lens' s (Maybe Bool) Source #
HasExclusiveMinimum (ParamSchema t) (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods exclusiveMinimum :: Lens' (ParamSchema t) (Maybe Bool) Source #

class HasFormat s a | s -> a where Source #

Methods

format :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasFormat s (Maybe Format) Source #
Instance details Defined in Data.Swagger.Lens Methods format :: Lens' s (Maybe Format) Source #
HasFormat (ParamSchema t) (Maybe Format) Source #
Instance details Defined in Data.Swagger.Lens Methods format :: Lens' (ParamSchema t) (Maybe Format) Source #

class HasItems s a | s -> a where Source #

Methods

items :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasItems s (Maybe (SwaggerItems t)) Source #
Instance details Defined in Data.Swagger.Lens Methods items :: Lens' s (Maybe (SwaggerItems t)) Source #
HasItems (ParamSchema t) (Maybe (SwaggerItems t)) Source #
Instance details Defined in Data.Swagger.Lens Methods items :: Lens' (ParamSchema t) (Maybe (SwaggerItems t)) Source #

class HasMaxItems s a | s -> a where Source #

Methods

maxItems :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMaxItems s (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods maxItems :: Lens' s (Maybe Integer) Source #
HasMaxItems (ParamSchema t) (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods maxItems :: Lens' (ParamSchema t) (Maybe Integer) Source #

class HasMaxLength s a | s -> a where Source #

Methods

maxLength :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMaxLength s (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods maxLength :: Lens' s (Maybe Integer) Source #
HasMaxLength (ParamSchema t) (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods maxLength :: Lens' (ParamSchema t) (Maybe Integer) Source #

class HasMaximum s a | s -> a where Source #

Methods

maximum_ :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMaximum s (Maybe Scientific) Source #
Instance details Defined in Data.Swagger.Lens Methods maximum_ :: Lens' s (Maybe Scientific) Source #
HasMaximum (ParamSchema t) (Maybe Scientific) Source #
Instance details Defined in Data.Swagger.Lens Methods maximum_ :: Lens' (ParamSchema t) (Maybe Scientific) Source #

class HasMinItems s a | s -> a where Source #

Methods

minItems :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMinItems s (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods minItems :: Lens' s (Maybe Integer) Source #
HasMinItems (ParamSchema t) (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods minItems :: Lens' (ParamSchema t) (Maybe Integer) Source #

class HasMinLength s a | s -> a where Source #

Methods

minLength :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMinLength s (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods minLength :: Lens' s (Maybe Integer) Source #
HasMinLength (ParamSchema t) (Maybe Integer) Source #
Instance details Defined in Data.Swagger.Lens Methods minLength :: Lens' (ParamSchema t) (Maybe Integer) Source #

class HasMinimum s a | s -> a where Source #

Methods

minimum_ :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMinimum s (Maybe Scientific) Source #
Instance details Defined in Data.Swagger.Lens Methods minimum_ :: Lens' s (Maybe Scientific) Source #
HasMinimum (ParamSchema t) (Maybe Scientific) Source #
Instance details Defined in Data.Swagger.Lens Methods minimum_ :: Lens' (ParamSchema t) (Maybe Scientific) Source #

class HasMultipleOf s a | s -> a where Source #

Methods

multipleOf :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasMultipleOf s (Maybe Scientific) Source #
Instance details Defined in Data.Swagger.Lens Methods multipleOf :: Lens' s (Maybe Scientific) Source #
HasMultipleOf (ParamSchema t) (Maybe Scientific) Source #
Instance details Defined in Data.Swagger.Lens Methods multipleOf :: Lens' (ParamSchema t) (Maybe Scientific) Source #

class HasPattern s a | s -> a where Source #

Methods

pattern :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasPattern s (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods pattern :: Lens' s (Maybe Text) Source #
HasPattern (ParamSchema t) (Maybe Pattern) Source #
Instance details Defined in Data.Swagger.Lens Methods pattern :: Lens' (ParamSchema t) (Maybe Pattern) Source #

class HasType s a | s -> a where Source #

Methods

type_ :: Lens' s a Source #

Instances

HasType SecurityScheme SecuritySchemeType Source #
Instance details Defined in Data.Swagger.Lens Methods type_ :: Lens' SecurityScheme SecuritySchemeType Source #
HasType Header (Maybe (SwaggerType (SwaggerKindNormal Header))) Source #
Instance details Defined in Data.Swagger.Lens Methods type_ :: Lens' Header (Maybe (SwaggerType (SwaggerKindNormal Header))) Source #
HasType NamedSchema (Maybe (SwaggerType (SwaggerKindSchema :: SwaggerKind Type))) Source #
Instance details Defined in Data.Swagger.Lens Methods type_ :: Lens' NamedSchema (Maybe (SwaggerType SwaggerKindSchema)) Source #
HasType Schema (Maybe (SwaggerType (SwaggerKindSchema :: SwaggerKind Type))) Source #
Instance details Defined in Data.Swagger.Lens Methods type_ :: Lens' Schema (Maybe (SwaggerType SwaggerKindSchema)) Source #
HasType ParamOtherSchema (Maybe (SwaggerType (SwaggerKindParamOtherSchema :: SwaggerKind Type))) Source #
Instance details Defined in Data.Swagger.Lens Methods type_ :: Lens' ParamOtherSchema (Maybe (SwaggerType SwaggerKindParamOtherSchema)) Source #
HasType (ParamSchema t) (Maybe (SwaggerType t)) Source #
Instance details Defined in Data.Swagger.Lens Methods type_ :: Lens' (ParamSchema t) (Maybe (SwaggerType t)) Source #

class HasUniqueItems s a | s -> a where Source #

Methods

uniqueItems :: Lens' s a Source #

Instances

HasParamSchema s (ParamSchema t) => HasUniqueItems s (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods uniqueItems :: Lens' s (Maybe Bool) Source #
HasUniqueItems (ParamSchema t) (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods uniqueItems :: Lens' (ParamSchema t) (Maybe Bool) Source #

class HasAttribute s a | s -> a where Source #

Methods

attribute :: Lens' s a Source #

Instances

HasAttribute Xml (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods attribute :: Lens' Xml (Maybe Bool) Source #

class HasNamespace s a | s -> a where Source #

Methods

namespace :: Lens' s a Source #

Instances

HasNamespace Xml (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods namespace :: Lens' Xml (Maybe Text) Source #

class HasPrefix s a | s -> a where Source #

Methods

prefix :: Lens' s a Source #

Instances

HasPrefix Xml (Maybe Text) Source #
Instance details Defined in Data.Swagger.Lens Methods prefix :: Lens' Xml (Maybe Text) Source #

class HasWrapped s a | s -> a where Source #

Methods

wrapped :: Lens' s a Source #

Instances

HasWrapped Xml (Maybe Bool) Source #
Instance details Defined in Data.Swagger.Lens Methods wrapped :: Lens' Xml (Maybe Bool) Source #

class HasExamples s a | s -> a where Source #

Methods

examples :: Lens' s a Source #

Instances

HasExamples Response (Maybe Example) Source #
Instance details Defined in Data.Swagger.Lens Methods examples :: Lens' Response (Maybe Example) Source #

class HasHeaders s a | s -> a where Source #

Methods

headers :: Lens' s a Source #

Instances

HasHeaders Response (InsOrdHashMap HeaderName Header) Source #
Instance details Defined in Data.Swagger.Lens Methods headers :: Lens' Response (InsOrdHashMap HeaderName Header) Source #

Prisms

`ParamAnySchema` prisms

_ParamOther :: Prism' ParamAnySchema ParamOtherSchema Source #

_ParamBody :: Prism' ParamAnySchema (Referenced Schema) Source #

`SecuritySchemeType` prisms

_SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Params Source #

_SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams Source #

_SecuritySchemeBasic :: Prism' SecuritySchemeType () Source #

`Referenced` prisms

_Inline :: forall a a. Prism (Referenced a) (Referenced a) a a Source #

_Ref :: forall a. Prism' (Referenced a) Reference Source #

`SwaggerItems` prisms

_SwaggerItemsArray :: Review (SwaggerItems SwaggerKindSchema) [Referenced Schema] Source #

_SwaggerItemsObject :: Review (SwaggerItems SwaggerKindSchema) (Referenced Schema) Source #

_SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t) Source #

Orphan instances

At SecurityDefinitions Source #
Instance details Methods at :: Index SecurityDefinitions -> Lens' SecurityDefinitions (Maybe (IxValue SecurityDefinitions))
At Responses Source #
Instance details Methods at :: Index Responses -> Lens' Responses (Maybe (IxValue Responses))
At Operation Source #
Instance details Methods at :: Index Operation -> Lens' Operation (Maybe (IxValue Operation))
Ixed SecurityDefinitions Source #
Instance details Methods ix :: Index SecurityDefinitions -> Traversal' SecurityDefinitions (IxValue SecurityDefinitions)
Ixed Responses Source #
Instance details Methods ix :: Index Responses -> Traversal' Responses (IxValue Responses)
Ixed Operation Source #
Instance details Methods ix :: Index Operation -> Traversal' Operation (IxValue Operation)

Classy lenses

Prisms

ParamAnySchema prisms

SecuritySchemeType prisms

Referenced prisms

SwaggerItems prisms

Orphan instances

`ParamAnySchema` prisms

`SecuritySchemeType` prisms

`Referenced` prisms

`SwaggerItems` prisms