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
- class HasConsumes s a | s -> a where
- class HasDefinitions s a | s -> a where
- class HasExternalDocs s a | s -> a where
- class HasHost s a | s -> a where
- class HasInfo s a | s -> a where
- class HasParameters s a | s -> a where
- class HasPaths s a | s -> a where
- class HasProduces s a | s -> a where
- class HasResponses s a | s -> a where
- class HasSchemes s a | s -> a where
- class HasSecurity s a | s -> a where
- class HasSecurityDefinitions s a | s -> a where
- class HasTags s a | s -> a where
- class HasName s a | s -> a where
- class HasPort s a | s -> a where
- class HasContact s a | s -> a where
- class HasDescription s a | s -> a where
- class HasLicense s a | s -> a where
- class HasTermsOfService s a | s -> a where
- class HasTitle s a | s -> a where
- class HasVersion s a | s -> a where
- class HasEmail s a | s -> a where
- class HasUrl 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 HasDeprecated s a | s -> a where
- class HasOperationId s a | s -> a where
- class HasSummary s a | s -> a where
- class HasRequired s a | s -> a where
- class HasSchema s a | s -> a where
- class HasAllowEmptyValue s a | s -> a where
- class HasIn s a | s -> a where
- class HasParamSchema s a | s -> a where
- class HasAdditionalProperties s a | s -> a where
- class HasAllOf s a | s -> a where
- class HasDiscriminator s a | s -> a where
- class HasExample s a | s -> a where
- class HasMaxProperties s a | s -> a where
- class HasMinProperties s a | s -> a where
- class HasProperties s a | s -> a where
- class HasReadOnly s a | s -> a where
- class HasXml s a | s -> a where
- class HasDefault s a | s -> a where
- class HasEnum s a | s -> a where
- class HasExclusiveMaximum s a | s -> a where
- class HasExclusiveMinimum s a | s -> a where
- 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 HasMaximum s a | s -> a where
- class HasMinItems s a | s -> a where
- class HasMinLength s a | s -> a where
- class HasMinimum s a | s -> a where
- class HasMultipleOf s a | s -> a where
- class HasPattern s a | s -> a where
- class HasType s a | s -> a where
- class HasUniqueItems 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 HasExamples s a | s -> a where
- class HasHeaders s a | s -> a where
- _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 |
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 | |
HasExternalDocs Operation (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens | |
HasExternalDocs Swagger (Maybe ExternalDocs) Source # | |
Defined in Data.Swagger.Lens |
class HasParameters s a | s -> a where Source #
parameters :: Lens' s a Source #
Instances
HasParameters Operation [Referenced Param] Source # | |
Defined in Data.Swagger.Lens | |
HasParameters PathItem [Referenced Param] Source # | |
Defined in Data.Swagger.Lens | |
HasParameters Swagger (Definitions Param) Source # | |
Defined in Data.Swagger.Lens |
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 |
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 | |
HasSecurity Swagger [SecurityRequirement] Source # | |
Defined in Data.Swagger.Lens |
class HasSecurityDefinitions s a | s -> a where Source #
securityDefinitions :: Lens' s a Source #
Instances
HasSecurityDefinitions Swagger (Definitions SecurityScheme) Source # | |
Defined in Data.Swagger.Lens |
class HasPort s a | s -> a where Source #
Instances
HasPort Host (Maybe PortNumber) Source # | |
Defined in Data.Swagger.Lens |
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 | |
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 | |
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 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 | |
HasSchema Param ParamAnySchema Source # | |
Defined in Data.Swagger.Lens | |
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 |
class HasIn s a | s -> a where Source #
Instances
HasIn ParamOtherSchema ParamLocation Source # | |
Defined in Data.Swagger.Lens |
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 | |
HasParamSchema NamedSchema (ParamSchema (SwaggerKindSchema :: SwaggerKind *)) Source # | |
Defined in Data.Swagger.Lens | |
HasParamSchema Schema (ParamSchema (SwaggerKindSchema :: SwaggerKind Type)) Source # | |
Defined in Data.Swagger.Lens | |
HasParamSchema ParamOtherSchema (ParamSchema (SwaggerKindParamOtherSchema :: SwaggerKind Type)) Source # | |
class HasAdditionalProperties s a | s -> a where Source #
additionalProperties :: Lens' s a Source #
Instances
HasAdditionalProperties Schema (Maybe AdditionalProperties) 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 |
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 | |
HasDefault (ParamSchema t) (Maybe Value) Source # | |
Defined in Data.Swagger.Lens |
class HasEnum s a | s -> a where Source #
Instances
HasParamSchema s (ParamSchema t) => HasEnum s (Maybe [Value]) Source # | |
HasEnum (ParamSchema t) (Maybe [Value]) Source # | |
Defined in Data.Swagger.Lens |
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 | |
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 | |
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 | |
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
HasType SecurityScheme SecuritySchemeType Source # | |
Defined in Data.Swagger.Lens | |
HasType Header (SwaggerType (SwaggerKindNormal Header)) Source # | |
Defined in Data.Swagger.Lens | |
HasType NamedSchema (SwaggerType (SwaggerKindSchema :: SwaggerKind *)) Source # | |
Defined in Data.Swagger.Lens | |
HasType Schema (SwaggerType (SwaggerKindSchema :: SwaggerKind *)) Source # | |
Defined in Data.Swagger.Lens | |
HasType ParamOtherSchema (SwaggerType (SwaggerKindParamOtherSchema :: SwaggerKind *)) Source # | |
Defined in Data.Swagger.Lens | |
HasType (ParamSchema t) (SwaggerType t) Source # | |
Defined in Data.Swagger.Lens type_ :: Lens' (ParamSchema t) (SwaggerType t) Source # |
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 | |
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
SecuritySchemeType
prisms
Referenced
prisms
_Inline :: forall a a. Prism (Referenced a) (Referenced a) a a Source #
SwaggerItems
prisms
_SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t) Source #