openapi3-3.0.0.1: OpenAPI 3.0 data model

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

Data.OpenApi.Lens

Contents

Description

Lenses and prisms for Swagger.

Synopsis

Classy lenses

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

Methods

components :: Lens' s a Source #

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

Methods

info :: Lens' s a Source #

Instances
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 #

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

Methods

servers :: Lens' s a Source #

Instances
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 #

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

Methods

links :: Lens' s a Source #

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

Methods

schemas :: Lens' s a 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.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
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 HasRequired s a | s -> a where Source #

Methods

required :: Lens' s a Source #

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

Methods

example :: Lens' s a 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.OpenApi.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.OpenApi.Lens

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

Instances
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
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
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
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
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
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
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
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
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
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
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
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
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
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 #

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

Methods

operationId :: Lens' s a Source #

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

Methods

allowReserved :: Lens' s a Source #

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

Methods

explode :: Lens' s a Source #

Instances
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
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
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
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
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 #

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

Methods

discriminator :: Lens' s a Source #

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

Methods

enum_ :: Lens' s a Source #

Instances
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 #

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

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

Methods

format :: Lens' s a Source #

Instances
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
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
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
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 #

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

Methods

maximum_ :: Lens' s a Source #

Instances
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
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
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 #

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

Methods

minimum_ :: Lens' s a Source #

Instances
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 #

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

Methods

not_ :: Lens' s a Source #

Instances
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
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
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
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 HasReadOnly s a | s -> a where Source #

Methods

readOnly :: Lens' s a Source #

Instances
HasReadOnly Schema (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

uniqueItems :: Lens' s a Source #

Instances
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
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
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
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
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
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
HasWrapped Xml (Maybe Bool) Source # 
Instance details

Defined in Data.OpenApi.Lens

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

Methods

contentType :: Lens' s a Source #

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

Methods

externalValue :: Lens' s a Source #

Instances
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
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 #

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

Methods

propertyName :: Lens' s a Source #

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

Methods

operationRef :: Lens' s a Source #

Instances
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
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