| Maintainer | Nickolay Kudasov <nickolay@getshoptv.com> |
|---|---|
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell2010 |
Data.OpenApi.Lens
Description
Lenses and prisms for Swagger.
Synopsis
- class HasComponents s a | s -> a where
- components :: Lens' s a
- class HasExternalDocs s a | s -> a where
- externalDocs :: Lens' s a
- class HasInfo s a | s -> a where
- class HasPaths s a | s -> a where
- class HasSecurity s a | s -> a where
- class HasServers s a | s -> a where
- class HasTags s a | s -> a where
- class HasCallbacks s a | s -> a where
- class HasExamples s a | s -> a where
- class HasHeaders s a | s -> a where
- class HasLinks s a | s -> a where
- class HasParameters s a | s -> a where
- parameters :: Lens' s a
- class HasRequestBodies s a | s -> a where
- requestBodies :: Lens' s a
- class HasResponses s a | s -> a where
- class HasSchemas s a | s -> a where
- class HasSecuritySchemes s a | s -> a where
- securitySchemes :: Lens' s a
- class HasDescription s a | s -> a where
- description :: Lens' s a
- class HasUrl s a | s -> a where
- class HasVariables s a | s -> a where
- class HasContent s a | s -> a where
- class HasRequired s a | s -> a where
- class HasEncoding s a | s -> a where
- class HasExample s a | s -> a where
- class HasSchema s a | s -> a where
- class HasContact s a | s -> a where
- class HasLicense s a | s -> a where
- class HasTermsOfService s a | s -> a where
- termsOfService :: Lens' s a
- class HasTitle s a | s -> a where
- class HasVersion s a | s -> a where
- class HasEmail s a | s -> a where
- class HasName s a | s -> a where
- class HasDelete s a | s -> a where
- class HasGet s a | s -> a where
- class HasHead s a | s -> a where
- class HasOptions s a | s -> a where
- class HasPatch s a | s -> a where
- class HasPost s a | s -> a where
- class HasPut s a | s -> a where
- class HasSummary s a | s -> a where
- class HasTrace s a | s -> a where
- class HasDeprecated s a | s -> a where
- deprecated :: Lens' s a
- class HasOperationId s a | s -> a where
- operationId :: Lens' s a
- class HasRequestBody s a | s -> a where
- requestBody :: Lens' s a
- class HasAllowEmptyValue s a | s -> a where
- allowEmptyValue :: Lens' s a
- class HasAllowReserved s a | s -> a where
- allowReserved :: Lens' s a
- class HasExplode s a | s -> a where
- class HasIn s a | s -> a where
- class HasStyle s a | s -> a where
- class HasAdditionalProperties s a | s -> a where
- additionalProperties :: Lens' s a
- class HasAllOf s a | s -> a where
- class HasAnyOf s a | s -> a where
- class HasDefault s a | s -> a where
- class HasDiscriminator s a | s -> a where
- discriminator :: Lens' s a
- class HasEnum s a | s -> a where
- 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
- class HasItems s a | s -> a where
- class HasMaxItems s a | s -> a where
- class HasMaxLength s a | s -> a where
- class HasMaxProperties s a | s -> a where
- maxProperties :: Lens' s a
- class HasMaximum s a | s -> a where
- class HasMinItems s a | s -> a where
- class HasMinLength s a | s -> a where
- class HasMinProperties s a | s -> a where
- minProperties :: Lens' s a
- class HasMinimum s a | s -> a where
- class HasMultipleOf s a | s -> a where
- multipleOf :: Lens' s a
- class HasNot s a | s -> a where
- class HasNullable s a | s -> a where
- class HasOneOf s a | s -> a where
- class HasPattern s a | s -> a where
- class HasProperties s a | s -> a where
- properties :: Lens' s a
- class HasReadOnly s a | s -> a where
- class HasType s a | s -> a where
- class HasUniqueItems s a | s -> a where
- uniqueItems :: Lens' s a
- class HasWriteOnly s a | s -> a where
- class HasXml s a | s -> a where
- class HasAttribute s a | s -> a where
- class HasNamespace s a | s -> a where
- class HasPrefix s a | s -> a where
- class HasWrapped s a | s -> a where
- class HasAuthorizationUrl s a | s -> a where
- authorizationUrl :: Lens' s a
- class HasTokenUrl s a | s -> a where
- class HasAuthorizationCode s a | s -> a where
- authorizationCode :: Lens' s a
- class HasClientCredentials s a | s -> a where
- clientCredentials :: Lens' s a
- class HasImplicit s a | s -> a where
- class HasPassword s a | s -> a where
- class HasContentType s a | s -> a where
- contentType :: Lens' s a
- class HasExternalValue s a | s -> a where
- externalValue :: Lens' s a
- class HasValue s a | s -> a where
- class HasMapping s a | s -> a where
- class HasPropertyName s a | s -> a where
- propertyName :: Lens' s a
- class HasOperationRef s a | s -> a where
- operationRef :: Lens' s a
- class HasServer s a | s -> a where
- _SecuritySchemeOpenIdConnect :: Prism' SecuritySchemeType URL
- _SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Flows
- _SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams
- _SecuritySchemeHttp :: Prism' SecuritySchemeType ()
- _Inline :: forall a a. Prism (Referenced a) (Referenced a) a a
- _Ref :: forall a. Prism' (Referenced a) Reference
- _OpenApiItemsArray :: Review OpenApiItems [Referenced Schema]
- _OpenApiItemsObject :: Review OpenApiItems (Referenced Schema)
Classy lenses
class HasComponents s a | s -> a where Source #
Methods
components :: Lens' s a Source #
Instances
| HasComponents OpenApi Components Source # | |
Defined in Data.OpenApi.Lens Methods | |
class HasExternalDocs s a | s -> a where Source #
Methods
externalDocs :: Lens' s a Source #
Instances
| HasExternalDocs Tag (Maybe ExternalDocs) Source # | |
Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Tag (Maybe ExternalDocs) Source # | |
| HasExternalDocs Schema (Maybe ExternalDocs) Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasExternalDocs Operation (Maybe ExternalDocs) Source # | |
Defined in Data.OpenApi.Lens Methods externalDocs :: Lens' Operation (Maybe ExternalDocs) Source # | |
| HasExternalDocs OpenApi (Maybe ExternalDocs) Source # | |
Defined in Data.OpenApi.Lens Methods | |
class HasSecurity s a | s -> a where Source #
Instances
| HasSecurity Operation [SecurityRequirement] Source # | |
Defined in Data.OpenApi.Lens | |
| HasSecurity OpenApi [SecurityRequirement] Source # | |
Defined in Data.OpenApi.Lens | |
class HasServers s a | s -> a where Source #
Instances
class HasTags s a | s -> a where Source #
Instances
| HasTags Operation (InsOrdHashSet TagName) Source # | |
Defined in Data.OpenApi.Lens | |
| HasTags OpenApi (InsOrdHashSet Tag) Source # | |
Defined in Data.OpenApi.Lens | |
class HasCallbacks s a | s -> a where Source #
Instances
| HasCallbacks Components (Definitions Callback) Source # | |
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Components (Definitions Callback) Source # | |
| HasCallbacks Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |
Defined in Data.OpenApi.Lens Methods callbacks :: Lens' Operation (InsOrdHashMap Text (Referenced Callback)) Source # | |
class HasExamples s a | s -> a where Source #
Instances
| HasExamples Components (Definitions Example) Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasExamples Header (InsOrdHashMap Text (Referenced Example)) Source # | |
Defined in Data.OpenApi.Lens Methods examples :: Lens' Header (InsOrdHashMap Text (Referenced Example)) Source # | |
| HasExamples Param (InsOrdHashMap Text (Referenced Example)) Source # | |
Defined in Data.OpenApi.Lens Methods examples :: Lens' Param (InsOrdHashMap Text (Referenced Example)) Source # | |
| HasExamples MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |
Defined in Data.OpenApi.Lens Methods examples :: Lens' MediaTypeObject (InsOrdHashMap Text (Referenced Example)) Source # | |
class HasHeaders s a | s -> a where Source #
Instances
| HasHeaders Components (Definitions Header) Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasHeaders Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |
Defined in Data.OpenApi.Lens Methods headers :: Lens' Response (InsOrdHashMap HeaderName (Referenced Header)) Source # | |
| HasHeaders Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |
Defined in Data.OpenApi.Lens Methods headers :: Lens' Encoding (InsOrdHashMap Text (Referenced Header)) Source # | |
class HasLinks s a | s -> a where Source #
Instances
| HasLinks Components (Definitions Link) Source # | |
Defined in Data.OpenApi.Lens Methods links :: Lens' Components (Definitions Link) Source # | |
| HasLinks Response (InsOrdHashMap Text (Referenced Link)) Source # | |
Defined in Data.OpenApi.Lens Methods links :: Lens' Response (InsOrdHashMap Text (Referenced Link)) Source # | |
class HasParameters s a | s -> a where Source #
Methods
parameters :: Lens' s a Source #
Instances
| HasParameters Operation [Referenced Param] Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasParameters PathItem [Referenced Param] Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasParameters Components (Definitions Param) Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasParameters Link (InsOrdHashMap Text ExpressionOrValue) Source # | |
Defined in Data.OpenApi.Lens Methods parameters :: Lens' Link (InsOrdHashMap Text ExpressionOrValue) Source # | |
class HasRequestBodies s a | s -> a where Source #
Methods
requestBodies :: Lens' s a Source #
Instances
| HasRequestBodies Components (Definitions RequestBody) Source # | |
Defined in Data.OpenApi.Lens Methods requestBodies :: Lens' Components (Definitions RequestBody) Source # | |
class HasResponses s a | s -> a where Source #
Instances
| HasResponses Operation Responses Source # | |
| HasResponses Components (Definitions Response) Source # | |
Defined in Data.OpenApi.Lens Methods responses :: Lens' Components (Definitions Response) Source # | |
| HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
Defined in Data.OpenApi.Lens Methods responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
class HasSchemas s a | s -> a where Source #
Instances
| HasSchemas Components (Definitions Schema) Source # | |
Defined in Data.OpenApi.Lens Methods | |
class HasSecuritySchemes s a | s -> a where Source #
Methods
securitySchemes :: Lens' s a Source #
Instances
| HasSecuritySchemes Components (Definitions SecurityScheme) Source # | |
Defined in Data.OpenApi.Lens Methods securitySchemes :: Lens' Components (Definitions SecurityScheme) Source # | |
class HasDescription s a | s -> a where Source #
Methods
description :: Lens' s a Source #
Instances
class HasVariables s a | s -> a where Source #
Instances
| HasVariables Server (InsOrdHashMap Text ServerVariable) Source # | |
Defined in Data.OpenApi.Lens Methods variables :: Lens' Server (InsOrdHashMap Text ServerVariable) Source # | |
class HasContent s a | s -> a where Source #
Instances
| HasContent Response (InsOrdHashMap MediaType MediaTypeObject) Source # | |
Defined in Data.OpenApi.Lens Methods content :: Lens' Response (InsOrdHashMap MediaType MediaTypeObject) Source # | |
| HasContent RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # | |
Defined in Data.OpenApi.Lens Methods content :: Lens' RequestBody (InsOrdHashMap MediaType MediaTypeObject) Source # | |
class HasRequired s a | s -> a where Source #
Instances
| HasRequired Header (Maybe Bool) Source # | |
| HasRequired Schema [ParamName] Source # | |
| HasRequired Param (Maybe Bool) Source # | |
| HasRequired RequestBody (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasEncoding s a | s -> a where Source #
Instances
| HasEncoding MediaTypeObject (InsOrdHashMap Text Encoding) Source # | |
Defined in Data.OpenApi.Lens Methods encoding :: Lens' MediaTypeObject (InsOrdHashMap Text Encoding) Source # | |
class HasExample s a | s -> a where Source #
Instances
| HasExample Header (Maybe Value) Source # | |
| HasExample Schema (Maybe Value) Source # | |
| HasExample Param (Maybe Value) Source # | |
| HasExample MediaTypeObject (Maybe Value) Source # | |
Defined in Data.OpenApi.Lens | |
class HasSchema s a | s -> a where Source #
Instances
| HasSchema NamedSchema Schema Source # | |
Defined in Data.OpenApi.Lens | |
| HasSchema Header (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasSchema Param (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasSchema MediaTypeObject (Maybe (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens Methods schema :: Lens' MediaTypeObject (Maybe (Referenced Schema)) Source # | |
class HasContact s a | s -> a where Source #
class HasLicense s a | s -> a where Source #
class HasTermsOfService s a | s -> a where Source #
Methods
termsOfService :: Lens' s a Source #
Instances
| HasTermsOfService Info (Maybe Text) Source # | |
Defined in Data.OpenApi.Lens | |
class HasVersion s a | s -> a where Source #
class HasOptions s a | s -> a where Source #
class HasSummary s a | s -> a where Source #
class HasDeprecated s a | s -> a where Source #
Methods
deprecated :: Lens' s a Source #
Instances
| HasDeprecated Header (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasDeprecated Schema (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasDeprecated Param (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasDeprecated Operation (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasOperationId s a | s -> a where Source #
Methods
operationId :: Lens' s a Source #
Instances
| HasOperationId Link (Maybe Text) Source # | |
Defined in Data.OpenApi.Lens | |
| HasOperationId Operation (Maybe Text) Source # | |
Defined in Data.OpenApi.Lens | |
class HasRequestBody s a | s -> a where Source #
Methods
requestBody :: Lens' s a Source #
Instances
| HasRequestBody Link (Maybe ExpressionOrValue) Source # | |
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Link (Maybe ExpressionOrValue) Source # | |
| HasRequestBody Operation (Maybe (Referenced RequestBody)) Source # | |
Defined in Data.OpenApi.Lens Methods requestBody :: Lens' Operation (Maybe (Referenced RequestBody)) Source # | |
class HasAllowEmptyValue s a | s -> a where Source #
Methods
allowEmptyValue :: Lens' s a Source #
Instances
| HasAllowEmptyValue Header (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasAllowEmptyValue Param (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasAllowReserved s a | s -> a where Source #
Methods
allowReserved :: Lens' s a Source #
Instances
| HasAllowReserved Param (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasAllowReserved Encoding (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasExplode s a | s -> a where Source #
class HasIn s a | s -> a where Source #
Instances
| HasIn Param ParamLocation Source # | |
Defined in Data.OpenApi.Lens | |
class HasAdditionalProperties s a | s -> a where Source #
Methods
additionalProperties :: Lens' s a Source #
Instances
| HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # | |
Defined in Data.OpenApi.Lens Methods additionalProperties :: Lens' Schema (Maybe AdditionalProperties) Source # | |
class HasDefault s a | s -> a where Source #
Instances
| HasDefault Responses (Maybe (Referenced Response)) Source # | |
Defined in Data.OpenApi.Lens | |
| HasDefault Schema (Maybe Value) Source # | |
class HasDiscriminator s a | s -> a where Source #
Methods
discriminator :: Lens' s a Source #
Instances
| HasDiscriminator Schema (Maybe Discriminator) Source # | |
Defined in Data.OpenApi.Lens Methods discriminator :: Lens' Schema (Maybe Discriminator) Source # | |
class HasExclusiveMaximum s a | s -> a where Source #
Methods
exclusiveMaximum :: Lens' s a Source #
Instances
| HasSchema s Schema => HasExclusiveMaximum s (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasExclusiveMaximum Schema (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasExclusiveMinimum s a | s -> a where Source #
Methods
exclusiveMinimum :: Lens' s a Source #
Instances
| HasSchema s Schema => HasExclusiveMinimum s (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
| HasExclusiveMinimum Schema (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasItems s a | s -> a where Source #
Instances
| HasSchema s Schema => HasItems s (Maybe OpenApiItems) Source # | |
Defined in Data.OpenApi.Lens | |
| HasItems Schema (Maybe OpenApiItems) Source # | |
Defined in Data.OpenApi.Lens | |
class HasMaxItems s a | s -> a where Source #
class HasMaxLength s a | s -> a where Source #
class HasMaxProperties s a | s -> a where Source #
Methods
maxProperties :: Lens' s a Source #
Instances
| HasMaxProperties Schema (Maybe Integer) Source # | |
Defined in Data.OpenApi.Lens | |
class HasMaximum s a | s -> a where Source #
Instances
| HasSchema s Schema => HasMaximum s (Maybe Scientific) Source # | |
Defined in Data.OpenApi.Lens | |
| HasMaximum Schema (Maybe Scientific) Source # | |
Defined in Data.OpenApi.Lens | |
class HasMinItems s a | s -> a where Source #
class HasMinLength s a | s -> a where Source #
class HasMinProperties s a | s -> a where Source #
Methods
minProperties :: Lens' s a Source #
Instances
| HasMinProperties Schema (Maybe Integer) Source # | |
Defined in Data.OpenApi.Lens | |
class HasMinimum s a | s -> a where Source #
Instances
| HasSchema s Schema => HasMinimum s (Maybe Scientific) Source # | |
Defined in Data.OpenApi.Lens | |
| HasMinimum Schema (Maybe Scientific) Source # | |
Defined in Data.OpenApi.Lens | |
class HasMultipleOf s a | s -> a where Source #
Methods
multipleOf :: Lens' s a Source #
Instances
| HasSchema s Schema => HasMultipleOf s (Maybe Scientific) Source # | |
Defined in Data.OpenApi.Lens Methods multipleOf :: Lens' s (Maybe Scientific) Source # | |
| HasMultipleOf Schema (Maybe Scientific) Source # | |
Defined in Data.OpenApi.Lens Methods multipleOf :: Lens' Schema (Maybe Scientific) Source # | |
class HasNullable s a | s -> a where Source #
class HasPattern s a | s -> a where Source #
class HasProperties s a | s -> a where Source #
Methods
properties :: Lens' s a Source #
Instances
| HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
Defined in Data.OpenApi.Lens Methods properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
class HasReadOnly s a | s -> a where Source #
class HasType s a | s -> a where Source #
Instances
| HasType SecurityScheme SecuritySchemeType Source # | |
Defined in Data.OpenApi.Lens Methods | |
| HasType NamedSchema (Maybe OpenApiType) Source # | |
Defined in Data.OpenApi.Lens Methods type_ :: Lens' NamedSchema (Maybe OpenApiType) Source # | |
| HasType Schema (Maybe OpenApiType) Source # | |
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 # | |
Defined in Data.OpenApi.Lens | |
| HasUniqueItems Schema (Maybe Bool) Source # | |
Defined in Data.OpenApi.Lens | |
class HasWriteOnly s a | s -> a where Source #
class HasAttribute s a | s -> a where Source #
class HasNamespace s a | s -> a where Source #
class HasWrapped s a | s -> a where Source #
class HasAuthorizationUrl s a | s -> a where Source #
Methods
authorizationUrl :: Lens' s a Source #
Instances
class HasTokenUrl s a | s -> a where Source #
Instances
class HasAuthorizationCode s a | s -> a where Source #
Methods
authorizationCode :: Lens' s a Source #
Instances
class HasClientCredentials s a | s -> a where Source #
Methods
clientCredentials :: Lens' s a Source #
Instances
class HasImplicit s a | s -> a where Source #
Instances
| HasImplicit OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |
Defined in Data.OpenApi.Lens Methods implicit :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2ImplicitFlow)) Source # | |
class HasPassword s a | s -> a where Source #
Instances
| HasPassword OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |
Defined in Data.OpenApi.Lens Methods password :: Lens' OAuth2Flows (Maybe (OAuth2Flow OAuth2PasswordFlow)) Source # | |
class HasContentType s a | s -> a where Source #
Methods
contentType :: Lens' s a Source #
Instances
| HasContentType Encoding (Maybe MediaType) Source # | |
Defined in Data.OpenApi.Lens | |
class HasExternalValue s a | s -> a where Source #
Methods
externalValue :: Lens' s a Source #
Instances
| HasExternalValue Example (Maybe URL) Source # | |
Defined in Data.OpenApi.Lens | |
class HasMapping s a | s -> a where Source #
Instances
| HasMapping Discriminator (InsOrdHashMap Text Text) Source # | |
Defined in Data.OpenApi.Lens Methods mapping :: Lens' Discriminator (InsOrdHashMap Text Text) Source # | |
class HasPropertyName s a | s -> a where Source #
Methods
propertyName :: Lens' s a Source #
Instances
| HasPropertyName Discriminator Text Source # | |
Defined in Data.OpenApi.Lens Methods | |
class HasOperationRef s a | s -> a where Source #
Methods
operationRef :: Lens' s a Source #
Instances
| HasOperationRef Link (Maybe Text) Source # | |
Defined in Data.OpenApi.Lens | |
Prisms
SecuritySchemeType prisms
Referenced prisms
_Inline :: forall a a. Prism (Referenced a) (Referenced a) a a Source #