Data.Swagger.Lens

Lenses and prisms for Swagger.

Classy lenses

class HasBasePath s a | s -> a where

Methods

basePath :: Lens' s a

Instances

HasBasePath Swagger (Maybe FilePath)

class HasConsumes s a | s -> a where

Methods

consumes :: Lens' s a

Instances

HasConsumes Swagger MimeList

HasConsumes Operation (Maybe MimeList)

class HasDefinitions s a | s -> a where

Methods

definitions :: Lens' s a

Instances

HasDefinitions Swagger (Definitions Schema)

class HasExternalDocs s a | s -> a where

Methods

externalDocs :: Lens' s a

Instances

HasExternalDocs Tag (Maybe ExternalDocs)

HasExternalDocs Schema (Maybe ExternalDocs)

HasExternalDocs Operation (Maybe ExternalDocs)

HasExternalDocs Swagger (Maybe ExternalDocs)

class HasHost s a | s -> a where

Methods

host :: Lens' s a

Instances

HasHost Swagger (Maybe Host)

class HasInfo s a | s -> a where

Methods

info :: Lens' s a

Instances

HasInfo Swagger Info

class HasParameters s a | s -> a where

Methods

parameters :: Lens' s a

Instances

HasParameters Operation [Referenced Param]

HasParameters PathItem [Referenced Param]

HasParameters Swagger (Definitions Param)

class HasPaths s a | s -> a where

Methods

paths :: Lens' s a

Instances

HasPaths Swagger (HashMap FilePath PathItem)

class HasProduces s a | s -> a where

Methods

produces :: Lens' s a

Instances

HasProduces Swagger MimeList

HasProduces Operation (Maybe MimeList)

class HasResponses s a | s -> a where

Methods

responses :: Lens' s a

Instances

HasResponses Operation Responses

HasResponses Swagger (Definitions Response)

HasResponses Responses (HashMap HttpStatusCode (Referenced Response))

class HasSchemes s a | s -> a where

Methods

schemes :: Lens' s a

Instances

HasSchemes Operation (Maybe [Scheme])

HasSchemes Swagger (Maybe [Scheme])

class HasSecurity s a | s -> a where

Methods

security :: Lens' s a

Instances

HasSecurity Operation [SecurityRequirement]

HasSecurity Swagger [SecurityRequirement]

class HasSecurityDefinitions s a | s -> a where

Methods

securityDefinitions :: Lens' s a

Instances

HasSecurityDefinitions Swagger (Definitions SecurityScheme)

class HasTags s a | s -> a where

Methods

tags :: Lens' s a

Instances

HasTags Operation (Set TagName)

HasTags Swagger (Set Tag)

class HasName s a | s -> a where

Methods

name :: Lens' s a

Instances

HasName Tag TagName

HasName Param Text

HasName Host HostName

HasName License Text

HasName Xml (Maybe Text)

HasName NamedSchema (Maybe Text)

HasName Contact (Maybe Text)

class HasPort s a | s -> a where

Methods

port :: Lens' s a

Instances

HasPort Host (Maybe PortNumber)

class HasContact s a | s -> a where

Methods

contact :: Lens' s a

Instances

HasContact Info (Maybe Contact)

class HasDescription s a | s -> a where

Methods

description :: Lens' s a

Instances

HasDescription Response Text

HasDescription ExternalDocs (Maybe Text)

HasDescription Tag (Maybe Text)

HasDescription SecurityScheme (Maybe Text)

HasDescription Header (Maybe Text)

HasDescription Schema (Maybe Text)

HasDescription Param (Maybe Text)

HasDescription Operation (Maybe Text)

HasDescription Info (Maybe Text)

class HasLicense s a | s -> a where

Methods

license :: Lens' s a

Instances

HasLicense Info (Maybe License)

class HasTermsOfService s a | s -> a where

Methods

termsOfService :: Lens' s a

Instances

HasTermsOfService Info (Maybe Text)

class HasTitle s a | s -> a where

Methods

title :: Lens' s a

Instances

HasTitle Info Text

HasTitle Schema (Maybe Text)

class HasVersion s a | s -> a where

Methods

version :: Lens' s a

Instances

HasVersion Info Text

class HasEmail s a | s -> a where

Methods

email :: Lens' s a

Instances

HasEmail Contact (Maybe Text)

class HasUrl s a | s -> a where

Methods

url :: Lens' s a

Instances

HasUrl ExternalDocs URL

HasUrl License (Maybe URL)

HasUrl Contact (Maybe URL)

class HasDelete s a | s -> a where

Methods

delete :: Lens' s a

Instances

HasDelete PathItem (Maybe Operation)

class HasGet s a | s -> a where

Methods

get :: Lens' s a

Instances

HasGet PathItem (Maybe Operation)

class HasHead s a | s -> a where

Methods

head_ :: Lens' s a

Instances

HasHead PathItem (Maybe Operation)

class HasOptions s a | s -> a where

Methods

options :: Lens' s a

Instances

HasOptions PathItem (Maybe Operation)

class HasPatch s a | s -> a where

Methods

patch :: Lens' s a

Instances

HasPatch PathItem (Maybe Operation)

class HasPost s a | s -> a where

Methods

post :: Lens' s a

Instances

HasPost PathItem (Maybe Operation)

class HasPut s a | s -> a where

Methods

put :: Lens' s a

Instances

HasPut PathItem (Maybe Operation)

class HasDeprecated s a | s -> a where

Methods

deprecated :: Lens' s a

Instances

HasDeprecated Operation (Maybe Bool)

class HasOperationId s a | s -> a where

Methods

operationId :: Lens' s a

Instances

HasOperationId Operation (Maybe Text)

class HasSummary s a | s -> a where

Methods

summary :: Lens' s a

Instances

HasSummary Operation (Maybe Text)

class HasRequired s a | s -> a where

Methods

required :: Lens' s a

Instances

HasRequired Schema [ParamName]

HasRequired Param (Maybe Bool)

class HasSchema s a | s -> a where

Methods

schema :: Lens' s a

Instances

HasSchema NamedSchema Schema

HasSchema Param ParamAnySchema

HasSchema Response (Maybe (Referenced Schema))

class HasAllowEmptyValue s a | s -> a where

Methods

allowEmptyValue :: Lens' s a

Instances

HasAllowEmptyValue ParamOtherSchema (Maybe Bool)

class HasIn s a | s -> a where

Methods

in_ :: Lens' s a

Instances

HasIn ParamOtherSchema ParamLocation

class HasParamSchema s a | s -> a where

Methods

paramSchema :: Lens' s a

Instances

HasParamSchema Header (ParamSchema Header)

HasParamSchema NamedSchema (ParamSchema Schema)

HasParamSchema Schema (ParamSchema Schema)

HasParamSchema ParamOtherSchema (ParamSchema ParamOtherSchema)

class HasAdditionalProperties s a | s -> a where

Methods

additionalProperties :: Lens' s a

Instances

HasAdditionalProperties Schema (Maybe (Referenced Schema))

class HasAllOf s a | s -> a where

Methods

allOf :: Lens' s a

Instances

HasAllOf Schema (Maybe [Schema])

class HasDiscriminator s a | s -> a where

Methods

discriminator :: Lens' s a

Instances

HasDiscriminator Schema (Maybe Text)

class HasExample s a | s -> a where

Methods

example :: Lens' s a

Instances

HasExample Schema (Maybe Value)

class HasMaxProperties s a | s -> a where

Methods

maxProperties :: Lens' s a

Instances

HasMaxProperties Schema (Maybe Integer)

class HasMinProperties s a | s -> a where

Methods

minProperties :: Lens' s a

Instances

HasMinProperties Schema (Maybe Integer)

class HasProperties s a | s -> a where

Methods

properties :: Lens' s a

Instances

HasProperties Schema (HashMap Text (Referenced Schema))

class HasReadOnly s a | s -> a where

Methods

readOnly :: Lens' s a

Instances

HasReadOnly Schema (Maybe Bool)

class HasXml s a | s -> a where

Methods

xml :: Lens' s a

Instances

HasXml Schema (Maybe Xml)

class HasDefault s a | s -> a where

Methods

default_ :: Lens' s a

Instances

HasDefault Header (Maybe Value)

HasDefault Responses (Maybe (Referenced Response))

HasDefault Schema (Maybe Value)

HasDefault ParamOtherSchema (Maybe Value)

HasDefault (ParamSchema t) (Maybe Value)

class HasEnum s a | s -> a where

Methods

enum_ :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasEnum s (Maybe [Value])

HasEnum (ParamSchema t) (Maybe [Value])

class HasExclusiveMaximum s a | s -> a where

Methods

exclusiveMaximum :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasExclusiveMaximum s (Maybe Bool)

HasExclusiveMaximum (ParamSchema t) (Maybe Bool)

class HasExclusiveMinimum s a | s -> a where

Methods

exclusiveMinimum :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasExclusiveMinimum s (Maybe Bool)

HasExclusiveMinimum (ParamSchema t) (Maybe Bool)

class HasFormat s a | s -> a where

Methods

format :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasFormat s (Maybe Format)

HasFormat (ParamSchema t) (Maybe Format)

class HasItems s a | s -> a where

Methods

items :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasItems s (Maybe (SwaggerItems t))

HasItems (ParamSchema t) (Maybe (SwaggerItems t))

class HasMaxItems s a | s -> a where

Methods

maxItems :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMaxItems s (Maybe Integer)

HasMaxItems (ParamSchema t) (Maybe Integer)

class HasMaxLength s a | s -> a where

Methods

maxLength :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMaxLength s (Maybe Integer)

HasMaxLength (ParamSchema t) (Maybe Integer)

class HasMaximum s a | s -> a where

Methods

maximum_ :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMaximum s (Maybe Scientific)

HasMaximum (ParamSchema t) (Maybe Scientific)

class HasMinItems s a | s -> a where

Methods

minItems :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMinItems s (Maybe Integer)

HasMinItems (ParamSchema t) (Maybe Integer)

class HasMinLength s a | s -> a where

Methods

minLength :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMinLength s (Maybe Integer)

HasMinLength (ParamSchema t) (Maybe Integer)

class HasMinimum s a | s -> a where

Methods

minimum_ :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMinimum s (Maybe Scientific)

HasMinimum (ParamSchema t) (Maybe Scientific)

class HasMultipleOf s a | s -> a where

Methods

multipleOf :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasMultipleOf s (Maybe Scientific)

HasMultipleOf (ParamSchema t) (Maybe Scientific)

class HasPattern s a | s -> a where

Methods

pattern :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasPattern s (Maybe Text)

HasPattern (ParamSchema t) (Maybe Pattern)

class HasType s a | s -> a where

Methods

type_ :: Lens' s a

Instances

HasType SecurityScheme SecuritySchemeType

HasType Header (SwaggerType Header)

HasType NamedSchema (SwaggerType Schema)

HasType Schema (SwaggerType Schema)

HasType ParamOtherSchema (SwaggerType ParamOtherSchema)

HasType (ParamSchema t) (SwaggerType t)

class HasUniqueItems s a | s -> a where

Methods

uniqueItems :: Lens' s a

Instances

HasParamSchema s (ParamSchema t) => HasUniqueItems s (Maybe Bool)

HasUniqueItems (ParamSchema t) (Maybe Bool)

class HasAttribute s a | s -> a where

Methods

attribute :: Lens' s a

Instances

HasAttribute Xml (Maybe Bool)

class HasNamespace s a | s -> a where

Methods

namespace :: Lens' s a

Instances

HasNamespace Xml (Maybe Text)

class HasPrefix s a | s -> a where

Methods

prefix :: Lens' s a

Instances

HasPrefix Xml (Maybe Text)

class HasWrapped s a | s -> a where

Methods

wrapped :: Lens' s a

Instances

HasWrapped Xml (Maybe Bool)

class HasExamples s a | s -> a where

Methods

examples :: Lens' s a

Instances

HasExamples Response (Maybe Example)

class HasHeaders s a | s -> a where

Methods

headers :: Lens' s a

Instances

HasHeaders Response (HashMap HeaderName Header)

Prisms

ParamAnySchema prisms

_ParamOther :: Prism' ParamAnySchema ParamOtherSchema

_ParamBody :: Prism' ParamAnySchema (Referenced Schema)

SecuritySchemeType prisms

_SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Params

_SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams

_SecuritySchemeBasic :: Prism' SecuritySchemeType ()

Referenced prisms

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

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

SwaggerItems prisms

_SwaggerItemsArray :: forall t. (t ~ Schema) => Review (SwaggerItems t) [Referenced Schema]

_SwaggerItemsObject :: forall t. (t ~ Schema) => Review (SwaggerItems t) (Referenced Schema)

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