-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Swagger 2.0 data model
--
-- Please see README.md
@package swagger2
@version 0.2
module Data.Swagger.Internal.Utils
hashMapMapKeys :: (Eq k', Hashable k') => (k -> k') -> HashMap k v -> HashMap k' v
hashMapTraverseKeys :: (Eq k', Hashable k', Applicative f) => (k -> f k') -> HashMap k v -> f (HashMap k' v)
hashMapReadKeys :: (Eq k, Read k, Hashable k, Alternative f) => HashMap String v -> f (HashMap k v)
jsonPrefix :: String -> Options
deriveToJSON' :: Name -> Q [Dec]
deriveJSONDefault :: Name -> Q [Dec]
deriveJSON' :: Name -> Q [Dec]
genericToJSONWithSub :: (Generic a, GToJSON (Rep a)) => Text -> Options -> a -> Value
genericParseJSONWithSub :: (Generic a, GFromJSON (Rep a)) => Text -> Options -> Value -> Parser a
(<+>) :: Value -> Value -> Value
withDefaults :: (Value -> Parser a) -> [Pair] -> Value -> Parser a
genericMempty :: (Generic a, GMonoid (Rep a)) => a
genericMappend :: (Generic a, GMonoid (Rep a)) => a -> a -> a
class GMonoid f
gmempty :: GMonoid f => f p
gmappend :: GMonoid f => f p -> f p -> f p
class SwaggerMonoid m where swaggerMempty = mempty swaggerMappend = mappend
swaggerMempty :: SwaggerMonoid m => m
swaggerMappend :: SwaggerMonoid m => m -> m -> m
instance Data.Swagger.Internal.Utils.GMonoid GHC.Generics.U1
instance (Data.Swagger.Internal.Utils.GMonoid f, Data.Swagger.Internal.Utils.GMonoid g) => Data.Swagger.Internal.Utils.GMonoid (f GHC.Generics.:*: g)
instance Data.Swagger.Internal.Utils.SwaggerMonoid a => Data.Swagger.Internal.Utils.GMonoid (GHC.Generics.K1 i a)
instance Data.Swagger.Internal.Utils.GMonoid f => Data.Swagger.Internal.Utils.GMonoid (GHC.Generics.M1 i t f)
instance Data.Swagger.Internal.Utils.SwaggerMonoid [a]
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Text.Internal.Text
instance Data.Swagger.Internal.Utils.SwaggerMonoid (GHC.Base.Maybe a)
instance Data.Swagger.Internal.Utils.SwaggerMonoid GHC.Types.Bool
module Data.Swagger.Internal
-- | This is the root document object for the API specification.
data Swagger
Swagger :: SwaggerInfo -> Maybe SwaggerHost -> Maybe FilePath -> Maybe [SwaggerScheme] -> SwaggerMimeList -> SwaggerMimeList -> SwaggerPaths -> HashMap Text SwaggerSchema -> HashMap Text SwaggerParameter -> HashMap Text SwaggerResponse -> HashMap Text SwaggerSecurityScheme -> [SwaggerSecurityRequirement] -> [SwaggerTag] -> Maybe SwaggerExternalDocs -> Swagger
-- | Provides metadata about the API. The metadata can be used by the
-- clients if needed.
[_swaggerInfo] :: Swagger -> SwaggerInfo
-- | The host (name or ip) serving the API. It MAY include a port. If the
-- host is not included, the host serving the documentation is to be used
-- (including the port).
[_swaggerHost] :: Swagger -> Maybe SwaggerHost
-- | The base path on which the API is served, which is relative to the
-- host. If it is not included, the API is served directly under the
-- host. The value MUST start with a leading slash (/).
[_swaggerBasePath] :: Swagger -> Maybe FilePath
-- | The transfer protocol of the API. If the schemes is not included, the
-- default scheme to be used is the one used to access the Swagger
-- definition itself.
[_swaggerSchemes] :: Swagger -> Maybe [SwaggerScheme]
-- | A list of MIME types the APIs can consume. This is global to all APIs
-- but can be overridden on specific API calls.
[_swaggerConsumes] :: Swagger -> SwaggerMimeList
-- | A list of MIME types the APIs can produce. This is global to all APIs
-- but can be overridden on specific API calls.
[_swaggerProduces] :: Swagger -> SwaggerMimeList
-- | The available paths and operations for the API.
[_swaggerPaths] :: Swagger -> SwaggerPaths
-- | An object to hold data types produced and consumed by operations.
[_swaggerDefinitions] :: Swagger -> HashMap Text SwaggerSchema
-- | An object to hold parameters that can be used across operations. This
-- property does not define global parameters for all operations.
[_swaggerParameters] :: Swagger -> HashMap Text SwaggerParameter
-- | An object to hold responses that can be used across operations. This
-- property does not define global responses for all operations.
[_swaggerResponses] :: Swagger -> HashMap Text SwaggerResponse
-- | Security scheme definitions that can be used across the specification.
[_swaggerSecurityDefinitions] :: Swagger -> HashMap Text SwaggerSecurityScheme
-- | A declaration of which security schemes are applied for the API as a
-- whole. The list of values describes alternative security schemes that
-- can be used (that is, there is a logical OR between the security
-- requirements). Individual operations can override this definition.
[_swaggerSecurity] :: Swagger -> [SwaggerSecurityRequirement]
-- | A list of tags used by the specification with additional metadata. The
-- order of the tags can be used to reflect on their order by the parsing
-- tools. Not all tags that are used by the Operation Object must be
-- declared. The tags that are not declared may be organized randomly or
-- based on the tools' logic. Each tag name in the list MUST be unique.
[_swaggerTags] :: Swagger -> [SwaggerTag]
-- | Additional external documentation.
[_swaggerExternalDocs] :: Swagger -> Maybe SwaggerExternalDocs
-- | The object provides metadata about the API. The metadata can be used
-- by the clients if needed, and can be presented in the Swagger-UI for
-- convenience.
data SwaggerInfo
SwaggerInfo :: Text -> Maybe Text -> Maybe Text -> Maybe SwaggerContact -> Maybe SwaggerLicense -> Text -> SwaggerInfo
-- | The title of the application.
[_swaggerInfoTitle] :: SwaggerInfo -> Text
-- | A short description of the application. GFM syntax can be used for
-- rich text representation.
[_swaggerInfoDescription] :: SwaggerInfo -> Maybe Text
-- | The Terms of Service for the API.
[_swaggerInfoTermsOfService] :: SwaggerInfo -> Maybe Text
-- | The contact information for the exposed API.
[_swaggerInfoContact] :: SwaggerInfo -> Maybe SwaggerContact
-- | The license information for the exposed API.
[_swaggerInfoLicense] :: SwaggerInfo -> Maybe SwaggerLicense
-- | Provides the version of the application API (not to be confused with
-- the specification version).
[_swaggerInfoVersion] :: SwaggerInfo -> Text
-- | Contact information for the exposed API.
data SwaggerContact
SwaggerContact :: Maybe Text -> Maybe URL -> Maybe Text -> SwaggerContact
-- | The identifying name of the contact person/organization.
[_swaggerContactName] :: SwaggerContact -> Maybe Text
-- | The URL pointing to the contact information.
[_swaggerContactUrl] :: SwaggerContact -> Maybe URL
-- | The email address of the contact person/organization.
[_swaggerContactEmail] :: SwaggerContact -> Maybe Text
-- | License information for the exposed API.
data SwaggerLicense
SwaggerLicense :: Text -> Maybe URL -> SwaggerLicense
-- | The license name used for the API.
[_swaggerLicenseName] :: SwaggerLicense -> Text
-- | A URL to the license used for the API.
[_swaggerLicenseUrl] :: SwaggerLicense -> Maybe URL
-- | The host (name or ip) serving the API. It MAY include a port.
data SwaggerHost
SwaggerHost :: HostName -> Maybe PortNumber -> SwaggerHost
-- | Host name.
[_swaggerHostName] :: SwaggerHost -> HostName
-- | Optional port.
[_swaggerHostPort] :: SwaggerHost -> Maybe PortNumber
-- | The transfer protocol of the API.
data SwaggerScheme
Http :: SwaggerScheme
Https :: SwaggerScheme
Ws :: SwaggerScheme
Wss :: SwaggerScheme
-- | The available paths and operations for the API.
data SwaggerPaths
SwaggerPaths :: HashMap FilePath SwaggerPathItem -> SwaggerPaths
-- | Holds the relative paths to the individual endpoints. The path is
-- appended to the swaggerBasePath in order to
-- construct the full URL.
[_swaggerPathsMap] :: SwaggerPaths -> HashMap FilePath SwaggerPathItem
-- | Describes the operations available on a single path. A
-- SwaggerPathItem may be empty, due to ACL constraints.
-- The path itself is still exposed to the documentation viewer but they
-- will not know which operations and parameters are available.
data SwaggerPathItem
SwaggerPathItem :: Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> [SwaggerReferenced SwaggerParameter] -> SwaggerPathItem
-- | A definition of a GET operation on this path.
[_swaggerPathItemGet] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a PUT operation on this path.
[_swaggerPathItemPut] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a POST operation on this path.
[_swaggerPathItemPost] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a DELETE operation on this path.
[_swaggerPathItemDelete] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a OPTIONS operation on this path.
[_swaggerPathItemOptions] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a HEAD operation on this path.
[_swaggerPathItemHead] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a PATCH operation on this path.
[_swaggerPathItemPatch] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A list of parameters that are applicable for all the operations
-- described under this path. These parameters can be overridden at the
-- operation level, but cannot be removed there. The list MUST NOT
-- include duplicated parameters. A unique parameter is defined by a
-- combination of a name and location.
[_swaggerPathItemParameters] :: SwaggerPathItem -> [SwaggerReferenced SwaggerParameter]
-- | Describes a single API operation on a path.
data SwaggerOperation
SwaggerOperation :: [Text] -> Maybe Text -> Maybe Text -> Maybe SwaggerExternalDocs -> Maybe Text -> Maybe SwaggerMimeList -> Maybe SwaggerMimeList -> [SwaggerReferenced SwaggerParameter] -> SwaggerResponses -> Maybe [SwaggerScheme] -> Bool -> [SwaggerSecurityRequirement] -> SwaggerOperation
-- | A list of tags for API documentation control. Tags can be used for
-- logical grouping of operations by resources or any other qualifier.
[_swaggerOperationTags] :: SwaggerOperation -> [Text]
-- | A short summary of what the operation does. For maximum readability in
-- the swagger-ui, this field SHOULD be less than 120 characters.
[_swaggerOperationSummary] :: SwaggerOperation -> Maybe Text
-- | A verbose explanation of the operation behavior. GFM syntax can be
-- used for rich text representation.
[_swaggerOperationDescription] :: SwaggerOperation -> Maybe Text
-- | Additional external documentation for this operation.
[_swaggerOperationExternalDocs] :: SwaggerOperation -> Maybe SwaggerExternalDocs
-- | Unique string used to identify the operation. The id MUST be unique
-- among all operations described in the API. Tools and libraries MAY use
-- the it to uniquely identify an operation, therefore, it is recommended
-- to follow common programming naming conventions.
[_swaggerOperationOperationId] :: SwaggerOperation -> Maybe Text
-- | A list of MIME types the operation can consume. This overrides the
-- swaggerConsumes. Just [] MAY be used to
-- clear the global definition.
[_swaggerOperationConsumes] :: SwaggerOperation -> Maybe SwaggerMimeList
-- | A list of MIME types the operation can produce. This overrides the
-- swaggerProduces. Just [] MAY be used to
-- clear the global definition.
[_swaggerOperationProduces] :: SwaggerOperation -> Maybe SwaggerMimeList
-- | A list of parameters that are applicable for this operation. If a
-- parameter is already defined at the SwaggerPathItem,
-- the new definition will override it, but can never remove it. The list
-- MUST NOT include duplicated parameters. A unique parameter is defined
-- by a combination of a name and location.
[_swaggerOperationParameters] :: SwaggerOperation -> [SwaggerReferenced SwaggerParameter]
-- | The list of possible responses as they are returned from executing
-- this operation.
[_swaggerOperationResponses] :: SwaggerOperation -> SwaggerResponses
-- | The transfer protocol for the operation. The value overrides
-- swaggerSchemes.
[_swaggerOperationSchemes] :: SwaggerOperation -> Maybe [SwaggerScheme]
-- | Declares this operation to be deprecated. Usage of the declared
-- operation should be refrained. Default value is False.
[_swaggerOperationDeprecated] :: SwaggerOperation -> Bool
-- | A declaration of which security schemes are applied for this
-- operation. The list of values describes alternative security schemes
-- that can be used (that is, there is a logical OR between the security
-- requirements). This definition overrides any declared top-level
-- security. To remove a top-level security declaration, Just []
-- can be used.
[_swaggerOperationSecurity] :: SwaggerOperation -> [SwaggerSecurityRequirement]
newtype SwaggerMimeList
SwaggerMimeList :: [MediaType] -> SwaggerMimeList
[getSwaggerMimeList] :: SwaggerMimeList -> [MediaType]
-- | Describes a single operation parameter. A unique parameter is defined
-- by a combination of a name and location.
data SwaggerParameter
SwaggerParameter :: Text -> Maybe Text -> Bool -> SwaggerParameterSchema -> SwaggerParameter
-- | The name of the parameter. Parameter names are case sensitive.
[_swaggerParameterName] :: SwaggerParameter -> Text
-- | A brief description of the parameter. This could contain examples of
-- use. GFM syntax can be used for rich text representation.
[_swaggerParameterDescription] :: SwaggerParameter -> Maybe Text
-- | Determines whether this parameter is mandatory. If the parameter is in
-- "path", this property is required and its value MUST be true.
-- Otherwise, the property MAY be included and its default value is
-- False.
[_swaggerParameterRequired] :: SwaggerParameter -> Bool
-- | Parameter schema.
[_swaggerParameterSchema] :: SwaggerParameter -> SwaggerParameterSchema
data SwaggerParameterSchema
SwaggerParameterBody :: (SwaggerReferenced SwaggerSchema) -> SwaggerParameterSchema
SwaggerParameterOther :: SwaggerParameterOtherSchema -> SwaggerParameterSchema
data SwaggerParameterOtherSchema
SwaggerParameterOtherSchema :: SwaggerParameterLocation -> SwaggerParameterType -> Maybe SwaggerFormat -> Bool -> Maybe SwaggerItems -> Maybe SwaggerCollectionFormat -> SwaggerSchemaCommon -> SwaggerParameterOtherSchema
-- | The location of the parameter.
[_swaggerParameterOtherSchemaIn] :: SwaggerParameterOtherSchema -> SwaggerParameterLocation
-- | The type of the parameter. Since the parameter is not located at the
-- request body, it is limited to simple types (that is, not an object).
-- If type is SwaggerParamFile, the consumes
-- MUST be either "multipartform-data" or "
-- applicationx-www-form-urlencoded" and the parameter MUST be in
-- SwaggerParameterFormData.
[_swaggerParameterOtherSchemaType] :: SwaggerParameterOtherSchema -> SwaggerParameterType
-- | The extending format for the previously mentioned type.
[_swaggerParameterOtherSchemaFormat] :: SwaggerParameterOtherSchema -> Maybe SwaggerFormat
-- | Sets the ability to pass empty-valued parameters. This is valid only
-- for either SwaggerParameterQuery or
-- SwaggerParameterFormData and allows you to send a
-- parameter with a name only or an empty value. Default value is
-- False.
[_swaggerParameterOtherSchemaAllowEmptyValue] :: SwaggerParameterOtherSchema -> Bool
-- | Required if type is SwaggerParamArray.
-- Describes the type of items in the array.
[_swaggerParameterOtherSchemaItems] :: SwaggerParameterOtherSchema -> Maybe SwaggerItems
-- | Determines the format of the array if
-- SwaggerParamArray is used. Default value is csv.
[_swaggerParameterOtherSchemaCollectionFormat] :: SwaggerParameterOtherSchema -> Maybe SwaggerCollectionFormat
[_swaggerParameterOtherSchemaCommon] :: SwaggerParameterOtherSchema -> SwaggerSchemaCommon
data SwaggerParameterType
SwaggerParamString :: SwaggerParameterType
SwaggerParamNumber :: SwaggerParameterType
SwaggerParamInteger :: SwaggerParameterType
SwaggerParamBoolean :: SwaggerParameterType
SwaggerParamArray :: SwaggerParameterType
SwaggerParamFile :: SwaggerParameterType
data SwaggerParameterLocation
-- | Parameters that are appended to the URL. For example, in
-- /items?id=###, the query parameter is id.
SwaggerParameterQuery :: SwaggerParameterLocation
-- | Custom headers that are expected as part of the request.
SwaggerParameterHeader :: SwaggerParameterLocation
-- | Used together with Path Templating, where the parameter value is
-- actually part of the operation's URL. This does not include the host
-- or base path of the API. For example, in
-- items{itemId}, the path parameter is itemId.
SwaggerParameterPath :: SwaggerParameterLocation
-- | Used to describe the payload of an HTTP request when either
-- application/x-www-form-urlencoded or
-- multipart/form-data are used as the content type of the
-- request (in Swagger's definition, the consumes property of an
-- operation). This is the only parameter type that can be used to send
-- files, thus supporting the SwaggerParamFile type.
-- Since form parameters are sent in the payload, they cannot be declared
-- together with a body parameter for the same operation. Form parameters
-- have a different format based on the content-type used (for further
-- details, consult
-- http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4).
SwaggerParameterFormData :: SwaggerParameterLocation
type SwaggerFormat = Text
-- | Determines the format of the array.
data SwaggerCollectionFormat
-- | Comma separated values: foo,bar.
SwaggerCollectionCSV :: SwaggerCollectionFormat
-- | Space separated values: foo bar.
SwaggerCollectionSSV :: SwaggerCollectionFormat
-- | Tab separated values: foo\tbar.
SwaggerCollectionTSV :: SwaggerCollectionFormat
-- | Pipe separated values: foo|bar.
SwaggerCollectionPipes :: SwaggerCollectionFormat
-- | Corresponds to multiple parameter instances instead of multiple values
-- for a single instance foo=bar&foo=baz. This is valid only
-- for parameters in SwaggerParameterQuery or
-- SwaggerParameterFormData.
SwaggerCollectionMulti :: SwaggerCollectionFormat
data SwaggerItemsType
SwaggerItemsString :: SwaggerItemsType
SwaggerItemsNumber :: SwaggerItemsType
SwaggerItemsInteger :: SwaggerItemsType
SwaggerItemsBoolean :: SwaggerItemsType
SwaggerItemsArray :: SwaggerItemsType
data SwaggerSchemaType
SwaggerSchemaArray :: SwaggerSchemaType
SwaggerSchemaBoolean :: SwaggerSchemaType
SwaggerSchemaInteger :: SwaggerSchemaType
SwaggerSchemaNumber :: SwaggerSchemaType
SwaggerSchemaNull :: SwaggerSchemaType
SwaggerSchemaObject :: SwaggerSchemaType
SwaggerSchemaString :: SwaggerSchemaType
-- | Determines the format of the nested array.
data SwaggerItemsCollectionFormat
-- | Comma separated values: foo,bar.
SwaggerItemsCollectionCSV :: SwaggerItemsCollectionFormat
-- | Space separated values: foo bar.
SwaggerItemsCollectionSSV :: SwaggerItemsCollectionFormat
-- | Tab separated values: foo\tbar.
SwaggerItemsCollectionTSV :: SwaggerItemsCollectionFormat
-- | Pipe separated values: foo|bar.
SwaggerItemsCollectionPipes :: SwaggerItemsCollectionFormat
type SwaggerParamName = Text
data SwaggerSchema
SwaggerSchema :: SwaggerSchemaType -> Maybe SwaggerFormat -> Maybe Text -> Maybe Text -> [SwaggerParamName] -> Maybe SwaggerSchemaItems -> Maybe [SwaggerSchema] -> HashMap Text (SwaggerReferenced SwaggerSchema) -> Maybe SwaggerSchema -> Maybe Text -> Maybe Bool -> Maybe SwaggerXml -> Maybe SwaggerExternalDocs -> Maybe Value -> Maybe Integer -> Maybe Integer -> SwaggerSchemaCommon -> SwaggerSchema
[_swaggerSchemaType] :: SwaggerSchema -> SwaggerSchemaType
[_swaggerSchemaFormat] :: SwaggerSchema -> Maybe SwaggerFormat
[_swaggerSchemaTitle] :: SwaggerSchema -> Maybe Text
[_swaggerSchemaDescription] :: SwaggerSchema -> Maybe Text
[_swaggerSchemaRequired] :: SwaggerSchema -> [SwaggerParamName]
[_swaggerSchemaItems] :: SwaggerSchema -> Maybe SwaggerSchemaItems
[_swaggerSchemaAllOf] :: SwaggerSchema -> Maybe [SwaggerSchema]
[_swaggerSchemaProperties] :: SwaggerSchema -> HashMap Text (SwaggerReferenced SwaggerSchema)
[_swaggerSchemaAdditionalProperties] :: SwaggerSchema -> Maybe SwaggerSchema
[_swaggerSchemaDiscriminator] :: SwaggerSchema -> Maybe Text
[_swaggerSchemaReadOnly] :: SwaggerSchema -> Maybe Bool
[_swaggerSchemaXml] :: SwaggerSchema -> Maybe SwaggerXml
[_swaggerSchemaExternalDocs] :: SwaggerSchema -> Maybe SwaggerExternalDocs
[_swaggerSchemaExample] :: SwaggerSchema -> Maybe Value
[_swaggerSchemaMaxProperties] :: SwaggerSchema -> Maybe Integer
[_swaggerSchemaMinProperties] :: SwaggerSchema -> Maybe Integer
[_swaggerSchemaCommon] :: SwaggerSchema -> SwaggerSchemaCommon
data SwaggerSchemaItems
SwaggerSchemaItemsObject :: (SwaggerReferenced SwaggerSchema) -> SwaggerSchemaItems
SwaggerSchemaItemsArray :: [SwaggerReferenced SwaggerSchema] -> SwaggerSchemaItems
data SwaggerSchemaCommon
SwaggerSchemaCommon :: Maybe Value -> Maybe Integer -> Maybe Bool -> Maybe Integer -> Maybe Bool -> Maybe Integer -> Maybe Integer -> Maybe Text -> Maybe Integer -> Maybe Integer -> Maybe Bool -> Maybe [Value] -> Maybe Integer -> SwaggerSchemaCommon
-- | Declares the value of the parameter that the server will use if none
-- is provided, for example a "count" to control the number of
-- results per page might default to 100 if not supplied by the
-- client in the request. (Note: "default" has no meaning for required
-- parameters.) Unlike JSON Schema this value MUST conform to the defined
-- type for this parameter.
[_swaggerSchemaDefault] :: SwaggerSchemaCommon -> Maybe Value
[_swaggerSchemaMaximum] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaExclusiveMaximum] :: SwaggerSchemaCommon -> Maybe Bool
[_swaggerSchemaMinimum] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaExclusiveMinimum] :: SwaggerSchemaCommon -> Maybe Bool
[_swaggerSchemaMaxLength] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaMinLength] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaPattern] :: SwaggerSchemaCommon -> Maybe Text
[_swaggerSchemaMaxItems] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaMinItems] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaUniqueItems] :: SwaggerSchemaCommon -> Maybe Bool
[_swaggerSchemaEnum] :: SwaggerSchemaCommon -> Maybe [Value]
[_swaggerSchemaMultipleOf] :: SwaggerSchemaCommon -> Maybe Integer
data SwaggerXml
SwaggerXml :: Maybe Text -> Maybe Text -> Maybe Text -> Bool -> Bool -> SwaggerXml
-- | Replaces the name of the element/attribute used for the described
-- schema property. When defined within the SwaggerItems
-- (items), it will affect the name of the individual XML elements within
-- the list. When defined alongside type being array (outside the items),
-- it will affect the wrapping element and only if wrapped is true. If
-- wrapped is false, it will be ignored.
[_swaggerXmlName] :: SwaggerXml -> Maybe Text
-- | The URL of the namespace definition. Value SHOULD be in the form of a
-- URL.
[_swaggerXmlNamespace] :: SwaggerXml -> Maybe Text
-- | The prefix to be used for the name.
[_swaggerXmlPrefix] :: SwaggerXml -> Maybe Text
-- | Declares whether the property definition translates to an attribute
-- instead of an element. Default value is False.
[_swaggerXmlAttribute] :: SwaggerXml -> Bool
-- | MAY be used only for an array definition. Signifies whether the array
-- is wrapped (for example,
-- <books><book><book></books>)
-- or unwrapped (<book><book>). Default value
-- is False. The definition takes effect only when defined
-- alongside type being array (outside the items).
[_swaggerXmlWrapped] :: SwaggerXml -> Bool
data SwaggerItems
SwaggerItems :: SwaggerItemsType -> Maybe SwaggerFormat -> Maybe SwaggerItems -> Maybe SwaggerItemsCollectionFormat -> SwaggerSchemaCommon -> SwaggerItems
-- | The internal type of the array.
[_swaggerItemsType] :: SwaggerItems -> SwaggerItemsType
-- | The extending format for the previously mentioned type.
[_swaggerItemsFormat] :: SwaggerItems -> Maybe SwaggerFormat
-- | Required if type is SwaggerItemsArray.
-- Describes the type of items in the array.
[_swaggerItemsItems] :: SwaggerItems -> Maybe SwaggerItems
-- | Determines the format of the array if type array is used. Default
-- value is SwaggerItemsCollectionCSV.
[_swaggerItemsCollectionFormat] :: SwaggerItems -> Maybe SwaggerItemsCollectionFormat
[_swaggerItemsCommon] :: SwaggerItems -> SwaggerSchemaCommon
-- | A container for the expected responses of an operation. The container
-- maps a HTTP response code to the expected response. It is not expected
-- from the documentation to necessarily cover all possible HTTP response
-- codes, since they may not be known in advance. However, it is expected
-- from the documentation to cover a successful operation response and
-- any known errors.
data SwaggerResponses
SwaggerResponses :: Maybe (SwaggerReferenced SwaggerResponse) -> HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse) -> SwaggerResponses
-- | The documentation of responses other than the ones declared for
-- specific HTTP response codes. It can be used to cover undeclared
-- responses.
[_swaggerResponsesDefault] :: SwaggerResponses -> Maybe (SwaggerReferenced SwaggerResponse)
-- | Any HTTP status code can be used as the property name (one property
-- per HTTP status code). Describes the expected response for those HTTP
-- status codes.
[_swaggerResponsesResponses] :: SwaggerResponses -> HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse)
type HttpStatusCode = Int
-- | Describes a single response from an API Operation.
data SwaggerResponse
SwaggerResponse :: Text -> Maybe (SwaggerReferenced SwaggerSchema) -> HashMap HeaderName SwaggerHeader -> Maybe SwaggerExample -> SwaggerResponse
-- | A short description of the response. GFM syntax can be used for rich
-- text representation.
[_swaggerResponseDescription] :: SwaggerResponse -> Text
-- | A definition of the response structure. It can be a primitive, an
-- array or an object. If this field does not exist, it means no content
-- is returned as part of the response. As an extension to the Schema
-- Object, its root type value may also be "file". This SHOULD be
-- accompanied by a relevant produces mime-type.
[_swaggerResponseSchema] :: SwaggerResponse -> Maybe (SwaggerReferenced SwaggerSchema)
-- | A list of headers that are sent with the response.
[_swaggerResponseHeaders] :: SwaggerResponse -> HashMap HeaderName SwaggerHeader
-- | An example of the response message.
[_swaggerResponseExamples] :: SwaggerResponse -> Maybe SwaggerExample
type HeaderName = Text
data SwaggerHeader
SwaggerHeader :: Maybe Text -> SwaggerItemsType -> Maybe SwaggerFormat -> Maybe SwaggerItems -> Maybe SwaggerItemsCollectionFormat -> SwaggerSchemaCommon -> SwaggerHeader
-- | A short description of the header.
[_swaggerHeaderDescription] :: SwaggerHeader -> Maybe Text
-- | The type of the object.
[_swaggerHeaderType] :: SwaggerHeader -> SwaggerItemsType
-- | The extending format for the previously mentioned type. See Data Type
-- Formats for further details.
[_swaggerHeaderFormat] :: SwaggerHeader -> Maybe SwaggerFormat
-- | Required if type is SwaggerItemsArray.
-- Describes the type of items in the array.
[_swaggerHeaderItems] :: SwaggerHeader -> Maybe SwaggerItems
-- | Determines the format of the array if type array is used. Default
-- value is SwaggerItemsCollectionCSV.
[_swaggerHeaderCollectionFormat] :: SwaggerHeader -> Maybe SwaggerItemsCollectionFormat
[_swaggerHeaderCommon] :: SwaggerHeader -> SwaggerSchemaCommon
data SwaggerExample
SwaggerExample :: Map MediaType Value -> SwaggerExample
[getSwaggerExample] :: SwaggerExample -> Map MediaType Value
-- | The location of the API key.
data SwaggerApiKeyLocation
SwaggerApiKeyQuery :: SwaggerApiKeyLocation
SwaggerApiKeyHeader :: SwaggerApiKeyLocation
data SwaggerApiKeyParams
SwaggerApiKeyParams :: Text -> SwaggerApiKeyLocation -> SwaggerApiKeyParams
-- | The name of the header or query parameter to be used.
[_swaggerApiKeyName] :: SwaggerApiKeyParams -> Text
-- | The location of the API key.
[_swaggerApiKeyIn] :: SwaggerApiKeyParams -> SwaggerApiKeyLocation
-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in
-- the form of a URL.
type AuthorizationURL = Text
-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form
-- of a URL.
type TokenURL = Text
data SwaggerOAuth2Flow
SwaggerOAuth2Implicit :: AuthorizationURL -> SwaggerOAuth2Flow
SwaggerOAuth2Password :: TokenURL -> SwaggerOAuth2Flow
SwaggerOAuth2Application :: TokenURL -> SwaggerOAuth2Flow
SwaggerOAuth2AccessCode :: AuthorizationURL -> TokenURL -> SwaggerOAuth2Flow
data SwaggerOAuth2Params
SwaggerOAuth2Params :: SwaggerOAuth2Flow -> HashMap Text Text -> SwaggerOAuth2Params
-- | The flow used by the OAuth2 security scheme.
[_swaggerOAuth2Flow] :: SwaggerOAuth2Params -> SwaggerOAuth2Flow
-- | The available scopes for the OAuth2 security scheme.
[_swaggerOAuth2Scopes] :: SwaggerOAuth2Params -> HashMap Text Text
data SwaggerSecuritySchemeType
SwaggerSecuritySchemeBasic :: SwaggerSecuritySchemeType
SwaggerSecuritySchemeApiKey :: SwaggerApiKeyParams -> SwaggerSecuritySchemeType
SwaggerSecuritySchemeOAuth2 :: SwaggerOAuth2Params -> SwaggerSecuritySchemeType
data SwaggerSecurityScheme
SwaggerSecurityScheme :: SwaggerSecuritySchemeType -> Maybe Text -> SwaggerSecurityScheme
-- | The type of the security scheme.
[_swaggerSecuritySchemeType] :: SwaggerSecurityScheme -> SwaggerSecuritySchemeType
-- | A short description for security scheme.
[_swaggerSecuritySchemeDescription] :: SwaggerSecurityScheme -> Maybe Text
-- | Lists the required security schemes to execute this operation. The
-- object can have multiple security schemes declared in it which are all
-- required (that is, there is a logical AND between the schemes).
newtype SwaggerSecurityRequirement
SwaggerSecurityRequirement :: HashMap Text [Text] -> SwaggerSecurityRequirement
[getSwaggerSecurityRequirement] :: SwaggerSecurityRequirement -> HashMap Text [Text]
-- | Allows adding meta data to a single tag that is used by
-- SwaggerOperation. It is not mandatory to have a
-- SwaggerTag per tag used there.
data SwaggerTag
SwaggerTag :: Text -> Maybe Text -> Maybe SwaggerExternalDocs -> SwaggerTag
-- | The name of the tag.
[_swaggerTagName] :: SwaggerTag -> Text
-- | A short description for the tag. GFM syntax can be used for rich text
-- representation.
[_swaggerTagDescription] :: SwaggerTag -> Maybe Text
-- | Additional external documentation for this tag.
[_swaggerTagExternalDocs] :: SwaggerTag -> Maybe SwaggerExternalDocs
-- | Allows referencing an external resource for extended documentation.
data SwaggerExternalDocs
SwaggerExternalDocs :: Maybe Text -> URL -> SwaggerExternalDocs
-- | A short description of the target documentation. GFM syntax can be
-- used for rich text representation.
[_swaggerExternalDocsDescription] :: SwaggerExternalDocs -> Maybe Text
-- | The URL for the target documentation.
[_swaggerExternalDocsUrl] :: SwaggerExternalDocs -> URL
-- | A simple object to allow referencing other definitions in the
-- specification. It can be used to reference parameters and responses
-- that are defined at the top level for reuse.
newtype SwaggerReference
SwaggerReference :: Text -> SwaggerReference
[getSwaggerReference] :: SwaggerReference -> Text
data SwaggerReferenced a
SwaggerRef :: SwaggerReference -> SwaggerReferenced a
SwaggerInline :: a -> SwaggerReferenced a
newtype URL
URL :: Text -> URL
[getUrl] :: URL -> Text
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerXml
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerOAuth2Flow
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerOAuth2Params
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSecuritySchemeType
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.Swagger
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSecurityScheme
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSchema
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerHeader
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerItems
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerHost
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerPaths
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerMimeList
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerParameter
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerParameterSchema
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerParameterOtherSchema
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSchemaItems
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerResponses
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerExample
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerReference
instance Data.Aeson.Types.Class.ToJSON a => Data.Aeson.Types.Class.ToJSON (Data.Swagger.Internal.SwaggerReferenced a)
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerOAuth2Flow
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerOAuth2Params
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSecuritySchemeType
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.Swagger
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSecurityScheme
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSchema
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerHeader
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerItems
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerHost
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerPaths
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerMimeList
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerParameter
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerParameterSchema
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerParameterOtherSchema
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSchemaItems
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerResponses
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerExample
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerResponse
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerOperation
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerPathItem
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerReference
instance Data.Aeson.Types.Class.FromJSON a => Data.Aeson.Types.Class.FromJSON (Data.Swagger.Internal.SwaggerReferenced a)
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerXml
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerPathItem
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerResponse
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerOperation
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerExternalDocs
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerExternalDocs
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerTag
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerTag
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerScheme
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerScheme
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSchemaCommon
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSchemaCommon
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerApiKeyParams
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerApiKeyParams
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerApiKeyLocation
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerApiKeyLocation
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerCollectionFormat
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerCollectionFormat
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerItemsCollectionFormat
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerItemsCollectionFormat
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerItemsType
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerItemsType
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSchemaType
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSchemaType
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerLicense
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerLicense
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerContact
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerContact
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerInfo
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerInfo
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerParameterType
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerParameterType
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerParameterLocation
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerParameterLocation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_13Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_12Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_11Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_10Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_9Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_8Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_7Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_6Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0Swagger
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0Swagger
instance GHC.Generics.Datatype Data.Swagger.Internal.D1Swagger
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerInfo
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerInfo
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerInfo
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerInfo
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerInfo
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerInfo
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerInfo
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerInfo
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerPaths
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerPaths
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerPaths
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_7SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_6SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerPathItem
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerPathItem
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerPathItem
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_11SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_10SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_9SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_8SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_7SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_6SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerOperation
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerOperation
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerOperation
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerParameter
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerParameter
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerParameter
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerParameter
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerParameter
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerParameter
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerResponses
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerResponses
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerResponses
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerResponses
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerResponse
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerResponse
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerResponse
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerResponse
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerResponse
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerResponse
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_16SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_15SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_14SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_13SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_12SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_11SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_10SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_9SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_8SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_7SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_6SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerSchema
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerSchema
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerExternalDocs
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerExternalDocs
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerExternalDocs
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerExternalDocs
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerSecurityScheme
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerSecurityScheme
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerSecurityScheme
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerSecurityScheme
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerOAuth2Params
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerOAuth2Params
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerOAuth2Params
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerOAuth2Params
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerHeader
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerHeader
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerHeader
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerHeader
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerHeader
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerHeader
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerHeader
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerHeader
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_6SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerParameterOtherSchema
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerParameterOtherSchema
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerParameterOtherSchema
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerItems
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerItems
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerItems
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerItems
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerItems
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerItems
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerItems
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerXml
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerXml
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerXml
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerXml
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerXml
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerXml
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerXml
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_12SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_11SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_10SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_9SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_8SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_7SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_6SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_5SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_4SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_3SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_2SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_1SwaggerSchemaCommon
instance GHC.Generics.Selector Data.Swagger.Internal.S1_0_0SwaggerSchemaCommon
instance GHC.Generics.Constructor Data.Swagger.Internal.C1_0SwaggerSchemaCommon
instance GHC.Generics.Datatype Data.Swagger.Internal.D1SwaggerSchemaCommon
instance GHC.Generics.Generic Data.Swagger.Internal.Swagger
instance GHC.Show.Show Data.Swagger.Internal.Swagger
instance GHC.Classes.Eq Data.Swagger.Internal.Swagger
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerInfo
instance GHC.Show.Show Data.Swagger.Internal.SwaggerInfo
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerInfo
instance GHC.Show.Show Data.Swagger.Internal.SwaggerContact
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerContact
instance GHC.Show.Show Data.Swagger.Internal.SwaggerLicense
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerLicense
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerPaths
instance GHC.Show.Show Data.Swagger.Internal.SwaggerPaths
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerPaths
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerPathItem
instance GHC.Show.Show Data.Swagger.Internal.SwaggerPathItem
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerPathItem
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerOperation
instance GHC.Show.Show Data.Swagger.Internal.SwaggerOperation
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerOperation
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerParameter
instance GHC.Show.Show Data.Swagger.Internal.SwaggerParameter
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerParameter
instance GHC.Show.Show Data.Swagger.Internal.SwaggerParameterSchema
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerParameterSchema
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerResponses
instance GHC.Show.Show Data.Swagger.Internal.SwaggerResponses
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerResponses
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerResponse
instance GHC.Show.Show Data.Swagger.Internal.SwaggerResponse
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerResponse
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSchemaItems
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSchemaItems
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerSchema
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSchema
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSchema
instance GHC.Show.Show Data.Swagger.Internal.SwaggerTag
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerTag
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerExternalDocs
instance GHC.Show.Show Data.Swagger.Internal.SwaggerExternalDocs
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerExternalDocs
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.URL
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.URL
instance GHC.Show.Show Data.Swagger.Internal.URL
instance GHC.Classes.Eq Data.Swagger.Internal.URL
instance GHC.Show.Show a => GHC.Show.Show (Data.Swagger.Internal.SwaggerReferenced a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Data.Swagger.Internal.SwaggerReferenced a)
instance GHC.Show.Show Data.Swagger.Internal.SwaggerReference
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerReference
instance Data.Aeson.Types.Class.FromJSON Data.Swagger.Internal.SwaggerSecurityRequirement
instance Data.Aeson.Types.Class.ToJSON Data.Swagger.Internal.SwaggerSecurityRequirement
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerSecurityRequirement
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSecurityRequirement
instance GHC.Read.Read Data.Swagger.Internal.SwaggerSecurityRequirement
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSecurityRequirement
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerSecurityScheme
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSecurityScheme
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSecurityScheme
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSecuritySchemeType
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSecuritySchemeType
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerOAuth2Params
instance GHC.Show.Show Data.Swagger.Internal.SwaggerOAuth2Params
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerOAuth2Params
instance GHC.Show.Show Data.Swagger.Internal.SwaggerOAuth2Flow
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerOAuth2Flow
instance GHC.Show.Show Data.Swagger.Internal.SwaggerApiKeyParams
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerApiKeyParams
instance GHC.Show.Show Data.Swagger.Internal.SwaggerApiKeyLocation
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerApiKeyLocation
instance GHC.Show.Show Data.Swagger.Internal.SwaggerExample
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerExample
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerHeader
instance GHC.Show.Show Data.Swagger.Internal.SwaggerHeader
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerHeader
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerParameterOtherSchema
instance GHC.Show.Show Data.Swagger.Internal.SwaggerParameterOtherSchema
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerParameterOtherSchema
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerItems
instance GHC.Show.Show Data.Swagger.Internal.SwaggerItems
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerItems
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerXml
instance GHC.Show.Show Data.Swagger.Internal.SwaggerXml
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerXml
instance GHC.Generics.Generic Data.Swagger.Internal.SwaggerSchemaCommon
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSchemaCommon
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSchemaCommon
instance GHC.Show.Show Data.Swagger.Internal.SwaggerItemsCollectionFormat
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerItemsCollectionFormat
instance GHC.Show.Show Data.Swagger.Internal.SwaggerSchemaType
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerSchemaType
instance GHC.Show.Show Data.Swagger.Internal.SwaggerItemsType
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerItemsType
instance GHC.Show.Show Data.Swagger.Internal.SwaggerCollectionFormat
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerCollectionFormat
instance GHC.Show.Show Data.Swagger.Internal.SwaggerParameterLocation
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerParameterLocation
instance GHC.Show.Show Data.Swagger.Internal.SwaggerParameterType
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerParameterType
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerMimeList
instance GHC.Show.Show Data.Swagger.Internal.SwaggerMimeList
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerMimeList
instance GHC.Show.Show Data.Swagger.Internal.SwaggerScheme
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerScheme
instance GHC.Show.Show Data.Swagger.Internal.SwaggerHost
instance GHC.Classes.Eq Data.Swagger.Internal.SwaggerHost
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.URL
instance GHC.Base.Monoid Data.Swagger.Internal.Swagger
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerInfo
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerPaths
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerPathItem
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerSchema
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerSchemaCommon
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerParameter
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerParameterOtherSchema
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerResponses
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerResponse
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerExternalDocs
instance GHC.Base.Monoid Data.Swagger.Internal.SwaggerOperation
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerInfo
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerPaths
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerPathItem
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerSchema
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerSchemaCommon
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerParameter
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerParameterOtherSchema
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerResponses
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerResponse
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerExternalDocs
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerOperation
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerMimeList
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerSchemaType
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerParameterType
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerParameterLocation
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Text.Internal.Text Data.Swagger.Internal.SwaggerSchema)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Text.Internal.Text (Data.Swagger.Internal.SwaggerReferenced Data.Swagger.Internal.SwaggerSchema))
instance GHC.Base.Monoid a => Data.Swagger.Internal.Utils.SwaggerMonoid (Data.Swagger.Internal.SwaggerReferenced a)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Text.Internal.Text Data.Swagger.Internal.SwaggerParameter)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Text.Internal.Text Data.Swagger.Internal.SwaggerResponse)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Text.Internal.Text Data.Swagger.Internal.SwaggerSecurityScheme)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap GHC.IO.FilePath Data.Swagger.Internal.SwaggerPathItem)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Swagger.Internal.HeaderName Data.Swagger.Internal.SwaggerHeader)
instance Data.Swagger.Internal.Utils.SwaggerMonoid (Data.HashMap.Base.HashMap Data.Swagger.Internal.HttpStatusCode (Data.Swagger.Internal.SwaggerReferenced Data.Swagger.Internal.SwaggerResponse))
instance Data.Swagger.Internal.Utils.SwaggerMonoid Data.Swagger.Internal.SwaggerParameterSchema
module Data.Swagger.Lens
swaggerTags :: Lens' Swagger [SwaggerTag]
swaggerSecurityDefinitions :: Lens' Swagger (HashMap Text SwaggerSecurityScheme)
swaggerSecurity :: Lens' Swagger [SwaggerSecurityRequirement]
swaggerSchemes :: Lens' Swagger (Maybe [SwaggerScheme])
swaggerResponses :: Lens' Swagger (HashMap Text SwaggerResponse)
swaggerProduces :: Lens' Swagger SwaggerMimeList
swaggerPaths :: Lens' Swagger SwaggerPaths
swaggerParameters :: Lens' Swagger (HashMap Text SwaggerParameter)
swaggerInfo :: Lens' Swagger SwaggerInfo
swaggerHost :: Lens' Swagger (Maybe SwaggerHost)
swaggerExternalDocs :: Lens' Swagger (Maybe SwaggerExternalDocs)
swaggerDefinitions :: Lens' Swagger (HashMap Text SwaggerSchema)
swaggerConsumes :: Lens' Swagger SwaggerMimeList
swaggerBasePath :: Lens' Swagger (Maybe FilePath)
swaggerHostPort :: Lens' SwaggerHost (Maybe PortNumber)
swaggerHostName :: Lens' SwaggerHost HostName
swaggerInfoVersion :: Lens' SwaggerInfo Text
swaggerInfoTitle :: Lens' SwaggerInfo Text
swaggerInfoTermsOfService :: Lens' SwaggerInfo (Maybe Text)
swaggerInfoLicense :: Lens' SwaggerInfo (Maybe SwaggerLicense)
swaggerInfoDescription :: Lens' SwaggerInfo (Maybe Text)
swaggerInfoContact :: Lens' SwaggerInfo (Maybe SwaggerContact)
swaggerContactUrl :: Lens' SwaggerContact (Maybe URL)
swaggerContactName :: Lens' SwaggerContact (Maybe Text)
swaggerContactEmail :: Lens' SwaggerContact (Maybe Text)
swaggerLicenseUrl :: Lens' SwaggerLicense (Maybe URL)
swaggerLicenseName :: Lens' SwaggerLicense Text
swaggerPathsMap :: Iso' SwaggerPaths (HashMap FilePath SwaggerPathItem)
swaggerPathItemPut :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerPathItemPost :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerPathItemPatch :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerPathItemParameters :: Lens' SwaggerPathItem [SwaggerReferenced SwaggerParameter]
swaggerPathItemOptions :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerPathItemHead :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerPathItemGet :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerPathItemDelete :: Lens' SwaggerPathItem (Maybe SwaggerOperation)
swaggerTagName :: Lens' SwaggerTag Text
swaggerTagExternalDocs :: Lens' SwaggerTag (Maybe SwaggerExternalDocs)
swaggerTagDescription :: Lens' SwaggerTag (Maybe Text)
swaggerOperationTags :: Lens' SwaggerOperation [Text]
swaggerOperationSummary :: Lens' SwaggerOperation (Maybe Text)
swaggerOperationSecurity :: Lens' SwaggerOperation [SwaggerSecurityRequirement]
swaggerOperationSchemes :: Lens' SwaggerOperation (Maybe [SwaggerScheme])
swaggerOperationResponses :: Lens' SwaggerOperation SwaggerResponses
swaggerOperationProduces :: Lens' SwaggerOperation (Maybe SwaggerMimeList)
swaggerOperationParameters :: Lens' SwaggerOperation [SwaggerReferenced SwaggerParameter]
swaggerOperationOperationId :: Lens' SwaggerOperation (Maybe Text)
swaggerOperationExternalDocs :: Lens' SwaggerOperation (Maybe SwaggerExternalDocs)
swaggerOperationDescription :: Lens' SwaggerOperation (Maybe Text)
swaggerOperationDeprecated :: Lens' SwaggerOperation Bool
swaggerOperationConsumes :: Lens' SwaggerOperation (Maybe SwaggerMimeList)
swaggerParameterSchema :: Lens' SwaggerParameter SwaggerParameterSchema
swaggerParameterRequired :: Lens' SwaggerParameter Bool
swaggerParameterName :: Lens' SwaggerParameter Text
swaggerParameterDescription :: Lens' SwaggerParameter (Maybe Text)
_SwaggerParameterOther :: Prism' SwaggerParameterSchema SwaggerParameterOtherSchema
_SwaggerParameterBody :: Prism' SwaggerParameterSchema (SwaggerReferenced SwaggerSchema)
swaggerParameterOtherSchemaType :: Lens' SwaggerParameterOtherSchema SwaggerParameterType
swaggerParameterOtherSchemaItems :: Lens' SwaggerParameterOtherSchema (Maybe SwaggerItems)
swaggerParameterOtherSchemaIn :: Lens' SwaggerParameterOtherSchema SwaggerParameterLocation
swaggerParameterOtherSchemaFormat :: Lens' SwaggerParameterOtherSchema (Maybe SwaggerFormat)
swaggerParameterOtherSchemaCommon :: Lens' SwaggerParameterOtherSchema SwaggerSchemaCommon
swaggerParameterOtherSchemaCollectionFormat :: Lens' SwaggerParameterOtherSchema (Maybe SwaggerCollectionFormat)
swaggerParameterOtherSchemaAllowEmptyValue :: Lens' SwaggerParameterOtherSchema Bool
swaggerItemsType :: Lens' SwaggerItems SwaggerItemsType
swaggerItemsItems :: Lens' SwaggerItems (Maybe SwaggerItems)
swaggerItemsFormat :: Lens' SwaggerItems (Maybe SwaggerFormat)
swaggerItemsCommon :: Lens' SwaggerItems SwaggerSchemaCommon
swaggerItemsCollectionFormat :: Lens' SwaggerItems (Maybe SwaggerItemsCollectionFormat)
swaggerHeaderType :: Lens' SwaggerHeader SwaggerItemsType
swaggerHeaderItems :: Lens' SwaggerHeader (Maybe SwaggerItems)
swaggerHeaderFormat :: Lens' SwaggerHeader (Maybe SwaggerFormat)
swaggerHeaderDescription :: Lens' SwaggerHeader (Maybe Text)
swaggerHeaderCommon :: Lens' SwaggerHeader SwaggerSchemaCommon
swaggerHeaderCollectionFormat :: Lens' SwaggerHeader (Maybe SwaggerItemsCollectionFormat)
swaggerSchemaXml :: Lens' SwaggerSchema (Maybe SwaggerXml)
swaggerSchemaType :: Lens' SwaggerSchema SwaggerSchemaType
swaggerSchemaTitle :: Lens' SwaggerSchema (Maybe Text)
swaggerSchemaRequired :: Lens' SwaggerSchema [SwaggerParamName]
swaggerSchemaReadOnly :: Lens' SwaggerSchema (Maybe Bool)
swaggerSchemaProperties :: Lens' SwaggerSchema (HashMap Text (SwaggerReferenced SwaggerSchema))
swaggerSchemaMinProperties :: Lens' SwaggerSchema (Maybe Integer)
swaggerSchemaMaxProperties :: Lens' SwaggerSchema (Maybe Integer)
swaggerSchemaItems :: Lens' SwaggerSchema (Maybe SwaggerSchemaItems)
swaggerSchemaFormat :: Lens' SwaggerSchema (Maybe SwaggerFormat)
swaggerSchemaExternalDocs :: Lens' SwaggerSchema (Maybe SwaggerExternalDocs)
swaggerSchemaExample :: Lens' SwaggerSchema (Maybe Value)
swaggerSchemaDiscriminator :: Lens' SwaggerSchema (Maybe Text)
swaggerSchemaDescription :: Lens' SwaggerSchema (Maybe Text)
swaggerSchemaCommon :: Lens' SwaggerSchema SwaggerSchemaCommon
swaggerSchemaAllOf :: Lens' SwaggerSchema (Maybe [SwaggerSchema])
swaggerSchemaAdditionalProperties :: Lens' SwaggerSchema (Maybe SwaggerSchema)
_SwaggerSchemaItemsArray :: Prism' SwaggerSchemaItems [SwaggerReferenced SwaggerSchema]
_SwaggerSchemaItemsObject :: Prism' SwaggerSchemaItems (SwaggerReferenced SwaggerSchema)
swaggerSchemaUniqueItems :: Lens' SwaggerSchemaCommon (Maybe Bool)
swaggerSchemaPattern :: Lens' SwaggerSchemaCommon (Maybe Text)
swaggerSchemaMultipleOf :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaMinimum :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaMinLength :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaMinItems :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaMaximum :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaMaxLength :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaMaxItems :: Lens' SwaggerSchemaCommon (Maybe Integer)
swaggerSchemaExclusiveMinimum :: Lens' SwaggerSchemaCommon (Maybe Bool)
swaggerSchemaExclusiveMaximum :: Lens' SwaggerSchemaCommon (Maybe Bool)
swaggerSchemaEnum :: Lens' SwaggerSchemaCommon (Maybe [Value])
swaggerSchemaDefault :: Lens' SwaggerSchemaCommon (Maybe Value)
swaggerXmlWrapped :: Lens' SwaggerXml Bool
swaggerXmlPrefix :: Lens' SwaggerXml (Maybe Text)
swaggerXmlNamespace :: Lens' SwaggerXml (Maybe Text)
swaggerXmlName :: Lens' SwaggerXml (Maybe Text)
swaggerXmlAttribute :: Lens' SwaggerXml Bool
swaggerResponsesResponses :: Lens' SwaggerResponses (HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse))
swaggerResponsesDefault :: Lens' SwaggerResponses (Maybe (SwaggerReferenced SwaggerResponse))
swaggerResponseSchema :: Lens' SwaggerResponse (Maybe (SwaggerReferenced SwaggerSchema))
swaggerResponseHeaders :: Lens' SwaggerResponse (HashMap HeaderName SwaggerHeader)
swaggerResponseExamples :: Lens' SwaggerResponse (Maybe SwaggerExample)
swaggerResponseDescription :: Lens' SwaggerResponse Text
swaggerSecuritySchemeType :: Lens' SwaggerSecurityScheme SwaggerSecuritySchemeType
swaggerSecuritySchemeDescription :: Lens' SwaggerSecurityScheme (Maybe Text)
_SwaggerSecuritySchemeOAuth2 :: Prism' SwaggerSecuritySchemeType SwaggerOAuth2Params
_SwaggerSecuritySchemeApiKey :: Prism' SwaggerSecuritySchemeType SwaggerApiKeyParams
_SwaggerSecuritySchemeBasic :: Prism' SwaggerSecuritySchemeType ()
swaggerApiKeyName :: Lens' SwaggerApiKeyParams Text
swaggerApiKeyIn :: Lens' SwaggerApiKeyParams SwaggerApiKeyLocation
swaggerOAuth2Scopes :: Lens' SwaggerOAuth2Params (HashMap Text Text)
swaggerOAuth2Flow :: Lens' SwaggerOAuth2Params SwaggerOAuth2Flow
swaggerExternalDocsUrl :: Lens' SwaggerExternalDocs URL
swaggerExternalDocsDescription :: Lens' SwaggerExternalDocs (Maybe Text)
class HasDescription s d | s -> d
description :: HasDescription s d => Lens' s d
class HasSwaggerSchemaCommon s
schemaCommon :: HasSwaggerSchemaCommon s => Lens' s SwaggerSchemaCommon
schemaDefault :: HasSwaggerSchemaCommon s => Lens' s (Maybe Value)
schemaMaximum :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
schemaExclusiveMaximum :: HasSwaggerSchemaCommon s => Lens' s (Maybe Bool)
schemaMinimum :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
schemaExclusiveMinimum :: HasSwaggerSchemaCommon s => Lens' s (Maybe Bool)
schemaMaxLength :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
schemaMinLength :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
schemaPattern :: HasSwaggerSchemaCommon s => Lens' s (Maybe Text)
schemaMaxItems :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
schemaMinItems :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
schemaUniqueItems :: HasSwaggerSchemaCommon s => Lens' s (Maybe Bool)
schemaEnum :: HasSwaggerSchemaCommon s => Lens' s (Maybe [Value])
schemaMultipleOf :: HasSwaggerSchemaCommon s => Lens' s (Maybe Integer)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerResponse Data.Text.Internal.Text
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerInfo (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerTag (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerOperation (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerParameter (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerHeader (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerSchema (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerSecurityScheme (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasDescription Data.Swagger.Internal.SwaggerExternalDocs (GHC.Base.Maybe Data.Text.Internal.Text)
instance Data.Swagger.Lens.HasSwaggerSchemaCommon Data.Swagger.Internal.SwaggerSchema
instance Data.Swagger.Lens.HasSwaggerSchemaCommon Data.Swagger.Internal.SwaggerParameterOtherSchema
instance Data.Swagger.Lens.HasSwaggerSchemaCommon Data.Swagger.Internal.SwaggerItems
instance Data.Swagger.Lens.HasSwaggerSchemaCommon Data.Swagger.Internal.SwaggerHeader
instance Data.Swagger.Lens.HasSwaggerSchemaCommon Data.Swagger.Internal.SwaggerSchemaCommon
-- | Swaggerâ„¢ is a project used to describe and document RESTful APIs.
--
-- The Swagger specification defines a set of files required to describe
-- such an API. These files can then be used by the Swagger-UI project to
-- display the API and Swagger-Codegen to generate clients in various
-- languages. Additional utilities can also take advantage of the
-- resulting files, such as testing tools.
module Data.Swagger
-- | This is the root document object for the API specification.
data Swagger
Swagger :: SwaggerInfo -> Maybe SwaggerHost -> Maybe FilePath -> Maybe [SwaggerScheme] -> SwaggerMimeList -> SwaggerMimeList -> SwaggerPaths -> HashMap Text SwaggerSchema -> HashMap Text SwaggerParameter -> HashMap Text SwaggerResponse -> HashMap Text SwaggerSecurityScheme -> [SwaggerSecurityRequirement] -> [SwaggerTag] -> Maybe SwaggerExternalDocs -> Swagger
-- | Provides metadata about the API. The metadata can be used by the
-- clients if needed.
[_swaggerInfo] :: Swagger -> SwaggerInfo
-- | The host (name or ip) serving the API. It MAY include a port. If the
-- host is not included, the host serving the documentation is to be used
-- (including the port).
[_swaggerHost] :: Swagger -> Maybe SwaggerHost
-- | The base path on which the API is served, which is relative to the
-- host. If it is not included, the API is served directly under the
-- host. The value MUST start with a leading slash (/).
[_swaggerBasePath] :: Swagger -> Maybe FilePath
-- | The transfer protocol of the API. If the schemes is not included, the
-- default scheme to be used is the one used to access the Swagger
-- definition itself.
[_swaggerSchemes] :: Swagger -> Maybe [SwaggerScheme]
-- | A list of MIME types the APIs can consume. This is global to all APIs
-- but can be overridden on specific API calls.
[_swaggerConsumes] :: Swagger -> SwaggerMimeList
-- | A list of MIME types the APIs can produce. This is global to all APIs
-- but can be overridden on specific API calls.
[_swaggerProduces] :: Swagger -> SwaggerMimeList
-- | The available paths and operations for the API.
[_swaggerPaths] :: Swagger -> SwaggerPaths
-- | An object to hold data types produced and consumed by operations.
[_swaggerDefinitions] :: Swagger -> HashMap Text SwaggerSchema
-- | An object to hold parameters that can be used across operations. This
-- property does not define global parameters for all operations.
[_swaggerParameters] :: Swagger -> HashMap Text SwaggerParameter
-- | An object to hold responses that can be used across operations. This
-- property does not define global responses for all operations.
[_swaggerResponses] :: Swagger -> HashMap Text SwaggerResponse
-- | Security scheme definitions that can be used across the specification.
[_swaggerSecurityDefinitions] :: Swagger -> HashMap Text SwaggerSecurityScheme
-- | A declaration of which security schemes are applied for the API as a
-- whole. The list of values describes alternative security schemes that
-- can be used (that is, there is a logical OR between the security
-- requirements). Individual operations can override this definition.
[_swaggerSecurity] :: Swagger -> [SwaggerSecurityRequirement]
-- | A list of tags used by the specification with additional metadata. The
-- order of the tags can be used to reflect on their order by the parsing
-- tools. Not all tags that are used by the Operation Object must be
-- declared. The tags that are not declared may be organized randomly or
-- based on the tools' logic. Each tag name in the list MUST be unique.
[_swaggerTags] :: Swagger -> [SwaggerTag]
-- | Additional external documentation.
[_swaggerExternalDocs] :: Swagger -> Maybe SwaggerExternalDocs
-- | The host (name or ip) serving the API. It MAY include a port.
data SwaggerHost
SwaggerHost :: HostName -> Maybe PortNumber -> SwaggerHost
-- | Host name.
[_swaggerHostName] :: SwaggerHost -> HostName
-- | Optional port.
[_swaggerHostPort] :: SwaggerHost -> Maybe PortNumber
-- | The transfer protocol of the API.
data SwaggerScheme
Http :: SwaggerScheme
Https :: SwaggerScheme
Ws :: SwaggerScheme
Wss :: SwaggerScheme
-- | The object provides metadata about the API. The metadata can be used
-- by the clients if needed, and can be presented in the Swagger-UI for
-- convenience.
data SwaggerInfo
SwaggerInfo :: Text -> Maybe Text -> Maybe Text -> Maybe SwaggerContact -> Maybe SwaggerLicense -> Text -> SwaggerInfo
-- | The title of the application.
[_swaggerInfoTitle] :: SwaggerInfo -> Text
-- | A short description of the application. GFM syntax can be used for
-- rich text representation.
[_swaggerInfoDescription] :: SwaggerInfo -> Maybe Text
-- | The Terms of Service for the API.
[_swaggerInfoTermsOfService] :: SwaggerInfo -> Maybe Text
-- | The contact information for the exposed API.
[_swaggerInfoContact] :: SwaggerInfo -> Maybe SwaggerContact
-- | The license information for the exposed API.
[_swaggerInfoLicense] :: SwaggerInfo -> Maybe SwaggerLicense
-- | Provides the version of the application API (not to be confused with
-- the specification version).
[_swaggerInfoVersion] :: SwaggerInfo -> Text
-- | Contact information for the exposed API.
data SwaggerContact
SwaggerContact :: Maybe Text -> Maybe URL -> Maybe Text -> SwaggerContact
-- | The identifying name of the contact person/organization.
[_swaggerContactName] :: SwaggerContact -> Maybe Text
-- | The URL pointing to the contact information.
[_swaggerContactUrl] :: SwaggerContact -> Maybe URL
-- | The email address of the contact person/organization.
[_swaggerContactEmail] :: SwaggerContact -> Maybe Text
-- | License information for the exposed API.
data SwaggerLicense
SwaggerLicense :: Text -> Maybe URL -> SwaggerLicense
-- | The license name used for the API.
[_swaggerLicenseName] :: SwaggerLicense -> Text
-- | A URL to the license used for the API.
[_swaggerLicenseUrl] :: SwaggerLicense -> Maybe URL
-- | The available paths and operations for the API.
data SwaggerPaths
SwaggerPaths :: HashMap FilePath SwaggerPathItem -> SwaggerPaths
-- | Holds the relative paths to the individual endpoints. The path is
-- appended to the swaggerBasePath in order to
-- construct the full URL.
[_swaggerPathsMap] :: SwaggerPaths -> HashMap FilePath SwaggerPathItem
-- | Describes the operations available on a single path. A
-- SwaggerPathItem may be empty, due to ACL constraints.
-- The path itself is still exposed to the documentation viewer but they
-- will not know which operations and parameters are available.
data SwaggerPathItem
SwaggerPathItem :: Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> Maybe SwaggerOperation -> [SwaggerReferenced SwaggerParameter] -> SwaggerPathItem
-- | A definition of a GET operation on this path.
[_swaggerPathItemGet] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a PUT operation on this path.
[_swaggerPathItemPut] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a POST operation on this path.
[_swaggerPathItemPost] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a DELETE operation on this path.
[_swaggerPathItemDelete] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a OPTIONS operation on this path.
[_swaggerPathItemOptions] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a HEAD operation on this path.
[_swaggerPathItemHead] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A definition of a PATCH operation on this path.
[_swaggerPathItemPatch] :: SwaggerPathItem -> Maybe SwaggerOperation
-- | A list of parameters that are applicable for all the operations
-- described under this path. These parameters can be overridden at the
-- operation level, but cannot be removed there. The list MUST NOT
-- include duplicated parameters. A unique parameter is defined by a
-- combination of a name and location.
[_swaggerPathItemParameters] :: SwaggerPathItem -> [SwaggerReferenced SwaggerParameter]
-- | Allows adding meta data to a single tag that is used by
-- SwaggerOperation. It is not mandatory to have a
-- SwaggerTag per tag used there.
data SwaggerTag
SwaggerTag :: Text -> Maybe Text -> Maybe SwaggerExternalDocs -> SwaggerTag
-- | The name of the tag.
[_swaggerTagName] :: SwaggerTag -> Text
-- | A short description for the tag. GFM syntax can be used for rich text
-- representation.
[_swaggerTagDescription] :: SwaggerTag -> Maybe Text
-- | Additional external documentation for this tag.
[_swaggerTagExternalDocs] :: SwaggerTag -> Maybe SwaggerExternalDocs
-- | Describes a single API operation on a path.
data SwaggerOperation
SwaggerOperation :: [Text] -> Maybe Text -> Maybe Text -> Maybe SwaggerExternalDocs -> Maybe Text -> Maybe SwaggerMimeList -> Maybe SwaggerMimeList -> [SwaggerReferenced SwaggerParameter] -> SwaggerResponses -> Maybe [SwaggerScheme] -> Bool -> [SwaggerSecurityRequirement] -> SwaggerOperation
-- | A list of tags for API documentation control. Tags can be used for
-- logical grouping of operations by resources or any other qualifier.
[_swaggerOperationTags] :: SwaggerOperation -> [Text]
-- | A short summary of what the operation does. For maximum readability in
-- the swagger-ui, this field SHOULD be less than 120 characters.
[_swaggerOperationSummary] :: SwaggerOperation -> Maybe Text
-- | A verbose explanation of the operation behavior. GFM syntax can be
-- used for rich text representation.
[_swaggerOperationDescription] :: SwaggerOperation -> Maybe Text
-- | Additional external documentation for this operation.
[_swaggerOperationExternalDocs] :: SwaggerOperation -> Maybe SwaggerExternalDocs
-- | Unique string used to identify the operation. The id MUST be unique
-- among all operations described in the API. Tools and libraries MAY use
-- the it to uniquely identify an operation, therefore, it is recommended
-- to follow common programming naming conventions.
[_swaggerOperationOperationId] :: SwaggerOperation -> Maybe Text
-- | A list of MIME types the operation can consume. This overrides the
-- swaggerConsumes. Just [] MAY be used to
-- clear the global definition.
[_swaggerOperationConsumes] :: SwaggerOperation -> Maybe SwaggerMimeList
-- | A list of MIME types the operation can produce. This overrides the
-- swaggerProduces. Just [] MAY be used to
-- clear the global definition.
[_swaggerOperationProduces] :: SwaggerOperation -> Maybe SwaggerMimeList
-- | A list of parameters that are applicable for this operation. If a
-- parameter is already defined at the SwaggerPathItem,
-- the new definition will override it, but can never remove it. The list
-- MUST NOT include duplicated parameters. A unique parameter is defined
-- by a combination of a name and location.
[_swaggerOperationParameters] :: SwaggerOperation -> [SwaggerReferenced SwaggerParameter]
-- | The list of possible responses as they are returned from executing
-- this operation.
[_swaggerOperationResponses] :: SwaggerOperation -> SwaggerResponses
-- | The transfer protocol for the operation. The value overrides
-- swaggerSchemes.
[_swaggerOperationSchemes] :: SwaggerOperation -> Maybe [SwaggerScheme]
-- | Declares this operation to be deprecated. Usage of the declared
-- operation should be refrained. Default value is False.
[_swaggerOperationDeprecated] :: SwaggerOperation -> Bool
-- | A declaration of which security schemes are applied for this
-- operation. The list of values describes alternative security schemes
-- that can be used (that is, there is a logical OR between the security
-- requirements). This definition overrides any declared top-level
-- security. To remove a top-level security declaration, Just []
-- can be used.
[_swaggerOperationSecurity] :: SwaggerOperation -> [SwaggerSecurityRequirement]
data SwaggerParameterType
SwaggerParamString :: SwaggerParameterType
SwaggerParamNumber :: SwaggerParameterType
SwaggerParamInteger :: SwaggerParameterType
SwaggerParamBoolean :: SwaggerParameterType
SwaggerParamArray :: SwaggerParameterType
SwaggerParamFile :: SwaggerParameterType
data SwaggerItemsType
SwaggerItemsString :: SwaggerItemsType
SwaggerItemsNumber :: SwaggerItemsType
SwaggerItemsInteger :: SwaggerItemsType
SwaggerItemsBoolean :: SwaggerItemsType
SwaggerItemsArray :: SwaggerItemsType
data SwaggerSchemaType
SwaggerSchemaArray :: SwaggerSchemaType
SwaggerSchemaBoolean :: SwaggerSchemaType
SwaggerSchemaInteger :: SwaggerSchemaType
SwaggerSchemaNumber :: SwaggerSchemaType
SwaggerSchemaNull :: SwaggerSchemaType
SwaggerSchemaObject :: SwaggerSchemaType
SwaggerSchemaString :: SwaggerSchemaType
type SwaggerFormat = Text
-- | Determines the format of the array.
data SwaggerCollectionFormat
-- | Comma separated values: foo,bar.
SwaggerCollectionCSV :: SwaggerCollectionFormat
-- | Space separated values: foo bar.
SwaggerCollectionSSV :: SwaggerCollectionFormat
-- | Tab separated values: foo\tbar.
SwaggerCollectionTSV :: SwaggerCollectionFormat
-- | Pipe separated values: foo|bar.
SwaggerCollectionPipes :: SwaggerCollectionFormat
-- | Corresponds to multiple parameter instances instead of multiple values
-- for a single instance foo=bar&foo=baz. This is valid only
-- for parameters in SwaggerParameterQuery or
-- SwaggerParameterFormData.
SwaggerCollectionMulti :: SwaggerCollectionFormat
-- | Determines the format of the nested array.
data SwaggerItemsCollectionFormat
-- | Comma separated values: foo,bar.
SwaggerItemsCollectionCSV :: SwaggerItemsCollectionFormat
-- | Space separated values: foo bar.
SwaggerItemsCollectionSSV :: SwaggerItemsCollectionFormat
-- | Tab separated values: foo\tbar.
SwaggerItemsCollectionTSV :: SwaggerItemsCollectionFormat
-- | Pipe separated values: foo|bar.
SwaggerItemsCollectionPipes :: SwaggerItemsCollectionFormat
-- | Describes a single operation parameter. A unique parameter is defined
-- by a combination of a name and location.
data SwaggerParameter
SwaggerParameter :: Text -> Maybe Text -> Bool -> SwaggerParameterSchema -> SwaggerParameter
-- | The name of the parameter. Parameter names are case sensitive.
[_swaggerParameterName] :: SwaggerParameter -> Text
-- | A brief description of the parameter. This could contain examples of
-- use. GFM syntax can be used for rich text representation.
[_swaggerParameterDescription] :: SwaggerParameter -> Maybe Text
-- | Determines whether this parameter is mandatory. If the parameter is in
-- "path", this property is required and its value MUST be true.
-- Otherwise, the property MAY be included and its default value is
-- False.
[_swaggerParameterRequired] :: SwaggerParameter -> Bool
-- | Parameter schema.
[_swaggerParameterSchema] :: SwaggerParameter -> SwaggerParameterSchema
data SwaggerParameterSchema
SwaggerParameterBody :: (SwaggerReferenced SwaggerSchema) -> SwaggerParameterSchema
SwaggerParameterOther :: SwaggerParameterOtherSchema -> SwaggerParameterSchema
data SwaggerParameterOtherSchema
SwaggerParameterOtherSchema :: SwaggerParameterLocation -> SwaggerParameterType -> Maybe SwaggerFormat -> Bool -> Maybe SwaggerItems -> Maybe SwaggerCollectionFormat -> SwaggerSchemaCommon -> SwaggerParameterOtherSchema
-- | The location of the parameter.
[_swaggerParameterOtherSchemaIn] :: SwaggerParameterOtherSchema -> SwaggerParameterLocation
-- | The type of the parameter. Since the parameter is not located at the
-- request body, it is limited to simple types (that is, not an object).
-- If type is SwaggerParamFile, the consumes
-- MUST be either "multipartform-data" or "
-- applicationx-www-form-urlencoded" and the parameter MUST be in
-- SwaggerParameterFormData.
[_swaggerParameterOtherSchemaType] :: SwaggerParameterOtherSchema -> SwaggerParameterType
-- | The extending format for the previously mentioned type.
[_swaggerParameterOtherSchemaFormat] :: SwaggerParameterOtherSchema -> Maybe SwaggerFormat
-- | Sets the ability to pass empty-valued parameters. This is valid only
-- for either SwaggerParameterQuery or
-- SwaggerParameterFormData and allows you to send a
-- parameter with a name only or an empty value. Default value is
-- False.
[_swaggerParameterOtherSchemaAllowEmptyValue] :: SwaggerParameterOtherSchema -> Bool
-- | Required if type is SwaggerParamArray.
-- Describes the type of items in the array.
[_swaggerParameterOtherSchemaItems] :: SwaggerParameterOtherSchema -> Maybe SwaggerItems
-- | Determines the format of the array if
-- SwaggerParamArray is used. Default value is csv.
[_swaggerParameterOtherSchemaCollectionFormat] :: SwaggerParameterOtherSchema -> Maybe SwaggerCollectionFormat
[_swaggerParameterOtherSchemaCommon] :: SwaggerParameterOtherSchema -> SwaggerSchemaCommon
data SwaggerParameterLocation
-- | Parameters that are appended to the URL. For example, in
-- /items?id=###, the query parameter is id.
SwaggerParameterQuery :: SwaggerParameterLocation
-- | Custom headers that are expected as part of the request.
SwaggerParameterHeader :: SwaggerParameterLocation
-- | Used together with Path Templating, where the parameter value is
-- actually part of the operation's URL. This does not include the host
-- or base path of the API. For example, in
-- items{itemId}, the path parameter is itemId.
SwaggerParameterPath :: SwaggerParameterLocation
-- | Used to describe the payload of an HTTP request when either
-- application/x-www-form-urlencoded or
-- multipart/form-data are used as the content type of the
-- request (in Swagger's definition, the consumes property of an
-- operation). This is the only parameter type that can be used to send
-- files, thus supporting the SwaggerParamFile type.
-- Since form parameters are sent in the payload, they cannot be declared
-- together with a body parameter for the same operation. Form parameters
-- have a different format based on the content-type used (for further
-- details, consult
-- http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4).
SwaggerParameterFormData :: SwaggerParameterLocation
type SwaggerParamName = Text
data SwaggerItems
SwaggerItems :: SwaggerItemsType -> Maybe SwaggerFormat -> Maybe SwaggerItems -> Maybe SwaggerItemsCollectionFormat -> SwaggerSchemaCommon -> SwaggerItems
-- | The internal type of the array.
[_swaggerItemsType] :: SwaggerItems -> SwaggerItemsType
-- | The extending format for the previously mentioned type.
[_swaggerItemsFormat] :: SwaggerItems -> Maybe SwaggerFormat
-- | Required if type is SwaggerItemsArray.
-- Describes the type of items in the array.
[_swaggerItemsItems] :: SwaggerItems -> Maybe SwaggerItems
-- | Determines the format of the array if type array is used. Default
-- value is SwaggerItemsCollectionCSV.
[_swaggerItemsCollectionFormat] :: SwaggerItems -> Maybe SwaggerItemsCollectionFormat
[_swaggerItemsCommon] :: SwaggerItems -> SwaggerSchemaCommon
data SwaggerHeader
SwaggerHeader :: Maybe Text -> SwaggerItemsType -> Maybe SwaggerFormat -> Maybe SwaggerItems -> Maybe SwaggerItemsCollectionFormat -> SwaggerSchemaCommon -> SwaggerHeader
-- | A short description of the header.
[_swaggerHeaderDescription] :: SwaggerHeader -> Maybe Text
-- | The type of the object.
[_swaggerHeaderType] :: SwaggerHeader -> SwaggerItemsType
-- | The extending format for the previously mentioned type. See Data Type
-- Formats for further details.
[_swaggerHeaderFormat] :: SwaggerHeader -> Maybe SwaggerFormat
-- | Required if type is SwaggerItemsArray.
-- Describes the type of items in the array.
[_swaggerHeaderItems] :: SwaggerHeader -> Maybe SwaggerItems
-- | Determines the format of the array if type array is used. Default
-- value is SwaggerItemsCollectionCSV.
[_swaggerHeaderCollectionFormat] :: SwaggerHeader -> Maybe SwaggerItemsCollectionFormat
[_swaggerHeaderCommon] :: SwaggerHeader -> SwaggerSchemaCommon
data SwaggerExample
SwaggerExample :: Map MediaType Value -> SwaggerExample
[getSwaggerExample] :: SwaggerExample -> Map MediaType Value
data SwaggerSchema
SwaggerSchema :: SwaggerSchemaType -> Maybe SwaggerFormat -> Maybe Text -> Maybe Text -> [SwaggerParamName] -> Maybe SwaggerSchemaItems -> Maybe [SwaggerSchema] -> HashMap Text (SwaggerReferenced SwaggerSchema) -> Maybe SwaggerSchema -> Maybe Text -> Maybe Bool -> Maybe SwaggerXml -> Maybe SwaggerExternalDocs -> Maybe Value -> Maybe Integer -> Maybe Integer -> SwaggerSchemaCommon -> SwaggerSchema
[_swaggerSchemaType] :: SwaggerSchema -> SwaggerSchemaType
[_swaggerSchemaFormat] :: SwaggerSchema -> Maybe SwaggerFormat
[_swaggerSchemaTitle] :: SwaggerSchema -> Maybe Text
[_swaggerSchemaDescription] :: SwaggerSchema -> Maybe Text
[_swaggerSchemaRequired] :: SwaggerSchema -> [SwaggerParamName]
[_swaggerSchemaItems] :: SwaggerSchema -> Maybe SwaggerSchemaItems
[_swaggerSchemaAllOf] :: SwaggerSchema -> Maybe [SwaggerSchema]
[_swaggerSchemaProperties] :: SwaggerSchema -> HashMap Text (SwaggerReferenced SwaggerSchema)
[_swaggerSchemaAdditionalProperties] :: SwaggerSchema -> Maybe SwaggerSchema
[_swaggerSchemaDiscriminator] :: SwaggerSchema -> Maybe Text
[_swaggerSchemaReadOnly] :: SwaggerSchema -> Maybe Bool
[_swaggerSchemaXml] :: SwaggerSchema -> Maybe SwaggerXml
[_swaggerSchemaExternalDocs] :: SwaggerSchema -> Maybe SwaggerExternalDocs
[_swaggerSchemaExample] :: SwaggerSchema -> Maybe Value
[_swaggerSchemaMaxProperties] :: SwaggerSchema -> Maybe Integer
[_swaggerSchemaMinProperties] :: SwaggerSchema -> Maybe Integer
[_swaggerSchemaCommon] :: SwaggerSchema -> SwaggerSchemaCommon
data SwaggerSchemaItems
SwaggerSchemaItemsObject :: (SwaggerReferenced SwaggerSchema) -> SwaggerSchemaItems
SwaggerSchemaItemsArray :: [SwaggerReferenced SwaggerSchema] -> SwaggerSchemaItems
data SwaggerSchemaCommon
SwaggerSchemaCommon :: Maybe Value -> Maybe Integer -> Maybe Bool -> Maybe Integer -> Maybe Bool -> Maybe Integer -> Maybe Integer -> Maybe Text -> Maybe Integer -> Maybe Integer -> Maybe Bool -> Maybe [Value] -> Maybe Integer -> SwaggerSchemaCommon
-- | Declares the value of the parameter that the server will use if none
-- is provided, for example a "count" to control the number of
-- results per page might default to 100 if not supplied by the
-- client in the request. (Note: "default" has no meaning for required
-- parameters.) Unlike JSON Schema this value MUST conform to the defined
-- type for this parameter.
[_swaggerSchemaDefault] :: SwaggerSchemaCommon -> Maybe Value
[_swaggerSchemaMaximum] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaExclusiveMaximum] :: SwaggerSchemaCommon -> Maybe Bool
[_swaggerSchemaMinimum] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaExclusiveMinimum] :: SwaggerSchemaCommon -> Maybe Bool
[_swaggerSchemaMaxLength] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaMinLength] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaPattern] :: SwaggerSchemaCommon -> Maybe Text
[_swaggerSchemaMaxItems] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaMinItems] :: SwaggerSchemaCommon -> Maybe Integer
[_swaggerSchemaUniqueItems] :: SwaggerSchemaCommon -> Maybe Bool
[_swaggerSchemaEnum] :: SwaggerSchemaCommon -> Maybe [Value]
[_swaggerSchemaMultipleOf] :: SwaggerSchemaCommon -> Maybe Integer
data SwaggerXml
SwaggerXml :: Maybe Text -> Maybe Text -> Maybe Text -> Bool -> Bool -> SwaggerXml
-- | Replaces the name of the element/attribute used for the described
-- schema property. When defined within the SwaggerItems
-- (items), it will affect the name of the individual XML elements within
-- the list. When defined alongside type being array (outside the items),
-- it will affect the wrapping element and only if wrapped is true. If
-- wrapped is false, it will be ignored.
[_swaggerXmlName] :: SwaggerXml -> Maybe Text
-- | The URL of the namespace definition. Value SHOULD be in the form of a
-- URL.
[_swaggerXmlNamespace] :: SwaggerXml -> Maybe Text
-- | The prefix to be used for the name.
[_swaggerXmlPrefix] :: SwaggerXml -> Maybe Text
-- | Declares whether the property definition translates to an attribute
-- instead of an element. Default value is False.
[_swaggerXmlAttribute] :: SwaggerXml -> Bool
-- | MAY be used only for an array definition. Signifies whether the array
-- is wrapped (for example,
-- <books><book><book></books>)
-- or unwrapped (<book><book>). Default value
-- is False. The definition takes effect only when defined
-- alongside type being array (outside the items).
[_swaggerXmlWrapped] :: SwaggerXml -> Bool
-- | A container for the expected responses of an operation. The container
-- maps a HTTP response code to the expected response. It is not expected
-- from the documentation to necessarily cover all possible HTTP response
-- codes, since they may not be known in advance. However, it is expected
-- from the documentation to cover a successful operation response and
-- any known errors.
data SwaggerResponses
SwaggerResponses :: Maybe (SwaggerReferenced SwaggerResponse) -> HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse) -> SwaggerResponses
-- | The documentation of responses other than the ones declared for
-- specific HTTP response codes. It can be used to cover undeclared
-- responses.
[_swaggerResponsesDefault] :: SwaggerResponses -> Maybe (SwaggerReferenced SwaggerResponse)
-- | Any HTTP status code can be used as the property name (one property
-- per HTTP status code). Describes the expected response for those HTTP
-- status codes.
[_swaggerResponsesResponses] :: SwaggerResponses -> HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse)
-- | Describes a single response from an API Operation.
data SwaggerResponse
SwaggerResponse :: Text -> Maybe (SwaggerReferenced SwaggerSchema) -> HashMap HeaderName SwaggerHeader -> Maybe SwaggerExample -> SwaggerResponse
-- | A short description of the response. GFM syntax can be used for rich
-- text representation.
[_swaggerResponseDescription] :: SwaggerResponse -> Text
-- | A definition of the response structure. It can be a primitive, an
-- array or an object. If this field does not exist, it means no content
-- is returned as part of the response. As an extension to the Schema
-- Object, its root type value may also be "file". This SHOULD be
-- accompanied by a relevant produces mime-type.
[_swaggerResponseSchema] :: SwaggerResponse -> Maybe (SwaggerReferenced SwaggerSchema)
-- | A list of headers that are sent with the response.
[_swaggerResponseHeaders] :: SwaggerResponse -> HashMap HeaderName SwaggerHeader
-- | An example of the response message.
[_swaggerResponseExamples] :: SwaggerResponse -> Maybe SwaggerExample
data SwaggerSecurityScheme
SwaggerSecurityScheme :: SwaggerSecuritySchemeType -> Maybe Text -> SwaggerSecurityScheme
-- | The type of the security scheme.
[_swaggerSecuritySchemeType] :: SwaggerSecurityScheme -> SwaggerSecuritySchemeType
-- | A short description for security scheme.
[_swaggerSecuritySchemeDescription] :: SwaggerSecurityScheme -> Maybe Text
data SwaggerSecuritySchemeType
SwaggerSecuritySchemeBasic :: SwaggerSecuritySchemeType
SwaggerSecuritySchemeApiKey :: SwaggerApiKeyParams -> SwaggerSecuritySchemeType
SwaggerSecuritySchemeOAuth2 :: SwaggerOAuth2Params -> SwaggerSecuritySchemeType
-- | Lists the required security schemes to execute this operation. The
-- object can have multiple security schemes declared in it which are all
-- required (that is, there is a logical AND between the schemes).
newtype SwaggerSecurityRequirement
SwaggerSecurityRequirement :: HashMap Text [Text] -> SwaggerSecurityRequirement
[getSwaggerSecurityRequirement] :: SwaggerSecurityRequirement -> HashMap Text [Text]
data SwaggerApiKeyParams
SwaggerApiKeyParams :: Text -> SwaggerApiKeyLocation -> SwaggerApiKeyParams
-- | The name of the header or query parameter to be used.
[_swaggerApiKeyName] :: SwaggerApiKeyParams -> Text
-- | The location of the API key.
[_swaggerApiKeyIn] :: SwaggerApiKeyParams -> SwaggerApiKeyLocation
-- | The location of the API key.
data SwaggerApiKeyLocation
SwaggerApiKeyQuery :: SwaggerApiKeyLocation
SwaggerApiKeyHeader :: SwaggerApiKeyLocation
data SwaggerOAuth2Params
SwaggerOAuth2Params :: SwaggerOAuth2Flow -> HashMap Text Text -> SwaggerOAuth2Params
-- | The flow used by the OAuth2 security scheme.
[_swaggerOAuth2Flow] :: SwaggerOAuth2Params -> SwaggerOAuth2Flow
-- | The available scopes for the OAuth2 security scheme.
[_swaggerOAuth2Scopes] :: SwaggerOAuth2Params -> HashMap Text Text
data SwaggerOAuth2Flow
SwaggerOAuth2Implicit :: AuthorizationURL -> SwaggerOAuth2Flow
SwaggerOAuth2Password :: TokenURL -> SwaggerOAuth2Flow
SwaggerOAuth2Application :: TokenURL -> SwaggerOAuth2Flow
SwaggerOAuth2AccessCode :: AuthorizationURL -> TokenURL -> SwaggerOAuth2Flow
-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in
-- the form of a URL.
type AuthorizationURL = Text
-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form
-- of a URL.
type TokenURL = Text
-- | Allows referencing an external resource for extended documentation.
data SwaggerExternalDocs
SwaggerExternalDocs :: Maybe Text -> URL -> SwaggerExternalDocs
-- | A short description of the target documentation. GFM syntax can be
-- used for rich text representation.
[_swaggerExternalDocsDescription] :: SwaggerExternalDocs -> Maybe Text
-- | The URL for the target documentation.
[_swaggerExternalDocsUrl] :: SwaggerExternalDocs -> URL
-- | A simple object to allow referencing other definitions in the
-- specification. It can be used to reference parameters and responses
-- that are defined at the top level for reuse.
newtype SwaggerReference
SwaggerReference :: Text -> SwaggerReference
[getSwaggerReference] :: SwaggerReference -> Text
data SwaggerReferenced a
SwaggerRef :: SwaggerReference -> SwaggerReferenced a
SwaggerInline :: a -> SwaggerReferenced a
newtype SwaggerMimeList
SwaggerMimeList :: [MediaType] -> SwaggerMimeList
[getSwaggerMimeList] :: SwaggerMimeList -> [MediaType]
newtype URL
URL :: Text -> URL
[getUrl] :: URL -> Text