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

Data.OpenApi.Lens

Description

Lenses and prisms for Swagger.

Synopsis

Classy lenses

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

Methods

components :: Lens' s a Source #

Instances

Instances details
HasComponents OpenApi Components Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

info :: Lens' s a Source #

Instances

Instances details
HasInfo OpenApi Info Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

paths :: Lens' s a Source #

Instances

Instances details
HasPaths OpenApi (InsOrdHashMap FilePath PathItem) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

security :: Lens' s a Source #

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

Methods

servers :: Lens' s a Source #

Instances

Instances details
HasServers Operation [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers PathItem [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasServers OpenApi [Server] Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

tags :: Lens' s a Source #

Instances

Instances details
HasTags Operation (InsOrdHashSet TagName) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTags OpenApi (InsOrdHashSet Tag) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

links :: Lens' s a Source #

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

Methods

requestBodies :: Lens' s a Source #

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

Methods

schemas :: Lens' s a Source #

Instances

Instances details
HasSchemas Components (Definitions Schema) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

description :: Lens' s a Source #

Instances

Instances details
HasDescription Response Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription ExternalDocs (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Tag (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription SecurityScheme (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Header (Maybe HeaderName) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Schema (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Link (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Example (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Param (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription RequestBody (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription PathItem (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Server (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDescription Info (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

url :: Lens' s a Source #

Instances

Instances details
HasUrl ExternalDocs URL Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUrl Server Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUrl License (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUrl Contact (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

variables :: Lens' s a Source #

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

Methods

required :: Lens' s a Source #

Instances

Instances details
HasRequired Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired Schema [ParamName] Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasRequired RequestBody (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

encoding :: Lens' s a Source #

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

Methods

example :: Lens' s a Source #

Instances

Instances details
HasExample Header (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExample Schema (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExample Param (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExample MediaTypeObject (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

schema :: Lens' s a Source #

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

Methods

contact :: Lens' s a Source #

Instances

Instances details
HasContact Info (Maybe Contact) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

license :: Lens' s a Source #

Instances

Instances details
HasLicense Info (Maybe License) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Instances

Instances details
HasTermsOfService Info (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

title :: Lens' s a Source #

Instances

Instances details
HasTitle Info Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasTitle Schema (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

version :: Lens' s a Source #

Instances

Instances details
HasVersion Info Text Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

email :: Lens' s a Source #

Instances

Instances details
HasEmail Contact (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

name :: Lens' s a Source #

Instances

Instances details
HasName Tag TagName Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName Param Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName License Text Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName Xml (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName NamedSchema (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasName Contact (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

delete :: Lens' s a Source #

Instances

Instances details
HasDelete PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

get :: Lens' s a Source #

Instances

Instances details
HasGet PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

head_ :: Lens' s a Source #

Instances

Instances details
HasHead PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

options :: Lens' s a Source #

Instances

Instances details
HasOptions PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

patch :: Lens' s a Source #

Instances

Instances details
HasPatch PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

post :: Lens' s a Source #

Instances

Instances details
HasPost PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

put :: Lens' s a Source #

Instances

Instances details
HasPut PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

summary :: Lens' s a Source #

Instances

Instances details
HasSummary Example (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasSummary PathItem (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

trace :: Lens' s a Source #

Instances

Instances details
HasTrace PathItem (Maybe Operation) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

deprecated :: Lens' s a Source #

Instances

Instances details
HasDeprecated Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasDeprecated Operation (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

operationId :: Lens' s a Source #

Instances

Instances details
HasOperationId Link (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasOperationId Operation (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Instances

Instances details
HasAllowEmptyValue Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowEmptyValue Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

allowReserved :: Lens' s a Source #

Instances

Instances details
HasAllowReserved Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasAllowReserved Encoding (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

explode :: Lens' s a Source #

Instances

Instances details
HasExplode Header (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Param (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExplode Encoding (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

in_ :: Lens' s a Source #

Instances

Instances details
HasIn Param ParamLocation Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

style :: Lens' s a Source #

Instances

Instances details
HasStyle Param (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasStyle Encoding (Maybe Style) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

allOf :: Lens' s a Source #

Instances

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

Defined in Data.OpenApi.Lens

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

Methods

anyOf :: Lens' s a Source #

Instances

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

Defined in Data.OpenApi.Lens

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

Methods

default_ :: Lens' s a Source #

Instances

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

Defined in Data.OpenApi.Lens

HasDefault Schema (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

discriminator :: Lens' s a Source #

Instances

Instances details
HasDiscriminator Schema (Maybe Discriminator) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

enum_ :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasEnum s (Maybe [Value]) Source # 
Instance details

Defined in Data.OpenApi.Lens

Methods

enum_ :: Lens' s (Maybe [Value]) Source #

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

Defined in Data.OpenApi.Lens

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

Instances

Instances details
HasSchema s Schema => HasExclusiveMaximum s (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExclusiveMaximum Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Instances

Instances details
HasSchema s Schema => HasExclusiveMinimum s (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasExclusiveMinimum Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

format :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasFormat s (Maybe Format) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasFormat Schema (Maybe Format) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

items :: Lens' s a Source #

Instances

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

Defined in Data.OpenApi.Lens

HasItems Schema (Maybe OpenApiItems) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

maxItems :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMaxItems s (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaxItems Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

maxLength :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMaxLength s (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaxLength Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

maxProperties :: Lens' s a Source #

Instances

Instances details
HasMaxProperties Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

maximum_ :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMaximum s (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMaximum Schema (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

minItems :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMinItems s (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinItems Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

minLength :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMinLength s (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinLength Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

minProperties :: Lens' s a Source #

Instances

Instances details
HasMinProperties Schema (Maybe Integer) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

minimum_ :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMinimum s (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMinimum Schema (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

multipleOf :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasMultipleOf s (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasMultipleOf Schema (Maybe Scientific) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

not_ :: Lens' s a Source #

Instances

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

Defined in Data.OpenApi.Lens

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

Methods

nullable :: Lens' s a Source #

Instances

Instances details
HasNullable Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

oneOf :: Lens' s a Source #

Instances

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

Defined in Data.OpenApi.Lens

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

Methods

pattern :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasPattern s (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

Methods

pattern :: Lens' s (Maybe Text) Source #

HasPattern Schema (Maybe Pattern) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

properties :: Lens' s a Source #

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

Methods

readOnly :: Lens' s a Source #

Instances

Instances details
HasReadOnly Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

type_ :: Lens' s a Source #

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

Methods

uniqueItems :: Lens' s a Source #

Instances

Instances details
HasSchema s Schema => HasUniqueItems s (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

HasUniqueItems Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

writeOnly :: Lens' s a Source #

Instances

Instances details
HasWriteOnly Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

xml :: Lens' s a Source #

Instances

Instances details
HasXml Schema (Maybe Xml) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

attribute :: Lens' s a Source #

Instances

Instances details
HasAttribute Xml (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

namespace :: Lens' s a Source #

Instances

Instances details
HasNamespace Xml (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

prefix :: Lens' s a Source #

Instances

Instances details
HasPrefix Xml (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

wrapped :: Lens' s a Source #

Instances

Instances details
HasWrapped Xml (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

implicit :: Lens' s a Source #

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

Methods

password :: Lens' s a Source #

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

Methods

contentType :: Lens' s a Source #

Instances

Instances details
HasContentType Encoding (Maybe MediaType) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

externalValue :: Lens' s a Source #

Instances

Instances details
HasExternalValue Example (Maybe URL) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

value :: Lens' s a Source #

Instances

Instances details
HasValue Example (Maybe Value) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

mapping :: Lens' s a Source #

Instances

Instances details
HasMapping Discriminator (InsOrdHashMap Text Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

propertyName :: Lens' s a Source #

Instances

Instances details
HasPropertyName Discriminator Text Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

operationRef :: Lens' s a Source #

Instances

Instances details
HasOperationRef Link (Maybe Text) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

server :: Lens' s a Source #

Instances

Instances details
HasServer Link (Maybe Server) Source # 
Instance details

Defined in Data.OpenApi.Lens

Prisms

SecuritySchemeType prisms

Referenced prisms

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

OpenApiItems prisms

Orphan instances