swagger2-0.4.1: Swagger 2.0 data model

Safe HaskellNone
LanguageHaskell2010

Data.Swagger.Lens

Documentation

tags :: Lens' Swagger [Tag] Source

securityDefinitions :: Lens' Swagger (HashMap Text SecurityScheme) Source

security :: Lens' Swagger [SecurityRequirement] Source

schemes :: Lens' Swagger (Maybe [Scheme]) Source

responses :: Lens' Swagger (HashMap Text Response) Source

produces :: Lens' Swagger MimeList Source

paths :: Lens' Swagger Paths Source

parameters :: Lens' Swagger (HashMap Text Parameter) Source

info :: Lens' Swagger Info Source

host :: Lens' Swagger (Maybe Host) Source

externalDocs :: Lens' Swagger (Maybe ExternalDocs) Source

definitions :: Lens' Swagger (HashMap Text Schema) Source

consumes :: Lens' Swagger MimeList Source

basePath :: Lens' Swagger (Maybe FilePath) Source

hostPort :: Lens' Host (Maybe PortNumber) Source

hostName :: Lens' Host HostName Source

infoVersion :: Lens' Info Text Source

infoTitle :: Lens' Info Text Source

infoTermsOfService :: Lens' Info (Maybe Text) Source

infoLicense :: Lens' Info (Maybe License) Source

infoDescription :: Lens' Info (Maybe Text) Source

infoContact :: Lens' Info (Maybe Contact) Source

contactUrl :: Lens' Contact (Maybe URL) Source

contactName :: Lens' Contact (Maybe Text) Source

contactEmail :: Lens' Contact (Maybe Text) Source

licenseUrl :: Lens' License (Maybe URL) Source

licenseName :: Lens' License Text Source

pathsMap :: Iso' Paths (HashMap FilePath PathItem) Source

pathItemPut :: Lens' PathItem (Maybe Operation) Source

pathItemPost :: Lens' PathItem (Maybe Operation) Source

pathItemPatch :: Lens' PathItem (Maybe Operation) Source

pathItemParameters :: Lens' PathItem [Referenced Parameter] Source

pathItemOptions :: Lens' PathItem (Maybe Operation) Source

pathItemHead :: Lens' PathItem (Maybe Operation) Source

pathItemGet :: Lens' PathItem (Maybe Operation) Source

pathItemDelete :: Lens' PathItem (Maybe Operation) Source

tagName :: Lens' Tag Text Source

tagExternalDocs :: Lens' Tag (Maybe ExternalDocs) Source

tagDescription :: Lens' Tag (Maybe Text) Source

operationTags :: Lens' Operation [Text] Source

operationSummary :: Lens' Operation (Maybe Text) Source

operationSecurity :: Lens' Operation [SecurityRequirement] Source

operationSchemes :: Lens' Operation (Maybe [Scheme]) Source

operationResponses :: Lens' Operation Responses Source

operationProduces :: Lens' Operation (Maybe MimeList) Source

operationParameters :: Lens' Operation [Referenced Parameter] Source

operationOperationId :: Lens' Operation (Maybe Text) Source

operationExternalDocs :: Lens' Operation (Maybe ExternalDocs) Source

operationDescription :: Lens' Operation (Maybe Text) Source

operationDeprecated :: Lens' Operation (Maybe Bool) Source

operationConsumes :: Lens' Operation (Maybe MimeList) Source

parameterSchema :: Lens' Parameter ParameterSchema Source

parameterRequired :: Lens' Parameter (Maybe Bool) Source

parameterName :: Lens' Parameter Text Source

parameterDescription :: Lens' Parameter (Maybe Text) Source

_ParameterOther :: Prism' ParameterSchema ParameterOtherSchema Source

_ParameterBody :: Prism' ParameterSchema (Referenced Schema) Source

parameterOtherSchemaType :: Lens' ParameterOtherSchema ParameterType Source

parameterOtherSchemaItems :: Lens' ParameterOtherSchema (Maybe Items) Source

parameterOtherSchemaIn :: Lens' ParameterOtherSchema ParameterLocation Source

parameterOtherSchemaFormat :: Lens' ParameterOtherSchema (Maybe Format) Source

parameterOtherSchemaCommon :: Lens' ParameterOtherSchema SchemaCommon Source

parameterOtherSchemaCollectionFormat :: Lens' ParameterOtherSchema (Maybe CollectionFormat) Source

parameterOtherSchemaAllowEmptyValue :: Lens' ParameterOtherSchema (Maybe Bool) Source

itemsType :: Lens' Items ItemsType Source

itemsItems :: Lens' Items (Maybe Items) Source

itemsFormat :: Lens' Items (Maybe Format) Source

itemsCommon :: Lens' Items SchemaCommon Source

itemsCollectionFormat :: Lens' Items (Maybe ItemsCollectionFormat) Source

headerType :: Lens' Header ItemsType Source

headerItems :: Lens' Header (Maybe Items) Source

headerFormat :: Lens' Header (Maybe Format) Source

headerDescription :: Lens' Header (Maybe Text) Source

headerCommon :: Lens' Header SchemaCommon Source

headerCollectionFormat :: Lens' Header (Maybe ItemsCollectionFormat) Source

schemaXml :: Lens' Schema (Maybe Xml) Source

schemaType :: Lens' Schema SchemaType Source

schemaTitle :: Lens' Schema (Maybe Text) Source

schemaSchemaCommon :: Lens' Schema SchemaCommon Source

schemaRequired :: Lens' Schema [ParamName] Source

schemaReadOnly :: Lens' Schema (Maybe Bool) Source

schemaProperties :: Lens' Schema (HashMap Text (Referenced Schema)) Source

schemaMinProperties :: Lens' Schema (Maybe Integer) Source

schemaMaxProperties :: Lens' Schema (Maybe Integer) Source

schemaItems :: Lens' Schema (Maybe SchemaItems) Source

schemaFormat :: Lens' Schema (Maybe Format) Source

schemaExternalDocs :: Lens' Schema (Maybe ExternalDocs) Source

schemaExample :: Lens' Schema (Maybe Value) Source

schemaDiscriminator :: Lens' Schema (Maybe Text) Source

schemaDescription :: Lens' Schema (Maybe Text) Source

schemaAllOf :: Lens' Schema (Maybe [Schema]) Source

schemaAdditionalProperties :: Lens' Schema (Maybe Schema) Source

_SchemaItemsArray :: Prism' SchemaItems [Referenced Schema] Source

_SchemaItemsObject :: Prism' SchemaItems (Referenced Schema) Source

schemaCommonUniqueItems :: Lens' SchemaCommon (Maybe Bool) Source

schemaCommonPattern :: Lens' SchemaCommon (Maybe Text) Source

schemaCommonMultipleOf :: Lens' SchemaCommon (Maybe Scientific) Source

schemaCommonMinimum :: Lens' SchemaCommon (Maybe Scientific) Source

schemaCommonMinLength :: Lens' SchemaCommon (Maybe Integer) Source

schemaCommonMinItems :: Lens' SchemaCommon (Maybe Integer) Source

schemaCommonMaximum :: Lens' SchemaCommon (Maybe Scientific) Source

schemaCommonMaxLength :: Lens' SchemaCommon (Maybe Integer) Source

schemaCommonMaxItems :: Lens' SchemaCommon (Maybe Integer) Source

schemaCommonExclusiveMinimum :: Lens' SchemaCommon (Maybe Bool) Source

schemaCommonExclusiveMaximum :: Lens' SchemaCommon (Maybe Bool) Source

schemaCommonEnum :: Lens' SchemaCommon (Maybe [Value]) Source

schemaCommonDefault :: Lens' SchemaCommon (Maybe Value) Source

xmlWrapped :: Lens' Xml (Maybe Bool) Source

xmlPrefix :: Lens' Xml (Maybe Text) Source

xmlNamespace :: Lens' Xml (Maybe Text) Source

xmlName :: Lens' Xml (Maybe Text) Source

xmlAttribute :: Lens' Xml (Maybe Bool) Source

responsesResponses :: Lens' Responses (HashMap HttpStatusCode (Referenced Response)) Source

responsesDefault :: Lens' Responses (Maybe (Referenced Response)) Source

responseSchema :: Lens' Response (Maybe (Referenced Schema)) Source

responseHeaders :: Lens' Response (HashMap HeaderName Header) Source

responseExamples :: Lens' Response (Maybe Example) Source

responseDescription :: Lens' Response Text Source

securitySchemeType :: Lens' SecurityScheme SecuritySchemeType Source

securitySchemeDescription :: Lens' SecurityScheme (Maybe Text) Source

_SecuritySchemeOAuth2 :: Prism' SecuritySchemeType OAuth2Params Source

_SecuritySchemeApiKey :: Prism' SecuritySchemeType ApiKeyParams Source

_SecuritySchemeBasic :: Prism' SecuritySchemeType () Source

apiKeyName :: Lens' ApiKeyParams Text Source

apiKeyIn :: Lens' ApiKeyParams ApiKeyLocation Source

oauth2Scopes :: Lens' OAuth2Params (HashMap Text Text) Source

oauth2Flow :: Lens' OAuth2Params OAuth2Flow Source

externalDocsUrl :: Lens' ExternalDocs URL Source

externalDocsDescription :: Lens' ExternalDocs (Maybe Text) Source

class HasDescription s d | s -> d where Source

Methods

description :: Lens' s d Source

Instances

class HasSchemaCommon s where Source

Methods

schemaCommon :: Lens' s SchemaCommon Source

Instances

schemaDefault :: HasSchemaCommon s => Lens' s (Maybe Value) Source

schemaMaximum :: HasSchemaCommon s => Lens' s (Maybe Scientific) Source

schemaExclusiveMaximum :: HasSchemaCommon s => Lens' s (Maybe Bool) Source

schemaMinimum :: HasSchemaCommon s => Lens' s (Maybe Scientific) Source

schemaExclusiveMinimum :: HasSchemaCommon s => Lens' s (Maybe Bool) Source

schemaMaxLength :: HasSchemaCommon s => Lens' s (Maybe Integer) Source

schemaMinLength :: HasSchemaCommon s => Lens' s (Maybe Integer) Source

schemaPattern :: HasSchemaCommon s => Lens' s (Maybe Text) Source

schemaMaxItems :: HasSchemaCommon s => Lens' s (Maybe Integer) Source

schemaMinItems :: HasSchemaCommon s => Lens' s (Maybe Integer) Source

schemaUniqueItems :: HasSchemaCommon s => Lens' s (Maybe Bool) Source

schemaEnum :: HasSchemaCommon s => Lens' s (Maybe [Value]) Source

schemaMultipleOf :: HasSchemaCommon s => Lens' s (Maybe Scientific) Source