| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Swagger.Internal
- data Swagger = Swagger {
- _info :: Info
- _host :: Maybe Host
- _basePath :: Maybe FilePath
- _schemes :: Maybe [Scheme]
- _consumes :: MimeList
- _produces :: MimeList
- _paths :: Paths
- _definitions :: HashMap Text Schema
- _parameters :: HashMap Text Parameter
- _responses :: HashMap Text Response
- _securityDefinitions :: HashMap Text SecurityScheme
- _security :: [SecurityRequirement]
- _tags :: [Tag]
- _externalDocs :: Maybe ExternalDocs
- data Info = Info {}
- data Contact = Contact {}
- data License = License {
- _licenseName :: Text
- _licenseUrl :: Maybe URL
- data Host = Host {}
- data Scheme
- data Paths = Paths {}
- data PathItem = PathItem {}
- data Operation = Operation {
- _operationTags :: [Text]
- _operationSummary :: Maybe Text
- _operationDescription :: Maybe Text
- _operationExternalDocs :: Maybe ExternalDocs
- _operationOperationId :: Maybe Text
- _operationConsumes :: Maybe MimeList
- _operationProduces :: Maybe MimeList
- _operationParameters :: [Referenced Parameter]
- _operationResponses :: Responses
- _operationSchemes :: Maybe [Scheme]
- _operationDeprecated :: Maybe Bool
- _operationSecurity :: [SecurityRequirement]
- newtype MimeList = MimeList {
- getMimeList :: [MediaType]
- data Parameter = Parameter {}
- data ParameterSchema
- data ParameterOtherSchema = ParameterOtherSchema {
- _parameterOtherSchemaIn :: ParameterLocation
- _parameterOtherSchemaType :: ParameterType
- _parameterOtherSchemaFormat :: Maybe Format
- _parameterOtherSchemaAllowEmptyValue :: Maybe Bool
- _parameterOtherSchemaItems :: Maybe Items
- _parameterOtherSchemaCollectionFormat :: Maybe CollectionFormat
- _parameterOtherSchemaCommon :: SchemaCommon
- data ParameterType
- data ParameterLocation
- type Format = Text
- data CollectionFormat
- data ItemsType
- data SchemaType
- data ItemsCollectionFormat
- type ParamName = Text
- data Schema = Schema {
- _schemaType :: SchemaType
- _schemaFormat :: Maybe Format
- _schemaTitle :: Maybe Text
- _schemaDescription :: Maybe Text
- _schemaRequired :: [ParamName]
- _schemaItems :: Maybe SchemaItems
- _schemaAllOf :: Maybe [Schema]
- _schemaProperties :: HashMap Text (Referenced Schema)
- _schemaAdditionalProperties :: Maybe Schema
- _schemaDiscriminator :: Maybe Text
- _schemaReadOnly :: Maybe Bool
- _schemaXml :: Maybe Xml
- _schemaExternalDocs :: Maybe ExternalDocs
- _schemaExample :: Maybe Value
- _schemaMaxProperties :: Maybe Integer
- _schemaMinProperties :: Maybe Integer
- _schemaSchemaCommon :: SchemaCommon
- data SchemaItems
- data SchemaCommon = SchemaCommon {
- _schemaCommonDefault :: Maybe Value
- _schemaCommonMaximum :: Maybe Scientific
- _schemaCommonExclusiveMaximum :: Maybe Bool
- _schemaCommonMinimum :: Maybe Scientific
- _schemaCommonExclusiveMinimum :: Maybe Bool
- _schemaCommonMaxLength :: Maybe Integer
- _schemaCommonMinLength :: Maybe Integer
- _schemaCommonPattern :: Maybe Text
- _schemaCommonMaxItems :: Maybe Integer
- _schemaCommonMinItems :: Maybe Integer
- _schemaCommonUniqueItems :: Maybe Bool
- _schemaCommonEnum :: Maybe [Value]
- _schemaCommonMultipleOf :: Maybe Scientific
- data Xml = Xml {
- _xmlName :: Maybe Text
- _xmlNamespace :: Maybe Text
- _xmlPrefix :: Maybe Text
- _xmlAttribute :: Maybe Bool
- _xmlWrapped :: Maybe Bool
- data Items = Items {}
- data Responses = Responses {}
- type HttpStatusCode = Int
- data Response = Response {}
- type HeaderName = Text
- data Header = Header {}
- data Example = Example {}
- data ApiKeyLocation
- data ApiKeyParams = ApiKeyParams {}
- type AuthorizationURL = Text
- type TokenURL = Text
- data OAuth2Flow
- data OAuth2Params = OAuth2Params {}
- data SecuritySchemeType
- data SecurityScheme = SecurityScheme {}
- newtype SecurityRequirement = SecurityRequirement {}
- data Tag = Tag {}
- data ExternalDocs = ExternalDocs {}
- newtype Reference = Reference {
- getReference :: Text
- data Referenced a
- newtype URL = URL {}
Documentation
This is the root document object for the API specification.
Constructors
| Swagger | |
Fields
| |
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.
Constructors
| Info | |
Fields
| |
Contact information for the exposed API.
Constructors
| Contact | |
Fields
| |
License information for the exposed API.
Constructors
| License | |
Fields
| |
The host (name or ip) serving the API. It MAY include a port.
The transfer protocol of the API.
The available paths and operations for the API.
Constructors
| Paths | |
Describes the operations available on a single path.
A PathItem
Constructors
| PathItem | |
Fields
| |
Describes a single API operation on a path.
Constructors
| Operation | |
Fields
| |
Constructors
| MimeList | |
Fields
| |
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
Constructors
| Parameter | |
Fields
| |
data ParameterSchema Source
Constructors
| ParameterBody (Referenced Schema) | |
| ParameterOther ParameterOtherSchema |
data ParameterOtherSchema Source
Constructors
| ParameterOtherSchema | |
Fields
| |
Instances
data ParameterType Source
Constructors
| ParamString | |
| ParamNumber | |
| ParamInteger | |
| ParamBoolean | |
| ParamArray | |
| ParamFile |
data ParameterLocation Source
Constructors
| ParameterQuery | Parameters that are appended to the URL.
For example, in |
| ParameterHeader | Custom headers that are expected as part of the request. |
| ParameterPath | 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 |
| ParameterFormData | Used to describe the payload of an HTTP request when either |
data CollectionFormat Source
Determines the format of the array.
Constructors
| CollectionCSV | Comma separated values: |
| CollectionSSV | Space separated values: |
| CollectionTSV | Tab separated values: |
| CollectionPipes | Pipe separated values: |
| CollectionMulti | Corresponds to multiple parameter instances
instead of multiple values for a single instance |
Constructors
| ItemsString | |
| ItemsNumber | |
| ItemsInteger | |
| ItemsBoolean | |
| ItemsArray |
data SchemaType Source
data ItemsCollectionFormat Source
Determines the format of the nested array.
Constructors
| ItemsCollectionCSV | Comma separated values: |
| ItemsCollectionSSV | Space separated values: |
| ItemsCollectionTSV | Tab separated values: |
| ItemsCollectionPipes | Pipe separated values: |
Constructors
Instances
data SchemaItems Source
Constructors
| SchemaItemsObject (Referenced Schema) | |
| SchemaItemsArray [Referenced Schema] |
data SchemaCommon Source
Constructors
| SchemaCommon | |
Fields
| |
Constructors
| Xml | |
Fields
| |
Constructors
| Items | |
Fields
| |
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.
Constructors
| Responses | |
Fields
| |
type HttpStatusCode = Int Source
Describes a single response from an API Operation.
Constructors
| Response | |
Fields
| |
Instances
type HeaderName = Text Source
Constructors
| Header | |
Fields
| |
Constructors
| Example | |
Fields | |
data ApiKeyParams Source
Constructors
| ApiKeyParams | |
Fields
| |
type AuthorizationURL = Text Source
The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
data OAuth2Flow Source
data OAuth2Params Source
Constructors
| OAuth2Params | |
Fields
| |
data SecuritySchemeType Source
data SecurityScheme Source
Constructors
| SecurityScheme | |
Fields
| |
newtype SecurityRequirement Source
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).
Constructors
| SecurityRequirement | |
Fields | |
Allows adding meta data to a single tag that is used by Operation.
It is not mandatory to have a Tag per tag used there.
Constructors
| Tag | |
Fields
| |
data ExternalDocs Source
Allows referencing an external resource for extended documentation.
Constructors
| ExternalDocs | |
Fields
| |
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.
Constructors
| Reference | |
Fields
| |
data Referenced a Source
Instances
| Eq a => Eq (Referenced a) Source | |
| Show a => Show (Referenced a) Source | |
| ToJSON a => ToJSON (Referenced a) Source | |
| FromJSON a => FromJSON (Referenced a) Source | |
| Monoid a => SwaggerMonoid (Referenced a) Source | |
| SwaggerMonoid (HashMap Text (Referenced Schema)) Source | |
| SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) Source |