@@ -1,4 +1,72 @@
1+-- |
2+-- Swagger™ is a project used to describe and document RESTful APIs.
3+--
4+-- The Swagger specification defines a set of files required to describe such an API.
5+-- These files can then be used by the Swagger-UI project to display the API
6+-- and Swagger-Codegen to generate clients in various languages.
7+-- Additional utilities can also take advantage of the resulting files, such as testing tools.
18module Data.Swagger (
9+ -- * Swagger specification
10+ Swagger(..),
11+ SwaggerHost(..),
12+ SwaggerScheme(..),
13+
14+ -- * Info types
15+ SwaggerInfo(..),
16+ SwaggerContact(..),
17+ SwaggerLicense(..),
18+
19+ -- * Paths
20+ SwaggerPaths(..),
21+ SwaggerPathItem(..),
22+
23+ -- * Operations
24+ SwaggerTag(..),
25+ SwaggerOperation(..),
26+
27+ -- * Types and formats
28+ SwaggerItemsType(..),
29+ SwaggerSchemaType(..),
30+ SwaggerFormat(..),
31+ SwaggerCollectionFormat(..),
32+ SwaggerItemsCollectionFormat(..),
33+
34+ -- * Parameters
35+ SwaggerParameter(..),
36+ SwaggerParameterSchema(..),
37+ SwaggerParameterOtherSchema(..),
38+ SwaggerParameterLocation(..),
39+ SwaggerItems(..),
40+ SwaggerHeader(..),
41+ SwaggerExample(..),
42+
43+ -- * Schema
44+ SwaggerSchema(..),
45+ SwaggerSchemaItems(..),
46+ SwaggerSchemaCommon(..),
47+ SwaggerXml(..),
48+
49+ -- * Responses
50+ SwaggerResponses(..),
51+ SwaggerResponse(..),
52+
53+ -- * Security
54+ SwaggerSecurityScheme(..),
55+ SwaggerSecuritySchemeType(..),
56+ SwaggerSecurityRequirement(..),
57+
58+ -- ** API key
59+ SwaggerApiKeyParams(..),
60+ SwaggerApiKeyLocation(..),
61+
62+ -- ** OAuth2
63+ SwaggerOAuth2Params(..),
64+ SwaggerOAuth2Flow(..),
65+ AuthorizationURL(..),
66+ TokenURL(..),
67+
68+ -- * External documentation
69+ SwaggerExternalDocs(..),
270) where
371
472import Data.Swagger.Internal