Data.Swagger.Lens

Contents

• TH derived lenses
  • Swagger lenses
  • Host lenses
  • Info lenses
  • Contact lenses
  • License lenses
  • Paths lenses
  • PathItem lenses
  • Tag lenses
  • Operation lenses
  • Param lenses
  • ParamAnySchema prisms
  • ParamOtherSchema lenses
  • Header lenses
  • Schema lenses
  • SwaggerItems prisms
  • ParamSchema lenses
  • Xml lenses
  • Responses lenses
  • Response lenses
  • SecurityScheme lenses
  • SecuritySchemeType prisms
  • ApiKeyParams lenses
  • OAuth2Params lenses
  • ExternalDocs lenses
• Helper classy lenses

Synopsis

• tags :: Lens' Swagger [Tag]
• securityDefinitions :: Lens' Swagger (HashMap Text SecurityScheme)
• security :: Lens' Swagger [SecurityRequirement]
• schemes :: Lens' Swagger (Maybe [Scheme])
• responses :: Lens' Swagger (HashMap Text Response)
• produces :: Lens' Swagger MimeList
• paths :: Lens' Swagger Paths
• parameters :: Lens' Swagger (HashMap Text Param)
• info :: Lens' Swagger Info
• host :: Lens' Swagger (Maybe Host)
• externalDocs :: Lens' Swagger (Maybe ExternalDocs)
• definitions :: Lens' Swagger (HashMap Text Schema)
• consumes :: Lens' Swagger MimeList
• basePath :: Lens' Swagger (Maybe FilePath)
• hostPort :: Lens' Host (Maybe PortNumber)
• hostName :: Lens' Host HostName
• infoVersion :: Lens' Info Text
• infoTitle :: Lens' Info Text
• infoTermsOfService :: Lens' Info (Maybe Text)
• infoLicense :: Lens' Info (Maybe License)
• infoDescription :: Lens' Info (Maybe Text)
• infoContact :: Lens' Info (Maybe Contact)
• contactUrl :: Lens' Contact (Maybe URL)
• contactName :: Lens' Contact (Maybe Text)
• contactEmail :: Lens' Contact (Maybe Text)
• licenseUrl :: Lens' License (Maybe URL)
• licenseName :: Lens' License Text
• pathsMap :: Iso' Paths (HashMap FilePath PathItem)
• pathItemPut :: Lens' PathItem (Maybe Operation)
• pathItemPost :: Lens' PathItem (Maybe Operation)
• pathItemPatch :: Lens' PathItem (Maybe Operation)
• pathItemParameters :: Lens' PathItem [Referenced Param]
• pathItemOptions :: Lens' PathItem (Maybe Operation)
• pathItemHead :: Lens' PathItem (Maybe Operation)
• pathItemGet :: Lens' PathItem (Maybe Operation)
• pathItemDelete :: Lens' PathItem (Maybe Operation)
• tagName :: Lens' Tag TagName
• tagExternalDocs :: Lens' Tag (Maybe ExternalDocs)
• tagDescription :: Lens' Tag (Maybe Text)
• operationTags :: Lens' Operation [TagName]
• operationSummary :: Lens' Operation (Maybe Text)
• operationSecurity :: Lens' Operation [SecurityRequirement]
• operationSchemes :: Lens' Operation (Maybe [Scheme])
• operationResponses :: Lens' Operation Responses
• operationProduces :: Lens' Operation (Maybe MimeList)
• operationParameters :: Lens' Operation [Referenced Param]
• operationOperationId :: Lens' Operation (Maybe Text)
• operationExternalDocs :: Lens' Operation (Maybe ExternalDocs)
• operationDescription :: Lens' Operation (Maybe Text)
• operationDeprecated :: Lens' Operation (Maybe Bool)
• operationConsumes :: Lens' Operation (Maybe MimeList)
• paramSchema :: Lens' Param ParamAnySchema
• paramRequired :: Lens' Param (Maybe Bool)
• paramName :: Lens' Param Text
• paramDescription :: Lens' Param (Maybe Text)
• _ParamOther :: Prism' ParamAnySchema ParamOtherSchema
• _ParamBody :: Prism' ParamAnySchema (Referenced Schema)
• paramOtherSchemaParamSchema :: Lens' ParamOtherSchema (ParamSchema ParamOtherSchema)
• paramOtherSchemaIn :: Lens' ParamOtherSchema ParamLocation
• paramOtherSchemaAllowEmptyValue :: Lens' ParamOtherSchema (Maybe Bool)
• headerParamSchema :: Lens' Header (ParamSchema Header)
• headerDescription :: Lens' Header (Maybe Text)
• schemaXml :: Lens' Schema (Maybe Xml)
• schemaTitle :: Lens' Schema (Maybe Text)
• schemaRequired :: Lens' Schema [ParamName]
• schemaReadOnly :: Lens' Schema (Maybe Bool)
• schemaProperties :: Lens' Schema (HashMap Text (Referenced Schema))
• schemaParamSchema :: Lens' Schema (ParamSchema Schema)
• schemaMinProperties :: Lens' Schema (Maybe Integer)
• schemaMaxProperties :: Lens' Schema (Maybe Integer)
• schemaExternalDocs :: Lens' Schema (Maybe ExternalDocs)
• schemaExample :: Lens' Schema (Maybe Value)
• schemaDiscriminator :: Lens' Schema (Maybe Text)
• schemaDescription :: Lens' Schema (Maybe Text)
• schemaAllOf :: Lens' Schema (Maybe [Schema])
• schemaAdditionalProperties :: Lens' Schema (Maybe Schema)
• _SwaggerItemsArray :: forall t. (t ~ Schema) => Review (SwaggerItems t) [Referenced Schema]
• _SwaggerItemsObject :: forall t. (t ~ Schema) => Review (SwaggerItems t) (Referenced Schema)
• _SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t)
• paramSchemaUniqueItems :: forall t. Lens' (ParamSchema t) (Maybe Bool)
• paramSchemaType :: forall t. Lens' (ParamSchema t) (SwaggerType t)
• paramSchemaPattern :: forall t. Lens' (ParamSchema t) (Maybe Text)
• paramSchemaMultipleOf :: forall t. Lens' (ParamSchema t) (Maybe Scientific)
• paramSchemaMinimum :: forall t. Lens' (ParamSchema t) (Maybe Scientific)
• paramSchemaMinLength :: forall t. Lens' (ParamSchema t) (Maybe Integer)
• paramSchemaMinItems :: forall t. Lens' (ParamSchema t) (Maybe Integer)
• paramSchemaMaximum :: forall t. Lens' (ParamSchema t) (Maybe Scientific)
• paramSchemaMaxLength :: forall t. Lens' (ParamSchema t) (Maybe Integer)
• paramSchemaMaxItems :: forall t. Lens' (ParamSchema t) (Maybe Integer)
• paramSchemaItems :: forall t. Lens' (ParamSchema t) (Maybe (SwaggerItems t))
• paramSchemaFormat :: forall t. Lens' (ParamSchema t) (Maybe Format)
• paramSchemaExclusiveMinimum :: forall t. Lens' (ParamSchema t) (Maybe Bool)
• paramSchemaExclusiveMaximum :: forall t. Lens' (ParamSchema t) (Maybe Bool)
• paramSchemaEnum :: forall t. Lens' (ParamSchema t) (Maybe [Value])
• paramSchemaDefault :: forall t. Lens' (ParamSchema t) (Maybe Value)
• xmlWrapped :: Lens' Xml (Maybe Bool)
• xmlPrefix :: Lens' Xml (Maybe Text)
• xmlNamespace :: Lens' Xml (Maybe Text)
• xmlName :: Lens' Xml (Maybe Text)
• xmlAttribute :: Lens' Xml (Maybe Bool)
• responsesResponses :: Lens' Responses (HashMap HttpStatusCode (Referenced Response))
• responsesDefault :: Lens' Responses (Maybe (Referenced Response))
• responseSchema :: Lens' Response (Maybe (Referenced Schema))
• responseHeaders :: Lens' Response (HashMap HeaderName Header)
• responseExamples :: Lens' Response (Maybe Example)
• responseDescription :: Lens' Response Text
• securitySchemeType :: Lens' SecurityScheme SecuritySchemeType
• securitySchemeDescription :: Lens' SecurityScheme (Maybe Text)
• _SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Params
• _SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams
• _SecuritySchemeBasic :: Prism' SecuritySchemeType ()
• apiKeyName :: Lens' ApiKeyParams Text
• apiKeyIn :: Lens' ApiKeyParams ApiKeyLocation
• oauth2Scopes :: Lens' OAuth2Params (HashMap Text Text)
• oauth2Flow :: Lens' OAuth2Params OAuth2Flow
• externalDocsUrl :: Lens' ExternalDocs URL
• externalDocsDescription :: Lens' ExternalDocs (Maybe Text)
• class HasDescription s d | s -> d where
  • description :: Lens' s d
• class HasParamSchema s t | s -> t where
  • parameterSchema :: Lens' s (ParamSchema t)
• schemaType :: HasParamSchema s t => Lens' s (SwaggerType t)
• schemaFormat :: HasParamSchema s t => Lens' s (Maybe Format)
• schemaItems :: HasParamSchema s t => Lens' s (Maybe (SwaggerItems t))
• schemaDefault :: HasParamSchema s t => Lens' s (Maybe Value)
• schemaMaximum :: HasParamSchema s t => Lens' s (Maybe Scientific)
• schemaExclusiveMaximum :: HasParamSchema s t => Lens' s (Maybe Bool)
• schemaMinimum :: HasParamSchema s t => Lens' s (Maybe Scientific)
• schemaExclusiveMinimum :: HasParamSchema s t => Lens' s (Maybe Bool)
• schemaMaxLength :: HasParamSchema s t => Lens' s (Maybe Integer)
• schemaMinLength :: HasParamSchema s t => Lens' s (Maybe Integer)
• schemaPattern :: HasParamSchema s t => Lens' s (Maybe Text)
• schemaMaxItems :: HasParamSchema s t => Lens' s (Maybe Integer)
• schemaMinItems :: HasParamSchema s t => Lens' s (Maybe Integer)
• schemaUniqueItems :: HasParamSchema s t => Lens' s (Maybe Bool)
• schemaEnum :: HasParamSchema s t => Lens' s (Maybe [Value])
• schemaMultipleOf :: HasParamSchema s t => Lens' s (Maybe Scientific)

TH derived lenses

Swagger lenses

Host lenses

Info lenses

Contact lenses

License lenses

Paths lenses

PathItem lenses

Tag lenses

Operation lenses

Param lenses

ParamAnySchema prisms

ParamOtherSchema lenses

Header lenses

Schema lenses

SwaggerItems prisms

ParamSchema lenses

Xml lenses

Responses lenses

Response lenses

SecurityScheme lenses

SecuritySchemeType prisms

ApiKeyParams lenses

OAuth2Params lenses

ExternalDocs lenses

Helper classy lenses