swagger2-2.3.1.1: Swagger 2.0 data model

MaintainerNickolay Kudasov <nickolay@getshoptv.com>
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Data.Swagger.Lens

Contents

Description

Lenses and prisms for Swagger.

Synopsis

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

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

Methods

consumes :: Lens' s a Source #

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

Methods

definitions :: Lens' s a 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

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

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

Methods

paths :: Lens' s a Source #

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

Methods

produces :: Lens' s a 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

HasSchemes Swagger (Maybe [Scheme]) Source # 
Instance details

Defined in Data.Swagger.Lens

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

Methods

tags :: Lens' s a Source #

Instances
HasTags Operation (Set TagName) Source # 
Instance details

Defined in Data.Swagger.Lens

HasTags Swagger (Set Tag) Source # 
Instance details

Defined in Data.Swagger.Lens

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

HasName Param Text Source # 
Instance details

Defined in Data.Swagger.Lens

HasName Host HostName Source # 
Instance details

Defined in Data.Swagger.Lens

HasName License Text Source # 
Instance details

Defined in Data.Swagger.Lens

HasName Xml (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasName NamedSchema (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

HasName Contact (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

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

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

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

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

Instances
HasTermsOfService Info (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

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

HasTitle Schema (Maybe Text) Source # 
Instance details

Defined in Data.Swagger.Lens

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

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

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

HasUrl License (Maybe URL) Source # 
Instance details

Defined in Data.Swagger.Lens

HasUrl Contact (Maybe URL) Source # 
Instance details

Defined in Data.Swagger.Lens

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

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

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

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

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

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

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

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

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

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

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

HasRequired Param (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

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

Methods

schema :: Lens' s a Source #

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

Methods

in_ :: Lens' s a 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

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

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

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

Methods

maxProperties :: Lens' s a Source #

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

Methods

minProperties :: Lens' s a 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

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

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

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

class HasExclusiveMinimum s a | s -> a where 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

HasFormat (ParamSchema t) (Maybe Format) Source # 
Instance details

Defined in Data.Swagger.Lens

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

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

HasMaxItems (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

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

HasMaxLength (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

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

Methods

maximum_ :: Lens' s a 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

HasMinItems (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

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

HasMinLength (ParamSchema t) (Maybe Integer) Source # 
Instance details

Defined in Data.Swagger.Lens

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

Methods

minimum_ :: Lens' s a Source #

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

Methods

multipleOf :: Lens' s a 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

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

HasUniqueItems (ParamSchema t) (Maybe Bool) Source # 
Instance details

Defined in Data.Swagger.Lens

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

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

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

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

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

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

Methods

headers :: Lens' s a Source #

Prisms

ParamAnySchema prisms

SecuritySchemeType prisms

Referenced prisms

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

SwaggerItems prisms

Orphan instances