Maintainer | Nickolay Kudasov <nickolay@getshoptv.com> |
---|---|
Stability | experimental |
Safe Haskell | None |
Language | Haskell2010 |
Lenses and prisms for Swagger.
Synopsis
- class HasBasePath s a | s -> a where
- basePath :: Lens' s a
- class HasConsumes s a | s -> a where
- consumes :: Lens' s a
- class HasDefinitions s a | s -> a where
- definitions :: Lens' s a
- class HasExternalDocs s a | s -> a where
- externalDocs :: Lens' s a
- class HasHost s a | s -> a where
- host :: Lens' s a
- class HasInfo s a | s -> a where
- info :: Lens' s a
- class HasParameters s a | s -> a where
- parameters :: Lens' s a
- class HasPaths s a | s -> a where
- paths :: Lens' s a
- class HasProduces s a | s -> a where
- produces :: Lens' s a
- class HasResponses s a | s -> a where
- responses :: Lens' s a
- class HasSchemes s a | s -> a where
- schemes :: Lens' s a
- class HasSecurity s a | s -> a where
- security :: Lens' s a
- class HasSecurityDefinitions s a | s -> a where
- securityDefinitions :: Lens' s a
- class HasTags s a | s -> a where
- tags :: Lens' s a
- class HasName s a | s -> a where
- name :: Lens' s a
- class HasPort s a | s -> a where
- port :: Lens' s a
- class HasContact s a | s -> a where
- contact :: Lens' s a
- class HasDescription s a | s -> a where
- description :: Lens' s a
- class HasLicense s a | s -> a where
- license :: Lens' s a
- class HasTermsOfService s a | s -> a where
- termsOfService :: Lens' s a
- class HasTitle s a | s -> a where
- title :: Lens' s a
- class HasVersion s a | s -> a where
- version :: Lens' s a
- class HasEmail s a | s -> a where
- email :: Lens' s a
- class HasUrl s a | s -> a where
- url :: Lens' s a
- class HasDelete s a | s -> a where
- delete :: Lens' s a
- class HasGet s a | s -> a where
- get :: Lens' s a
- class HasHead s a | s -> a where
- head_ :: Lens' s a
- class HasOptions s a | s -> a where
- options :: Lens' s a
- class HasPatch s a | s -> a where
- patch :: Lens' s a
- class HasPost s a | s -> a where
- post :: Lens' s a
- class HasPut s a | s -> a where
- put :: Lens' s a
- class HasDeprecated s a | s -> a where
- deprecated :: Lens' s a
- class HasExtensions s a | s -> a where
- extensions :: Lens' s a
- class HasOperationId s a | s -> a where
- operationId :: Lens' s a
- class HasSummary s a | s -> a where
- summary :: Lens' s a
- class HasRequired s a | s -> a where
- required :: Lens' s a
- class HasSchema s a | s -> a where
- schema :: Lens' s a
- class HasAllowEmptyValue s a | s -> a where
- allowEmptyValue :: Lens' s a
- class HasIn s a | s -> a where
- in_ :: Lens' s a
- class HasParamSchema s a | s -> a where
- paramSchema :: Lens' s a
- class HasAdditionalProperties s a | s -> a where
- additionalProperties :: Lens' s a
- class HasAllOf s a | s -> a where
- allOf :: Lens' s a
- class HasDiscriminator s a | s -> a where
- discriminator :: Lens' s a
- class HasExample s a | s -> a where
- example :: Lens' s a
- class HasMaxProperties s a | s -> a where
- maxProperties :: Lens' s a
- class HasMinProperties s a | s -> a where
- minProperties :: Lens' s a
- class HasProperties s a | s -> a where
- properties :: Lens' s a
- class HasReadOnly s a | s -> a where
- readOnly :: Lens' s a
- class HasXml s a | s -> a where
- xml :: Lens' s a
- class HasDefault s a | s -> a where
- default_ :: Lens' s a
- class HasEnum s a | s -> a where
- enum_ :: Lens' s a
- 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
- format :: Lens' s a
- class HasItems s a | s -> a where
- items :: Lens' s a
- class HasMaxItems s a | s -> a where
- maxItems :: Lens' s a
- class HasMaxLength s a | s -> a where
- maxLength :: Lens' s a
- class HasMaximum s a | s -> a where
- maximum_ :: Lens' s a
- class HasMinItems s a | s -> a where
- minItems :: Lens' s a
- class HasMinLength s a | s -> a where
- minLength :: Lens' s a
- class HasMinimum s a | s -> a where
- minimum_ :: Lens' s a
- class HasMultipleOf s a | s -> a where
- multipleOf :: Lens' s a
- class HasPattern s a | s -> a where
- pattern :: Lens' s a
- class HasType s a | s -> a where
- type_ :: Lens' s a
- class HasUniqueItems s a | s -> a where
- uniqueItems :: Lens' s a
- class HasAttribute s a | s -> a where
- attribute :: Lens' s a
- class HasNamespace s a | s -> a where
- namespace :: Lens' s a
- class HasPrefix s a | s -> a where
- prefix :: Lens' s a
- class HasWrapped s a | s -> a where
- wrapped :: Lens' s a
- class HasExamples s a | s -> a where
- examples :: Lens' s a
- class HasHeaders s a | s -> a where
- headers :: Lens' s a
- _ParamOther :: Prism' ParamAnySchema ParamOtherSchema
- _ParamBody :: Prism' ParamAnySchema (Referenced Schema)
- _SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Params
- _SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams
- _SecuritySchemeBasic :: Prism' SecuritySchemeType ()
- _Inline :: forall a a. Prism (Referenced a) (Referenced a) a a
- _Ref :: forall a. Prism' (Referenced a) Reference
- _SwaggerItemsArray :: Review (SwaggerItems 'SwaggerKindSchema) [Referenced Schema]
- _SwaggerItemsObject :: Review (SwaggerItems 'SwaggerKindSchema) (Referenced Schema)
- _SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t)
Classy lenses
class HasBasePath s a | s -> a where Source #
class HasConsumes s a | s -> a where Source #
class HasDefinitions s a | s -> a where Source #
definitions :: Lens' s a Source #
Instances
HasDefinitions Swagger (Definitions Schema) Source # | |
Defined in Data.Swagger.Lens definitions :: Lens' Swagger (Definitions Schema) Source # |
class HasExternalDocs s a | s -> a where Source #
externalDocs :: Lens' s a Source #
Instances
HasExternalDocs Tag (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Tag (Maybe ExternalDocs) Source # | |
HasExternalDocs Schema (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Schema (Maybe ExternalDocs) Source # | |
HasExternalDocs Operation (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Operation (Maybe ExternalDocs) Source # | |
HasExternalDocs Swagger (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source # |
class HasParameters s a | s -> a where Source #
parameters :: Lens' s a Source #
Instances
HasParameters Operation [Referenced Param] Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' Operation [Referenced Param] Source # | |
HasParameters PathItem [Referenced Param] Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' PathItem [Referenced Param] Source # | |
HasParameters Swagger (Definitions Param) Source # | |
Defined in Data.Swagger.Lens parameters :: Lens' Swagger (Definitions Param) Source # |
class HasProduces s a | s -> a where Source #
class HasResponses s a | s -> a where Source #
Instances
HasResponses Operation Responses Source # | |
HasResponses Swagger (Definitions Response) Source # | |
Defined in Data.Swagger.Lens | |
HasResponses Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # | |
Defined in Data.Swagger.Lens responses :: Lens' Responses (InsOrdHashMap HttpStatusCode (Referenced Response)) Source # |
class HasSchemes s a | s -> a where Source #
class HasSecurity s a | s -> a where Source #
Instances
HasSecurity Operation [SecurityRequirement] Source # | |
Defined in Data.Swagger.Lens security :: Lens' Operation [SecurityRequirement] Source # | |
HasSecurity Swagger [SecurityRequirement] Source # | |
Defined in Data.Swagger.Lens security :: Lens' Swagger [SecurityRequirement] Source # |
class HasSecurityDefinitions s a | s -> a where Source #
securityDefinitions :: Lens' s a Source #
Instances
class HasContact s a | s -> a where Source #
class HasDescription s a | s -> a where Source #
description :: Lens' s a Source #
Instances
HasDescription Response Text Source # | |
Defined in Data.Swagger.Lens description :: Lens' Response Text Source # | |
HasDescription ExternalDocs (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' ExternalDocs (Maybe Text) Source # | |
HasDescription Tag (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasDescription SecurityScheme (Maybe Text) Source # | |
Defined in Data.Swagger.Lens description :: Lens' SecurityScheme (Maybe Text) Source # | |
HasDescription Header (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasDescription Schema (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasDescription Param (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasDescription Operation (Maybe Text) Source # | |
Defined in Data.Swagger.Lens | |
HasDescription Info (Maybe Text) Source # | |
Defined in Data.Swagger.Lens |
class HasLicense s a | s -> a where Source #
class HasTermsOfService s a | s -> a where Source #
termsOfService :: Lens' s a Source #
Instances
HasTermsOfService Info (Maybe Text) Source # | |
Defined in Data.Swagger.Lens |
class HasVersion s a | s -> a where Source #
class HasOptions s a | s -> a where Source #
class HasDeprecated s a | s -> a where Source #
deprecated :: Lens' s a Source #
Instances
HasDeprecated Operation (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens |
class HasExtensions s a | s -> a where Source #
extensions :: Lens' s a Source #
Instances
HasExtensions Operation (InsOrdHashMap Text Value) Source # | |
Defined in Data.Swagger.Lens extensions :: Lens' Operation (InsOrdHashMap Text Value) Source # |
class HasOperationId s a | s -> a where Source #
operationId :: Lens' s a Source #
Instances
HasOperationId Operation (Maybe Text) Source # | |
Defined in Data.Swagger.Lens |
class HasSummary s a | s -> a where Source #
class HasRequired s a | s -> a where Source #
class HasSchema s a | s -> a where Source #
Instances
HasSchema NamedSchema Schema Source # | |
Defined in Data.Swagger.Lens schema :: Lens' NamedSchema Schema Source # | |
HasSchema Param ParamAnySchema Source # | |
Defined in Data.Swagger.Lens schema :: Lens' Param ParamAnySchema Source # | |
HasSchema Response (Maybe (Referenced Schema)) Source # | |
Defined in Data.Swagger.Lens |
class HasAllowEmptyValue s a | s -> a where Source #
allowEmptyValue :: Lens' s a Source #
Instances
HasAllowEmptyValue ParamOtherSchema (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens allowEmptyValue :: Lens' ParamOtherSchema (Maybe Bool) Source # |
class HasIn s a | s -> a where Source #
Instances
HasIn ParamOtherSchema ParamLocation Source # | |
Defined in Data.Swagger.Lens in_ :: Lens' ParamOtherSchema ParamLocation Source # |
class HasParamSchema s a | s -> a where Source #
paramSchema :: Lens' s a Source #
Instances
HasParamSchema Header (ParamSchema ('SwaggerKindNormal Header)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' Header (ParamSchema ('SwaggerKindNormal Header)) Source # | |
HasParamSchema NamedSchema (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' NamedSchema (ParamSchema 'SwaggerKindSchema) Source # | |
HasParamSchema Schema (ParamSchema ('SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens paramSchema :: Lens' Schema (ParamSchema 'SwaggerKindSchema) Source # | |
HasParamSchema ParamOtherSchema (ParamSchema ('SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens |
class HasAdditionalProperties s a | s -> a where Source #
additionalProperties :: Lens' s a Source #
Instances
HasAdditionalProperties Schema (Maybe AdditionalProperties) Source # | |
Defined in Data.Swagger.Lens additionalProperties :: Lens' Schema (Maybe AdditionalProperties) Source # |
class HasAllOf s a | s -> a where Source #
Instances
HasAllOf Schema (Maybe [Referenced Schema]) Source # | |
Defined in Data.Swagger.Lens |
class HasDiscriminator s a | s -> a where Source #
discriminator :: Lens' s a Source #
Instances
HasDiscriminator Schema (Maybe Text) Source # | |
Defined in Data.Swagger.Lens |
class HasExample s a | s -> a where Source #
class HasMaxProperties s a | s -> a where Source #
maxProperties :: Lens' s a Source #
Instances
HasMaxProperties Schema (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens |
class HasMinProperties s a | s -> a where Source #
minProperties :: Lens' s a Source #
Instances
HasMinProperties Schema (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens |
class HasProperties s a | s -> a where Source #
properties :: Lens' s a Source #
Instances
HasProperties Schema (InsOrdHashMap Text (Referenced Schema)) Source # | |
Defined in Data.Swagger.Lens properties :: Lens' Schema (InsOrdHashMap Text (Referenced Schema)) Source # |
class HasReadOnly s a | s -> a where Source #
class HasDefault s a | s -> a where Source #
Instances
HasDefault Header (Maybe Value) Source # | |
HasDefault Responses (Maybe (Referenced Response)) Source # | |
Defined in Data.Swagger.Lens | |
HasDefault Schema (Maybe Value) Source # | |
HasDefault ParamOtherSchema (Maybe Value) Source # | |
Defined in Data.Swagger.Lens default_ :: Lens' ParamOtherSchema (Maybe Value) Source # | |
HasDefault (ParamSchema t) (Maybe Value) Source # | |
Defined in Data.Swagger.Lens default_ :: Lens' (ParamSchema t) (Maybe Value) Source # |
class HasEnum s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasEnum s (Maybe [Value]) Source # | |
Defined in Data.Swagger.Lens | |
HasEnum (ParamSchema t) (Maybe [Value]) Source # | |
Defined in Data.Swagger.Lens enum_ :: Lens' (ParamSchema t) (Maybe [Value]) Source # |
class HasExclusiveMaximum s a | s -> a where Source #
exclusiveMaximum :: Lens' s a Source #
Instances
HasParamSchema s (ParamSchema t) => HasExclusiveMaximum s (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens exclusiveMaximum :: Lens' s (Maybe Bool) Source # | |
HasExclusiveMaximum (ParamSchema t) (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens exclusiveMaximum :: Lens' (ParamSchema t) (Maybe Bool) Source # |
class HasExclusiveMinimum s a | s -> a where Source #
exclusiveMinimum :: Lens' s a Source #
Instances
HasParamSchema s (ParamSchema t) => HasExclusiveMinimum s (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens exclusiveMinimum :: Lens' s (Maybe Bool) Source # | |
HasExclusiveMinimum (ParamSchema t) (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens exclusiveMinimum :: Lens' (ParamSchema t) (Maybe Bool) Source # |
class HasFormat s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasFormat s (Maybe Format) Source # | |
HasFormat (ParamSchema t) (Maybe Format) Source # | |
Defined in Data.Swagger.Lens |
class HasItems s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasItems s (Maybe (SwaggerItems t)) Source # | |
Defined in Data.Swagger.Lens items :: Lens' s (Maybe (SwaggerItems t)) Source # | |
HasItems (ParamSchema t) (Maybe (SwaggerItems t)) Source # | |
Defined in Data.Swagger.Lens items :: Lens' (ParamSchema t) (Maybe (SwaggerItems t)) Source # |
class HasMaxItems s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasMaxItems s (Maybe Integer) Source # | |
HasMaxItems (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens |
class HasMaxLength s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasMaxLength s (Maybe Integer) Source # | |
HasMaxLength (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens |
class HasMaximum s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasMaximum s (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens | |
HasMaximum (ParamSchema t) (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens maximum_ :: Lens' (ParamSchema t) (Maybe Scientific) Source # |
class HasMinItems s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasMinItems s (Maybe Integer) Source # | |
HasMinItems (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens |
class HasMinLength s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasMinLength s (Maybe Integer) Source # | |
HasMinLength (ParamSchema t) (Maybe Integer) Source # | |
Defined in Data.Swagger.Lens |
class HasMinimum s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasMinimum s (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens | |
HasMinimum (ParamSchema t) (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens minimum_ :: Lens' (ParamSchema t) (Maybe Scientific) Source # |
class HasMultipleOf s a | s -> a where Source #
multipleOf :: Lens' s a Source #
Instances
HasParamSchema s (ParamSchema t) => HasMultipleOf s (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens multipleOf :: Lens' s (Maybe Scientific) Source # | |
HasMultipleOf (ParamSchema t) (Maybe Scientific) Source # | |
Defined in Data.Swagger.Lens multipleOf :: Lens' (ParamSchema t) (Maybe Scientific) Source # |
class HasPattern s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasPattern s (Maybe Text) Source # | |
HasPattern (ParamSchema t) (Maybe Pattern) Source # | |
Defined in Data.Swagger.Lens |
class HasType s a | s -> a where Source #
Instances
class HasUniqueItems s a | s -> a where Source #
uniqueItems :: Lens' s a Source #
Instances
HasParamSchema s (ParamSchema t) => HasUniqueItems s (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens uniqueItems :: Lens' s (Maybe Bool) Source # | |
HasUniqueItems (ParamSchema t) (Maybe Bool) Source # | |
Defined in Data.Swagger.Lens uniqueItems :: Lens' (ParamSchema t) (Maybe Bool) 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 HasExamples s a | s -> a where Source #
class HasHeaders s a | s -> a where Source #
Instances
HasHeaders Response (InsOrdHashMap HeaderName Header) Source # | |
Defined in Data.Swagger.Lens |
Prisms
ParamAnySchema
prisms
_ParamOther :: Prism' ParamAnySchema ParamOtherSchema Source #
_ParamBody :: Prism' ParamAnySchema (Referenced Schema) Source #
SecuritySchemeType
prisms
_SecuritySchemeBasic :: Prism' SecuritySchemeType () Source #
Referenced
prisms
_Inline :: forall a a. Prism (Referenced a) (Referenced a) a a Source #
_Ref :: forall a. Prism' (Referenced a) Reference Source #
SwaggerItems
prisms
_SwaggerItemsArray :: Review (SwaggerItems 'SwaggerKindSchema) [Referenced Schema] Source #
_SwaggerItemsObject :: Review (SwaggerItems 'SwaggerKindSchema) (Referenced Schema) Source #
_SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t) Source #
Orphan instances
At SecurityDefinitions Source # | |
at :: Index SecurityDefinitions -> Lens' SecurityDefinitions (Maybe (IxValue SecurityDefinitions)) | |
At Responses Source # | |
At Operation Source # | |
Ixed SecurityDefinitions Source # | |
ix :: Index SecurityDefinitions -> Traversal' SecurityDefinitions (IxValue SecurityDefinitions) | |
Ixed Responses Source # | |
Ixed Operation Source # | |