@@ -1,471 +1,636 @@
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
1{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveGeneric #-}
2{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE DeriveTraversable #-}
7+{-# LANGUAGE FlexibleContexts #-}
8+{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4{-# LANGUAGE OverloadedStrings #-}
11{-# LANGUAGE OverloadedStrings #-}
5{-# LANGUAGE RecordWildCards #-}
12{-# LANGUAGE RecordWildCards #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
6{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
21+#include "overlapping-compat.h"
7module Data.Swagger.Internal where
22module Data.Swagger.Internal where
27+import Control.Lens ((&), (.~), (?~))
28+import Control.Applicative
9import Data.Aeson
29import Data.Aeson
10−import Data.Aeson.TH (deriveToJSON)
30+import qualified Data.Aeson.Types as JSON
11−import Data.Foldable (Foldable)
31+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
12−import Data.HashMap.Strict (HashMap)
32+import Data.Hashable (Hashable)
13import qualified Data.HashMap.Strict as HashMap
33import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
36+import qualified Data.Map as Map
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
39+import Data.Scientific (Scientific)
40+import Data.String (IsString(..))
14import Data.Text (Text)
41import Data.Text (Text)
15−import Data.Traversable (Traversable)
42+import qualified Data.Text as Text
16−import Data.Hashable (Hashable)
17import GHC.Generics (Generic)
43import GHC.Generics (Generic)
18−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
19import Network.HTTP.Media (MediaType)
45import Network.HTTP.Media (MediaType)
20−
46+import Text.Read (readMaybe)
48+import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
51+import Generics.SOP.TH (deriveGeneric)
52+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53+ ,sopSwaggerGenericToJSONWithOpts
54+ ,sopSwaggerGenericParseJSON
55+ ,HasSwaggerAesonOptions(..)
56+ ,AesonDefaultValue(..)
57+ ,mkSwaggerAesonOptions
21import Data.Swagger.Internal.Utils
60import Data.Swagger.Internal.Utils
62+#if MIN_VERSION_aeson(0,10,0)
63+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64+#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
66+#define DEFINE_TOENCODING
70+-- >>> :seti -XDataKinds
71+-- >>> import Data.Aeson
73+-- | A list of definitions that can be used in references.
74+type Definitions = InsOrdHashMap Text
23-- | This is the root document object for the API specification.
76-- | This is the root document object for the API specification.
24data Swagger = Swagger
77data Swagger = Swagger
25 { -- | Provides metadata about the API.
78 { -- | Provides metadata about the API.
26 -- The metadata can be used by the clients if needed.
79 -- The metadata can be used by the clients if needed.
27− swaggerInfo :: SwaggerInfo
80+ _swaggerInfo :: Info
29 -- | The host (name or ip) serving the API. It MAY include a port.
82 -- | The host (name or ip) serving the API. It MAY include a port.
30 -- If the host is not included, the host serving the documentation is to be used (including the port).
83 -- If the host is not included, the host serving the documentation is to be used (including the port).
31− , swaggerHost :: Maybe SwaggerHost
84+ , _swaggerHost :: Maybe Host
33 -- | The base path on which the API is served, which is relative to the host.
86 -- | The base path on which the API is served, which is relative to the host.
34 -- If it is not included, the API is served directly under the host.
87 -- If it is not included, the API is served directly under the host.
35 -- The value MUST start with a leading slash (/).
88 -- The value MUST start with a leading slash (/).
36− , swaggerBasePath :: Maybe FilePath
89+ , _swaggerBasePath :: Maybe FilePath
38 -- | The transfer protocol of the API.
91 -- | The transfer protocol of the API.
39 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
92 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
40− , swaggerSchemes :: Maybe [SwaggerScheme]
93+ , _swaggerSchemes :: Maybe [Scheme]
42 -- | A list of MIME types the APIs can consume.
95 -- | A list of MIME types the APIs can consume.
43 -- This is global to all APIs but can be overridden on specific API calls.
96 -- This is global to all APIs but can be overridden on specific API calls.
44− , swaggerConsumes :: SwaggerMimeList
97+ , _swaggerConsumes :: MimeList
46 -- | A list of MIME types the APIs can produce.
99 -- | A list of MIME types the APIs can produce.
47− -- This is global to all APIs but can be overridden on specific API calls.
100+ -- This is global to all APIs but can be overridden on specific API calls.
48− , swaggerProduces :: SwaggerMimeList
101+ , _swaggerProduces :: MimeList
50 -- | The available paths and operations for the API.
103 -- | The available paths and operations for the API.
51− , swaggerPaths :: SwaggerPaths
104+ -- Holds the relative paths to the individual endpoints.
105+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
106+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
53 -- | An object to hold data types produced and consumed by operations.
108 -- | An object to hold data types produced and consumed by operations.
54− , swaggerDefinitions :: HashMap Text SwaggerSchema
109+ , _swaggerDefinitions :: Definitions Schema
56 -- | An object to hold parameters that can be used across operations.
111 -- | An object to hold parameters that can be used across operations.
57 -- This property does not define global parameters for all operations.
112 -- This property does not define global parameters for all operations.
58− , swaggerParameters :: HashMap Text SwaggerParameter
113+ , _swaggerParameters :: Definitions Param
60 -- | An object to hold responses that can be used across operations.
115 -- | An object to hold responses that can be used across operations.
61 -- This property does not define global responses for all operations.
116 -- This property does not define global responses for all operations.
62− , swaggerResponses :: HashMap Text SwaggerResponse
117+ , _swaggerResponses :: Definitions Response
64 -- | Security scheme definitions that can be used across the specification.
119 -- | Security scheme definitions that can be used across the specification.
65− , swaggerSecurityDefinitions :: HashMap Text SwaggerSecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
67 -- | A declaration of which security schemes are applied for the API as a whole.
122 -- | A declaration of which security schemes are applied for the API as a whole.
68 -- The list of values describes alternative security schemes that can be used
123 -- The list of values describes alternative security schemes that can be used
69 -- (that is, there is a logical OR between the security requirements).
124 -- (that is, there is a logical OR between the security requirements).
70 -- Individual operations can override this definition.
125 -- Individual operations can override this definition.
71− , swaggerSecurity :: [SwaggerSecurityRequirement]
126+ , _swaggerSecurity :: [SecurityRequirement]
73 -- | A list of tags used by the specification with additional metadata.
128 -- | A list of tags used by the specification with additional metadata.
74 -- The order of the tags can be used to reflect on their order by the parsing tools.
129 -- The order of the tags can be used to reflect on their order by the parsing tools.
75 -- Not all tags that are used by the Operation Object must be declared.
130 -- Not all tags that are used by the Operation Object must be declared.
76 -- The tags that are not declared may be organized randomly or based on the tools' logic.
131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
77 -- Each tag name in the list MUST be unique.
132 -- Each tag name in the list MUST be unique.
78− , swaggerTags :: [SwaggerTag]
133+ , _swaggerTags :: InsOrdHashSet Tag
80 -- | Additional external documentation.
135 -- | Additional external documentation.
81− , swaggerExternalDocs :: SwaggerExternalDocs
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
82− } deriving (Show, Generic)
137+ } deriving (Eq, Show, Generic, Data, Typeable)
84-- | The object provides metadata about the API.
139-- | The object provides metadata about the API.
85-- The metadata can be used by the clients if needed,
140-- The metadata can be used by the clients if needed,
86-- and can be presented in the Swagger-UI for convenience.
141-- and can be presented in the Swagger-UI for convenience.
87−data SwaggerInfo = SwaggerInfo
142+data Info = Info
88 { -- | The title of the application.
143 { -- | The title of the application.
89− swaggerInfoTitle :: Text
144+ _infoTitle :: Text
91 -- | A short description of the application.
146 -- | A short description of the application.
92 -- GFM syntax can be used for rich text representation.
147 -- GFM syntax can be used for rich text representation.
93− , swaggerInfoDescription :: Maybe Text
148+ , _infoDescription :: Maybe Text
95 -- | The Terms of Service for the API.
150 -- | The Terms of Service for the API.
96− , swaggerInfoTermsOfService :: Maybe Text
151+ , _infoTermsOfService :: Maybe Text
98 -- | The contact information for the exposed API.
153 -- | The contact information for the exposed API.
99− , swaggerInfoContact :: Maybe SwaggerContact
154+ , _infoContact :: Maybe Contact
101 -- | The license information for the exposed API.
156 -- | The license information for the exposed API.
102− , swaggerInfoLicense :: Maybe SwaggerLicense
157+ , _infoLicense :: Maybe License
104 -- | Provides the version of the application API
159 -- | Provides the version of the application API
105 -- (not to be confused with the specification version).
160 -- (not to be confused with the specification version).
106− , swaggerInfoVersion :: Text
161+ , _infoVersion :: Text
107− } deriving (Show)
162+ } deriving (Eq, Show, Generic, Data, Typeable)
109-- | Contact information for the exposed API.
164-- | Contact information for the exposed API.
110−data SwaggerContact = SwaggerContact
165+data Contact = Contact
111 { -- | The identifying name of the contact person/organization.
166 { -- | The identifying name of the contact person/organization.
112− swaggerContactName :: Maybe Text
167+ _contactName :: Maybe Text
114 -- | The URL pointing to the contact information.
169 -- | The URL pointing to the contact information.
115− , swaggerContactUrl :: Maybe URL
170+ , _contactUrl :: Maybe URL
117 -- | The email address of the contact person/organization.
172 -- | The email address of the contact person/organization.
118− , swaggerContactEmail :: Maybe Text
173+ , _contactEmail :: Maybe Text
119− } deriving (Show)
174+ } deriving (Eq, Show, Generic, Data, Typeable)
121-- | License information for the exposed API.
176-- | License information for the exposed API.
122−data SwaggerLicense = SwaggerLicense
177+data License = License
123 { -- | The license name used for the API.
178 { -- | The license name used for the API.
124− swaggerLicenseName :: Text
179+ _licenseName :: Text
126 -- | A URL to the license used for the API.
181 -- | A URL to the license used for the API.
127− , swaggerLicenseUrl :: Maybe URL
182+ , _licenseUrl :: Maybe URL
128− } deriving (Show)
183+ } deriving (Eq, Show, Generic, Data, Typeable)
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
130-- | The host (name or ip) serving the API. It MAY include a port.
188-- | The host (name or ip) serving the API. It MAY include a port.
131−data SwaggerHost = SwaggerHost
189+data Host = Host
132− { swaggerHostName :: HostName -- ^ Host name.
190+ { _hostName :: HostName -- ^ Host name.
133− , swaggerHostPort :: Maybe PortNumber -- ^ Optional port.
191+ , _hostPort :: Maybe PortNumber -- ^ Optional port.
134− } deriving (Show)
192+ } deriving (Eq, Show, Generic, Typeable)
136−instance ToJSON SwaggerHost where
194+instance IsString Host where
137− toJSON (SwaggerHost host mport) = toJSON $
195+ fromString s = Host s Nothing
139− Nothing -> host
197+hostConstr :: Constr
140− Just port -> host ++ ":" ++ show port
198+hostConstr = mkConstr hostDataType "Host" [] Prefix
200+hostDataType :: DataType
201+hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
203+instance Data Host where
204+ gunfold k z c = case constrIndex c of
205+ 1 -> k (k (z (\name mport -> Host name (fromInteger <$> mport))))
206+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Host."
207+ toConstr (Host _ _) = hostConstr
208+ dataTypeOf _ = hostDataType
142-- | The transfer protocol of the API.
210-- | The transfer protocol of the API.
143−data SwaggerScheme
211+data Scheme
148− deriving (Show)
216+ deriving (Eq, Show, Generic, Data, Typeable)
150−-- | The available paths and operations for the API.
151−data SwaggerPaths = SwaggerPaths
152− { -- | Holds the relative paths to the individual endpoints.
153− -- The path is appended to the @'swaggerBasePath'@ in order to construct the full URL.
154− swaggerPathsMap :: HashMap FilePath SwaggerPathItem
157−instance ToJSON SwaggerPaths where
158− toJSON (SwaggerPaths m) = toJSON m
160-- | Describes the operations available on a single path.
218-- | Describes the operations available on a single path.
161−-- A @'SwaggerPathItem'@ may be empty, due to ACL constraints.
219+-- A @'PathItem'@ may be empty, due to ACL constraints.
162-- The path itself is still exposed to the documentation viewer
220-- The path itself is still exposed to the documentation viewer
163-- but they will not know which operations and parameters are available.
221-- but they will not know which operations and parameters are available.
164−data SwaggerPathItem = SwaggerPathItem
222+data PathItem = PathItem
165 { -- | A definition of a GET operation on this path.
223 { -- | A definition of a GET operation on this path.
166− swaggerPathItemGet :: Maybe SwaggerOperation
224+ _pathItemGet :: Maybe Operation
168 -- | A definition of a PUT operation on this path.
226 -- | A definition of a PUT operation on this path.
169− , swaggerPathItemPut :: Maybe SwaggerOperation
227+ , _pathItemPut :: Maybe Operation
171 -- | A definition of a POST operation on this path.
229 -- | A definition of a POST operation on this path.
172− , swaggerPathItemPost :: Maybe SwaggerOperation
230+ , _pathItemPost :: Maybe Operation
174 -- | A definition of a DELETE operation on this path.
232 -- | A definition of a DELETE operation on this path.
175− , swaggerPathItemDelete :: Maybe SwaggerOperation
233+ , _pathItemDelete :: Maybe Operation
177 -- | A definition of a OPTIONS operation on this path.
235 -- | A definition of a OPTIONS operation on this path.
178− , swaggerPathItemOptions :: Maybe SwaggerOperation
236+ , _pathItemOptions :: Maybe Operation
180 -- | A definition of a HEAD operation on this path.
238 -- | A definition of a HEAD operation on this path.
181− , swaggerPathItemHead :: Maybe SwaggerOperation
239+ , _pathItemHead :: Maybe Operation
183 -- | A definition of a PATCH operation on this path.
241 -- | A definition of a PATCH operation on this path.
184− , swaggerPathItemPatch :: Maybe SwaggerOperation
242+ , _pathItemPatch :: Maybe Operation
186 -- | A list of parameters that are applicable for all the operations described under this path.
244 -- | A list of parameters that are applicable for all the operations described under this path.
187 -- These parameters can be overridden at the operation level, but cannot be removed there.
245 -- These parameters can be overridden at the operation level, but cannot be removed there.
188 -- The list MUST NOT include duplicated parameters.
246 -- The list MUST NOT include duplicated parameters.
189 -- A unique parameter is defined by a combination of a name and location.
247 -- A unique parameter is defined by a combination of a name and location.
190− , swaggerPathItemParameters :: [SwaggerParameter]
248+ , _pathItemParameters :: [Referenced Param]
191− } deriving (Show)
249+ } deriving (Eq, Show, Generic, Data, Typeable)
193-- | Describes a single API operation on a path.
251-- | Describes a single API operation on a path.
194−data SwaggerOperation = SwaggerOperation
252+data Operation = Operation
195 { -- | A list of tags for API documentation control.
253 { -- | A list of tags for API documentation control.
196 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
197− swaggerOperationTags :: [Text]
255+ _operationTags :: InsOrdHashSet TagName
199 -- | A short summary of what the operation does.
257 -- | A short summary of what the operation does.
200 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
201− , swaggerOperationSummary :: Maybe Text
259+ , _operationSummary :: Maybe Text
203 -- | A verbose explanation of the operation behavior.
261 -- | A verbose explanation of the operation behavior.
204 -- GFM syntax can be used for rich text representation.
262 -- GFM syntax can be used for rich text representation.
205− , swaggerOperationDescription :: Maybe Text
263+ , _operationDescription :: Maybe Text
207 -- | Additional external documentation for this operation.
265 -- | Additional external documentation for this operation.
208− , swaggerOperationExternalDocs :: Maybe SwaggerExternalDocs
266+ , _operationExternalDocs :: Maybe ExternalDocs
210 -- | Unique string used to identify the operation.
268 -- | Unique string used to identify the operation.
211 -- The id MUST be unique among all operations described in the API.
269 -- The id MUST be unique among all operations described in the API.
212 -- Tools and libraries MAY use the it to uniquely identify an operation,
270 -- Tools and libraries MAY use the it to uniquely identify an operation,
213 -- therefore, it is recommended to follow common programming naming conventions.
271 -- therefore, it is recommended to follow common programming naming conventions.
214− , swaggerOperationOperationId :: Maybe Text
272+ , _operationOperationId :: Maybe Text
216 -- | A list of MIME types the operation can consume.
274 -- | A list of MIME types the operation can consume.
217− -- This overrides the @'swaggerConsumes'@.
275+ -- This overrides the @'consumes'@.
218 -- @Just []@ MAY be used to clear the global definition.
276 -- @Just []@ MAY be used to clear the global definition.
219− , swaggerOperationConsumes :: Maybe SwaggerMimeList
277+ , _operationConsumes :: Maybe MimeList
221 -- | A list of MIME types the operation can produce.
279 -- | A list of MIME types the operation can produce.
222− -- This overrides the @'swaggerProduces'@.
280+ -- This overrides the @'produces'@.
223 -- @Just []@ MAY be used to clear the global definition.
281 -- @Just []@ MAY be used to clear the global definition.
224− , swaggerOperationProduces :: Maybe SwaggerMimeList
282+ , _operationProduces :: Maybe MimeList
226 -- | A list of parameters that are applicable for this operation.
284 -- | A list of parameters that are applicable for this operation.
227− -- If a parameter is already defined at the @'SwaggerPathItem'@,
285+ -- If a parameter is already defined at the @'PathItem'@,
228 -- the new definition will override it, but can never remove it.
286 -- the new definition will override it, but can never remove it.
229 -- The list MUST NOT include duplicated parameters.
287 -- The list MUST NOT include duplicated parameters.
230 -- A unique parameter is defined by a combination of a name and location.
288 -- A unique parameter is defined by a combination of a name and location.
231− , swaggerOperationParameters :: [SwaggerParameter]
289+ , _operationParameters :: [Referenced Param]
233 -- | The list of possible responses as they are returned from executing this operation.
291 -- | The list of possible responses as they are returned from executing this operation.
234− , swaggerOperationResponses :: SwaggerResponses
292+ , _operationResponses :: Responses
236 -- | The transfer protocol for the operation.
294 -- | The transfer protocol for the operation.
237− -- The value overrides @'swaggerSchemes'@.
295+ -- The value overrides @'schemes'@.
238− , swaggerOperationSchemes :: Maybe [SwaggerScheme]
296+ , _operationSchemes :: Maybe [Scheme]
240 -- | Declares this operation to be deprecated.
298 -- | Declares this operation to be deprecated.
241 -- Usage of the declared operation should be refrained.
299 -- Usage of the declared operation should be refrained.
242 -- Default value is @False@.
300 -- Default value is @False@.
243− , swaggerOperationDeprecated :: Bool
301+ , _operationDeprecated :: Maybe Bool
245 -- | A declaration of which security schemes are applied for this operation.
303 -- | A declaration of which security schemes are applied for this operation.
246 -- The list of values describes alternative security schemes that can be used
304 -- The list of values describes alternative security schemes that can be used
247 -- (that is, there is a logical OR between the security requirements).
305 -- (that is, there is a logical OR between the security requirements).
248 -- This definition overrides any declared top-level security.
306 -- This definition overrides any declared top-level security.
249 -- To remove a top-level security declaration, @Just []@ can be used.
307 -- To remove a top-level security declaration, @Just []@ can be used.
250− , swaggerOperationSecurity :: [SwaggerSecurityRequirement]
308+ , _operationSecurity :: [SecurityRequirement]
251− } deriving (Show)
309+ } deriving (Eq, Show, Generic, Data, Typeable)
311+newtype MimeList = MimeList { getMimeList :: [MediaType] }
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
253−newtype SwaggerMimeList = SwaggerMimeList { getSwaggerMimeList :: [MediaType] }
314+mimeListConstr :: Constr
254− deriving (Show)
315+mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
317+mimeListDataType :: DataType
318+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
256−instance ToJSON SwaggerMimeList where
320+instance Data MimeList where
257− toJSON (SwaggerMimeList xs) = toJSON (map show xs)
321+ gunfold k z c = case constrIndex c of
322+ 1 -> k (z (\xs -> MimeList (map fromString xs)))
323+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
324+ toConstr (MimeList _) = mimeListConstr
325+ dataTypeOf _ = mimeListDataType
259-- | Describes a single operation parameter.
327-- | Describes a single operation parameter.
260-- A unique parameter is defined by a combination of a name and location.
328-- A unique parameter is defined by a combination of a name and location.
261−data SwaggerParameter = SwaggerParameter
329+data Param = Param
262 { -- | The name of the parameter.
330 { -- | The name of the parameter.
263 -- Parameter names are case sensitive.
331 -- Parameter names are case sensitive.
264− swaggerParameterName :: Text
332+ _paramName :: Text
266 -- | A brief description of the parameter.
334 -- | A brief description of the parameter.
267 -- This could contain examples of use.
335 -- This could contain examples of use.
268 -- GFM syntax can be used for rich text representation.
336 -- GFM syntax can be used for rich text representation.
269− , swaggerParameterDescription :: Maybe Text
337+ , _paramDescription :: Maybe Text
271 -- | Determines whether this parameter is mandatory.
339 -- | Determines whether this parameter is mandatory.
272 -- If the parameter is in "path", this property is required and its value MUST be true.
340 -- If the parameter is in "path", this property is required and its value MUST be true.
273 -- Otherwise, the property MAY be included and its default value is @False@.
341 -- Otherwise, the property MAY be included and its default value is @False@.
274− , swaggerParameterRequired :: Bool
342+ , _paramRequired :: Maybe Bool
276 -- | Parameter schema.
344 -- | Parameter schema.
277− , swaggerParameterSchema :: SwaggerParameterSchema
345+ , _paramSchema :: ParamAnySchema
278− } deriving (Show, Generic)
346+ } deriving (Eq, Show, Generic, Data, Typeable)
280−instance ToJSON SwaggerParameter where
281− toJSON = genericToJSONWithSub "schema" (jsonPrefix "swaggerParameter")
283−data SwaggerParameterSchema
284− = SwaggerParameterBody SwaggerSchema
285− | SwaggerParameterOther SwaggerParameterOtherSchema
288−instance ToJSON SwaggerParameterSchema where
348+data ParamAnySchema
289− toJSON (SwaggerParameterBody s) = toJSON s <+> object [ "in" .= ("body" :: Text) ]
349+ = ParamBody (Referenced Schema)
290− toJSON (SwaggerParameterOther s) = toJSON s
350+ | ParamOther ParamOtherSchema
351+ deriving (Eq, Show, Generic, Data, Typeable)
292−data SwaggerParameterOtherSchema = SwaggerParameterOtherSchema
353+data ParamOtherSchema = ParamOtherSchema
293 { -- | The location of the parameter.
354 { -- | The location of the parameter.
294− swaggerParameterOtherSchemaIn :: SwaggerParameterLocation
355+ _paramOtherSchemaIn :: ParamLocation
296− -- | The type of the parameter.
297− -- Since the parameter is not located at the request body,
298− -- it is limited to simple types (that is, not an object).
299− -- If type is @'SwaggerParamFile'@, the @consumes@ MUST be either
300− -- "multipart/form-data" or " application/x-www-form-urlencoded"
301− -- and the parameter MUST be in @'SwaggerParameterFormData'@.
302− , swaggerParameterOtherSchemaType :: SwaggerParameterType
304− -- | The extending format for the previously mentioned type.
305− , swaggerParameterOtherSchemaFormat :: Maybe SwaggerFormat
307 -- | Sets the ability to pass empty-valued parameters.
357 -- | Sets the ability to pass empty-valued parameters.
308− -- This is valid only for either @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@
358+ -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
309 -- and allows you to send a parameter with a name only or an empty value.
359 -- and allows you to send a parameter with a name only or an empty value.
310 -- Default value is @False@.
360 -- Default value is @False@.
311− , swaggerParameterOtherSchemaAllowEmptyValue :: Bool
361+ , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
313− -- | __Required if type is @'SwaggerParamArray'@__.
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
314− -- Describes the type of items in the array.
364+ } deriving (Eq, Show, Generic, Typeable, Data)
315− , swaggerParameterOtherSchemaItems :: Maybe SwaggerItems
365+
316−
366+-- | Items for @'SwaggerArray'@ schemas.
317− -- | Determines the format of the array if @'SwaggerParamArray'@ is used.
367+--
318− -- Default value is csv.
368+-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
319− , swaggerParameterOtherSchemaCollectionFormat :: Maybe SwaggerCollectionFormat
369+-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
320−
370+-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
321− , swaggerParameterOtherSchemaCommon :: SwaggerSchemaCommon
371+-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
322− } deriving (Show, Generic)
372+--
323−
373+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
324−instance ToJSON SwaggerParameterOtherSchema where
374+--
325− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
375+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
326−
376+data SwaggerItems t where
327−data SwaggerParameterType
377+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
328− = SwaggerParamString
378+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
329− | SwaggerParamNumber
379+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
330− | SwaggerParamInteger
380+ deriving (Typeable)
331− | SwaggerParamBoolean
381+
332− | SwaggerParamArray
382+deriving instance Eq (SwaggerItems t)
333− | SwaggerParamFile
383+deriving instance Show (SwaggerItems t)
334− deriving (Show)
384+--deriving instance Typeable (SwaggerItems t)
336−data SwaggerParameterLocation
386+swaggerItemsPrimitiveConstr :: Constr
387+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
395+swaggerItemsDataType :: DataType
396+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
398+-- Note: unfortunately we have to write these Data instances by hand,
399+-- to get better contexts / avoid duplicate name when using standalone deriving
401+instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
402+ -- TODO: define gfoldl
403+ gunfold k z c = case constrIndex c of
404+ 1 -> k (k (z SwaggerItemsPrimitive))
405+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406+ toConstr _ = swaggerItemsPrimitiveConstr
407+ dataTypeOf _ = swaggerItemsDataType
409+-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
410+instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411+ -- TODO: define gfoldl
412+ gunfold k z c = case constrIndex c of
413+ 1 -> k (k (z SwaggerItemsPrimitive))
414+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415+ toConstr _ = swaggerItemsPrimitiveConstr
416+ dataTypeOf _ = swaggerItemsDataType
418+instance Data (SwaggerItems 'SwaggerKindSchema) where
419+ gfoldl _ _ (SwaggerItemsPrimitive _ _) = error $ " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
420+ gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
421+ gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
423+ gunfold k z c = case constrIndex c of
424+ 2 -> k (z SwaggerItemsObject)
425+ 3 -> k (z SwaggerItemsArray)
426+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
428+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
432+ dataTypeOf _ = swaggerItemsDataType
434+-- | Type used as a kind to avoid overlapping instances.
436+ = SwaggerKindNormal t
437+ | SwaggerKindParamOtherSchema
441+deriving instance Typeable 'SwaggerKindNormal
442+deriving instance Typeable 'SwaggerKindParamOtherSchema
443+deriving instance Typeable 'SwaggerKindSchema
445+type family SwaggerKindType (k :: SwaggerKind *) :: *
446+type instance SwaggerKindType ('SwaggerKindNormal t) = t
447+type instance SwaggerKindType 'SwaggerKindSchema = Schema
448+type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
450+data SwaggerType t where
451+ SwaggerString :: SwaggerType t
452+ SwaggerNumber :: SwaggerType t
453+ SwaggerInteger :: SwaggerType t
454+ SwaggerBoolean :: SwaggerType t
455+ SwaggerArray :: SwaggerType t
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
461+deriving instance Eq (SwaggerType t)
462+deriving instance Show (SwaggerType t)
464+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
470+swaggerCommonTypes :: [SwaggerType k]
471+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
479+swaggerTypeConstrs :: [Constr]
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485+ toConstr = swaggerTypeConstr
486+ dataTypeOf = swaggerTypeDataType
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490+ toConstr = swaggerTypeConstr
491+ dataTypeOf = swaggerTypeDataType
493+instance Data (SwaggerType 'SwaggerKindSchema) where
494+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495+ toConstr = swaggerTypeConstr
496+ dataTypeOf = swaggerTypeDataType
337 = -- | Parameters that are appended to the URL.
499 = -- | Parameters that are appended to the URL.
338 -- For example, in @/items?id=###@, the query parameter is @id@.
500 -- For example, in @/items?id=###@, the query parameter is @id@.
339− SwaggerParameterQuery
501+ ParamQuery
340 -- | Custom headers that are expected as part of the request.
502 -- | Custom headers that are expected as part of the request.
341− | SwaggerParameterHeader
503+ | ParamHeader
342 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
504 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
343 -- This does not include the host or base path of the API.
505 -- This does not include the host or base path of the API.
344 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
506 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
345− | SwaggerParameterPath
507+ | ParamPath
346 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
508 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
347 -- or @multipart/form-data@ are used as the content type of the request
509 -- or @multipart/form-data@ are used as the content type of the request
348 -- (in Swagger's definition, the @consumes@ property of an operation).
510 -- (in Swagger's definition, the @consumes@ property of an operation).
349− -- This is the only parameter type that can be used to send files, thus supporting the @'SwaggerParamFile'@ type.
511+ -- This is the only parameter type that can be used to send files, thus supporting the @'ParamFile'@ type.
350 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
512 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
351 -- Form parameters have a different format based on the content-type used
513 -- Form parameters have a different format based on the content-type used
352 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
514 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
353− | SwaggerParameterFormData
515+ | ParamFormData
354− deriving (Show)
516+ deriving (Eq, Show, Generic, Data, Typeable)
356−type SwaggerFormat = Text
518+type Format = Text
358-- | Determines the format of the array.
520-- | Determines the format of the array.
359−data SwaggerCollectionFormat
521+data CollectionFormat t where
360− = SwaggerCollectionCSV -- ^ Comma separated values: @foo,bar@.
522+ -- Comma separated values: @foo,bar@.
523+ CollectionCSV :: CollectionFormat t
361− | SwaggerCollectionSSV -- ^ Space separated values @foo bar@.
524+ -- Space separated values: @foo bar@.
525+ CollectionSSV :: CollectionFormat t
362− | SwaggerCollectionTSV -- ^ Tab separated values @foo\\tbar@.
526+ -- Tab separated values: @foo\\tbar@.
527+ CollectionTSV :: CollectionFormat t
363− | SwaggerCollectionPipes -- ^ Pipe separated values @foo|bar@.
528+ -- Pipe separated values: @foo|bar@.
529+ CollectionPipes :: CollectionFormat t
364− -- | Corresponds to multiple parameter instances
530+ -- Corresponds to multiple parameter instances
365− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
531+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
366− -- This is valid only for parameters in @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@.
532+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
367− | SwaggerCollectionMulti
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
368− deriving (Show)
534+ deriving (Typeable)
370−data SwaggerItemsType
536+deriving instance Eq (CollectionFormat t)
371− = SwaggerItemsString
537+deriving instance Show (CollectionFormat t)
372− | SwaggerItemsNumber
538+
373− | SwaggerItemsInteger
539+collectionFormatConstr :: CollectionFormat t -> Constr
374− | SwaggerItemsBoolean
540+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
375− | SwaggerItemsArray
541+
376− deriving (Show)
542+collectionFormatDataType :: DataType
377−
543+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
378−data SwaggerSchemaType
544+ map collectionFormatConstr collectionCommonFormats
379− = SwaggerSchemaArray
545+
380− | SwaggerSchemaBoolean
546+collectionCommonFormats :: [CollectionFormat t]
381− | SwaggerSchemaInteger
547+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
382− | SwaggerSchemaNumber
548+
383− | SwaggerSchemaNull
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
384− | SwaggerSchemaObject
550+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
385− | SwaggerSchemaString
551+ toConstr = collectionFormatConstr
386− deriving (Show)
552+ dataTypeOf _ = collectionFormatDataType
388−-- | Determines the format of the nested array.
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
389−data SwaggerItemsCollectionFormat
555+
390− = SwaggerItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
556+type ParamName = Text
391− | SwaggerItemsCollectionSSV -- ^ Space separated values @foo bar@.
557+
392− | SwaggerItemsCollectionTSV -- ^ Tab separated values @foo\\tbar@.
558+data Schema = Schema
393− | SwaggerItemsCollectionPipes -- ^ Pipe separated values @foo|bar@.
559+ { _schemaTitle :: Maybe Text
394− deriving (Show)
560+ , _schemaDescription :: Maybe Text
395−
561+ , _schemaRequired :: [ParamName]
396−data SwaggerSchema = SwaggerSchema
562+
397− { swaggerSchemaType :: SwaggerSchemaType
563+ , _schemaAllOf :: Maybe [Referenced Schema]
398− , swaggerSchemaFormat :: SwaggerFormat
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
399− , swaggerSchemaTitle :: Maybe Text
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
400− , swaggerSchemaDescription :: Maybe Text
566+
401− , swaggerSchemaRequired :: Maybe Bool
567+ , _schemaDiscriminator :: Maybe Text
402−
568+ , _schemaReadOnly :: Maybe Bool
403− , swaggerSchemaItems :: SwaggerSchemaItems
569+ , _schemaXml :: Maybe Xml
404− , swaggerSchemaAllOf :: [SwaggerSchema]
570+ , _schemaExternalDocs :: Maybe ExternalDocs
405− , swaggerSchemaProperties :: HashMap Text SwaggerSchema
571+ , _schemaExample :: Maybe Value
406− , swaggerSchemaAdditionalProperties :: Maybe SwaggerSchema
572+
407−
573+ , _schemaMaxProperties :: Maybe Integer
408− , swaggerSchemaDiscriminator :: Maybe Text
574+ , _schemaMinProperties :: Maybe Integer
409− , swaggerSchemaReadOnly :: Maybe Bool
575+
410− , swaggerSchemaXml :: Maybe SwaggerXml
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
411− , swaggerSchemaExternalDocs :: Maybe SwaggerExternalDocs
412− , swaggerSchemaExample :: Maybe Value
414− , swaggerSchemaMaxProperties :: Maybe Integer
415− , swaggerSchemaMinProperties :: Maybe Integer
417− , swaggerSchemaCommon :: SwaggerSchemaCommon
418− } deriving (Show, Generic)
577+ } deriving (Eq, Show, Generic, Data, Typeable)
420−data SwaggerSchemaItems
579+-- | A @'Schema'@ with an optional name.
421− = SwaggerSchemaItemsObject SwaggerSchema
580+-- This name can be used in references.
422− | SwaggerSchemaItemsArray [SwaggerSchema]
581+data NamedSchema = NamedSchema
582+ { _namedSchemaName :: Maybe Text
583+ , _namedSchemaSchema :: Schema
423− deriving (Show)
584+ } deriving (Eq, Show, Generic, Data, Typeable)
425−instance ToJSON SwaggerSchemaItems where
586+-- | Regex pattern for @string@ type.
426− toJSON (SwaggerSchemaItemsObject x) = toJSON x
587+type Pattern = Text
427− toJSON (SwaggerSchemaItemsArray xs) = toJSON xs
588+
428−
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
429−data SwaggerSchemaCommon = SwaggerSchemaCommon
430 { -- | Declares the value of the parameter that the server will use if none is provided,
590 { -- | Declares the value of the parameter that the server will use if none is provided,
431 -- for example a @"count"@ to control the number of results per page might default to @100@
591 -- for example a @"count"@ to control the number of results per page might default to @100@
432 -- if not supplied by the client in the request.
592 -- if not supplied by the client in the request.
433 -- (Note: "default" has no meaning for required parameters.)
593 -- (Note: "default" has no meaning for required parameters.)
434 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
435− swaggerSchemaDefault :: Maybe Value
595+ _paramSchemaDefault :: Maybe Value
437− , swaggerSchemaMaximum :: Maybe Integer
597+ , _paramSchemaType :: Maybe (SwaggerType t)
438− , swaggerSchemaExclusiveMaximum :: Maybe Bool
598+ , _paramSchemaFormat :: Maybe Format
439− , swaggerSchemaMinimum :: Maybe Integer
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
440− , swaggerSchemaExclusiveMinimum :: Maybe Bool
600+ , _paramSchemaMaximum :: Maybe Scientific
441− , swaggerSchemaMaxLength :: Maybe Integer
601+ , _paramSchemaExclusiveMaximum :: Maybe Bool
442− , swaggerSchemaMinLength :: Maybe Integer
602+ , _paramSchemaMinimum :: Maybe Scientific
443− , swaggerSchemaPattern :: Maybe Text
603+ , _paramSchemaExclusiveMinimum :: Maybe Bool
444− , swaggerSchemaMaxItems :: Maybe Integer
604+ , _paramSchemaMaxLength :: Maybe Integer
445− , swaggerSchemaMinItems :: Maybe Integer
605+ , _paramSchemaMinLength :: Maybe Integer
446− , swaggerSchemaUniqueItems :: Maybe Bool
606+ , _paramSchemaPattern :: Maybe Pattern
447− , swaggerSchemaEnum :: Maybe [Value]
607+ , _paramSchemaMaxItems :: Maybe Integer
448− , swaggerSchemaMultipleOf :: Maybe Integer
608+ , _paramSchemaMinItems :: Maybe Integer
609+ , _paramSchemaUniqueItems :: Maybe Bool
610+ , _paramSchemaEnum :: Maybe [Value]
611+ , _paramSchemaMultipleOf :: Maybe Scientific
449− } deriving (Show, Generic)
612+ } deriving (Eq, Show, Generic, Typeable)
451−data SwaggerXml = SwaggerXml
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
452 { -- | Replaces the name of the element/attribute used for the described schema property.
617 { -- | Replaces the name of the element/attribute used for the described schema property.
453 -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
618 -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
454 -- When defined alongside type being array (outside the items),
619 -- When defined alongside type being array (outside the items),
455 -- it will affect the wrapping element and only if wrapped is true.
620 -- it will affect the wrapping element and only if wrapped is true.
456 -- If wrapped is false, it will be ignored.
621 -- If wrapped is false, it will be ignored.
457− swaggerXmlName :: Maybe Text
622+ _xmlName :: Maybe Text
459 -- | The URL of the namespace definition.
624 -- | The URL of the namespace definition.
460 -- Value SHOULD be in the form of a URL.
625 -- Value SHOULD be in the form of a URL.
461− , swaggerXmlNamespace :: Maybe Text
626+ , _xmlNamespace :: Maybe Text
463 -- | The prefix to be used for the name.
628 -- | The prefix to be used for the name.
464− , swaggerXmlPrefix :: Maybe Text
629+ , _xmlPrefix :: Maybe Text
466 -- | Declares whether the property definition translates to an attribute instead of an element.
631 -- | Declares whether the property definition translates to an attribute instead of an element.
467 -- Default value is @False@.
632 -- Default value is @False@.
468− , swaggerXmlAttribute :: Bool
633+ , _xmlAttribute :: Maybe Bool
470 -- | MAY be used only for an array definition.
635 -- | MAY be used only for an array definition.
471 -- Signifies whether the array is wrapped
636 -- Signifies whether the array is wrapped
@@ -473,111 +638,87 @@ data SwaggerXml = SwaggerXml
473 -- or unwrapped (@\<book/\>\<book/\>@).
638 -- or unwrapped (@\<book/\>\<book/\>@).
474 -- Default value is @False@.
639 -- Default value is @False@.
475 -- The definition takes effect only when defined alongside type being array (outside the items).
640 -- The definition takes effect only when defined alongside type being array (outside the items).
476− , swaggerXmlWrapped :: Bool
641+ , _xmlWrapped :: Maybe Bool
479−data SwaggerItems = SwaggerItems
480− { -- | The internal type of the array.
481− swaggerItemsType :: SwaggerItemsType
483− -- | The extending format for the previously mentioned type.
484− , swaggerItemsFormat :: SwaggerFormat
486− -- | __Required if type is @'SwaggerItemsArray'@.__
487− -- Describes the type of items in the array.
488− , swaggerItemsItems :: SwaggerItems
490− -- | Determines the format of the array if type array is used.
491− -- Default value is @'SwaggerItemsCollectionCSV'@.
492− , swaggerItemsCollectionFormat :: SwaggerItemsCollectionFormat
494− , swaggerItemsCommon :: SwaggerSchemaCommon
495− } deriving (Show, Generic)
642+ } deriving (Eq, Show, Generic, Data, Typeable)
497-- | A container for the expected responses of an operation.
644-- | A container for the expected responses of an operation.
498-- The container maps a HTTP response code to the expected response.
645-- The container maps a HTTP response code to the expected response.
499-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
500-- since they may not be known in advance.
647-- since they may not be known in advance.
501-- However, it is expected from the documentation to cover a successful operation response and any known errors.
648-- However, it is expected from the documentation to cover a successful operation response and any known errors.
502−data SwaggerResponses = SwaggerResponses
649+data Responses = Responses
503 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
650 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
504 -- It can be used to cover undeclared responses.
651 -- It can be used to cover undeclared responses.
505− swaggerResponsesDefault :: Maybe SwaggerResponse
652+ _responsesDefault :: Maybe (Referenced Response)
507 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
508 -- Describes the expected response for those HTTP status codes.
655 -- Describes the expected response for those HTTP status codes.
509− , swaggerResponsesResponses :: HashMap HttpStatusCode SwaggerResponse
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
510− } deriving (Show)
657+ } deriving (Eq, Show, Generic, Data, Typeable)
512−instance ToJSON SwaggerResponses where
513− toJSON (SwaggerResponses def rs) = object
515− , "responses" .= hashMapMapKeys show rs ]
517type HttpStatusCode = Int
659type HttpStatusCode = Int
519-- | Describes a single response from an API Operation.
661-- | Describes a single response from an API Operation.
520−data SwaggerResponse = SwaggerResponse
662+data Response = Response
521 { -- | A short description of the response.
663 { -- | A short description of the response.
522 -- GFM syntax can be used for rich text representation.
664 -- GFM syntax can be used for rich text representation.
523− swaggerResponseDescription :: Text
665+ _responseDescription :: Text
525 -- | A definition of the response structure.
667 -- | A definition of the response structure.
526 -- It can be a primitive, an array or an object.
668 -- It can be a primitive, an array or an object.
527 -- If this field does not exist, it means no content is returned as part of the response.
669 -- If this field does not exist, it means no content is returned as part of the response.
528 -- As an extension to the Schema Object, its root type value may also be "file".
670 -- As an extension to the Schema Object, its root type value may also be "file".
529 -- This SHOULD be accompanied by a relevant produces mime-type.
671 -- This SHOULD be accompanied by a relevant produces mime-type.
530− , swaggerResponseSchema :: Maybe SwaggerSchema
672+ , _responseSchema :: Maybe (Referenced Schema)
532 -- | A list of headers that are sent with the response.
674 -- | A list of headers that are sent with the response.
533− , swaggerResponseHeaders :: HashMap HeaderName SwaggerHeader
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
535 -- | An example of the response message.
677 -- | An example of the response message.
536− , swaggerResponseExamples :: Maybe SwaggerExample
678+ , _responseExamples :: Maybe Example
537− } deriving (Show)
679+ } deriving (Eq, Show, Generic, Data, Typeable)
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
539type HeaderName = Text
684type HeaderName = Text
541−data SwaggerHeader = SwaggerHeader
686+data Header = Header
542 { -- | A short description of the header.
687 { -- | A short description of the header.
543− swaggerHeaderDescription :: Maybe String
688+ _headerDescription :: Maybe Text
545− -- | The type of the object.
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
546− , swaggerHeaderType :: SwaggerItemsType
691+ } deriving (Eq, Show, Generic, Data, Typeable)
548− -- | The extending format for the previously mentioned type. See Data Type Formats for further details.
693+data Example = Example { getExample :: Map MediaType Value }
549− , swaggerHeaderFormat :: Maybe SwaggerFormat
694+ deriving (Eq, Show, Generic, Typeable)
551− -- | __Required if type is @'SwaggerItemsArray'@__.
696+exampleConstr :: Constr
552− -- Describes the type of items in the array.
697+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
553− , swaggerHeaderItems :: SwaggerItems
555− -- | Determines the format of the array if type array is used.
699+exampleDataType :: DataType
556− -- Default value is @'SwaggerItemsCollectionCSV'@.
700+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
557− , swaggerHeaderCollectionFormat :: SwaggerItemsCollectionFormat
559− , swaggerHeaderCommon :: SwaggerSchemaCommon
560− } deriving (Show, Generic)
562−data SwaggerExample = SwaggerExample { getSwaggerExample :: HashMap MediaType Value }
565−instance ToJSON SwaggerExample where
702+instance Data Example where
566− toJSON = toJSON . hashMapMapKeys show . getSwaggerExample
703+ gunfold k z c = case constrIndex c of
704+ 1 -> k (z (\m -> Example (Map.mapKeys fromString m)))
705+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Example."
706+ toConstr (Example _) = exampleConstr
707+ dataTypeOf _ = exampleDataType
568-- | The location of the API key.
709-- | The location of the API key.
569−data SwaggerApiKeyLocation
710+data ApiKeyLocation
570− = SwaggerApiKeyQuery
711+ = ApiKeyQuery
571− | SwaggerApiKeyHeader
712+ | ApiKeyHeader
572− deriving (Show)
713+ deriving (Eq, Show, Generic, Data, Typeable)
574−data SwaggerApiKeyParams = SwaggerApiKeyParams
715+data ApiKeyParams = ApiKeyParams
575 { -- | The name of the header or query parameter to be used.
716 { -- | The name of the header or query parameter to be used.
576− swaggerApiKeyName :: Text
717+ _apiKeyName :: Text
578 -- | The location of the API key.
719 -- | The location of the API key.
579− , swaggerApiKeyIn :: SwaggerApiKeyLocation
720+ , _apiKeyIn :: ApiKeyLocation
580− } deriving (Show)
721+ } deriving (Eq, Show, Generic, Data, Typeable)
582-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
583type AuthorizationURL = Text
724type AuthorizationURL = Text
@@ -585,148 +726,702 @@ type AuthorizationURL = Text
585-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
726-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
586type TokenURL = Text
727type TokenURL = Text
588−data SwaggerOAuth2Flow
729+data OAuth2Flow
589− = SwaggerOAuth2Implicit AuthorizationURL
730+ = OAuth2Implicit AuthorizationURL
590− | SwaggerOAuth2Password TokenURL
731+ | OAuth2Password TokenURL
591− | SwaggerOAuth2Application TokenURL
732+ | OAuth2Application TokenURL
592− | SwaggerOAuth2AccessCode AuthorizationURL TokenURL
733+ | OAuth2AccessCode AuthorizationURL TokenURL
593− deriving (Show)
734+ deriving (Eq, Show, Generic, Data, Typeable)
595−data SwaggerOAuth2Params = SwaggerOAuth2Params
736+data OAuth2Params = OAuth2Params
596 { -- | The flow used by the OAuth2 security scheme.
737 { -- | The flow used by the OAuth2 security scheme.
597− swaggerOAuth2Flow :: SwaggerOAuth2Flow
738+ _oauth2Flow :: OAuth2Flow
599 -- | The available scopes for the OAuth2 security scheme.
740 -- | The available scopes for the OAuth2 security scheme.
600− , swaggerOAuth2Scopes :: HashMap Text Text
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
601− } deriving (Show, Generic)
742+ } deriving (Eq, Show, Generic, Data, Typeable)
603−data SwaggerSecuritySchemeType
744+data SecuritySchemeType
604− = SwaggerSecuritySchemeBasic
745+ = SecuritySchemeBasic
605− | SwaggerSecuritySchemeApiKey SwaggerApiKeyParams
746+ | SecuritySchemeApiKey ApiKeyParams
606− | SwaggerSecuritySchemeOAuth2 SwaggerOAuth2Params
747+ | SecuritySchemeOAuth2 OAuth2Params
607− deriving (Show)
748+ deriving (Eq, Show, Generic, Data, Typeable)
609−data SwaggerSecuritySchemeTypeName
750+data SecurityScheme = SecurityScheme
610− = SwaggerSecuritySchemeTypeBasic
751+ { -- | The type of the security scheme.
611− | SwaggerSecuritySchemeTypeApiKey
752+ _securitySchemeType :: SecuritySchemeType
612− | SwaggerSecuritySchemeTypeOAuth2
613− deriving (Eq, Read, Show, Generic)
615−swaggerSecuritySchemeTypeNameText :: SwaggerSecuritySchemeTypeName -> Text
754+ -- | A short description for security scheme.
616−swaggerSecuritySchemeTypeNameText SwaggerSecuritySchemeTypeBasic = "basic"
755+ , _securitySchemeDescription :: Maybe Text
617−swaggerSecuritySchemeTypeNameText SwaggerSecuritySchemeTypeApiKey = "apiKey"
756+ } deriving (Eq, Show, Generic, Data, Typeable)
618−swaggerSecuritySchemeTypeNameText SwaggerSecuritySchemeTypeOAuth2 = "oauth2"
620−instance Hashable SwaggerSecuritySchemeTypeName
622−data SwaggerSecurityScheme = SwaggerSecurityScheme
759+-- | merge scopes of two OAuth2 security schemes when their flows are identical.
623− { -- | The type of the security scheme.
760+-- In other case returns first security scheme
624− swaggerSecuritySchemeType :: SwaggerSecuritySchemeType
761+mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
762+mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
763+ s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
764+ = if flow1 == flow2 then
765+ SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
768+mergeSecurityScheme s1 _ = s1
626− -- | A short description for security scheme.
770+newtype SecurityDefinitions
627− , swaggerSecuritySchemeDescription :: Maybe Text
771+ = SecurityDefinitions (Definitions SecurityScheme)
628− } deriving (Show, Generic)
772+ deriving (Eq, Show, Generic, Data, Typeable)
630-- | Lists the required security schemes to execute this operation.
774-- | Lists the required security schemes to execute this operation.
631-- The object can have multiple security schemes declared in it which are all required
775-- The object can have multiple security schemes declared in it which are all required
632-- (that is, there is a logical AND between the schemes).
776-- (that is, there is a logical AND between the schemes).
633−newtype SwaggerSecurityRequirement = SwaggerSecurityRequirement
777+newtype SecurityRequirement = SecurityRequirement
634− { getSwaggerSecurityRequirement :: HashMap SwaggerSecuritySchemeTypeName Text
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
635− } deriving (Eq, Read, Show, Monoid)
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
637−instance ToJSON SwaggerSecurityRequirement where
781+-- | Tag name.
638− toJSON (SwaggerSecurityRequirement m) = toJSON (hashMapMapKeys swaggerSecuritySchemeTypeNameText m)
782+type TagName = Text
640−-- | Allows adding meta data to a single tag that is used by @SwaggerOperation@.
784+-- | Allows adding meta data to a single tag that is used by @Operation@.
641−-- It is not mandatory to have a @SwaggerTag@ per tag used there.
785+-- It is not mandatory to have a @Tag@ per tag used there.
642−data SwaggerTag = SwaggerTag
786+data Tag = Tag
643 { -- | The name of the tag.
787 { -- | The name of the tag.
644− swaggerTagName :: Text
788+ _tagName :: TagName
646 -- | A short description for the tag.
790 -- | A short description for the tag.
647 -- GFM syntax can be used for rich text representation.
791 -- GFM syntax can be used for rich text representation.
648− , swaggerTagDescription :: Maybe Text
792+ , _tagDescription :: Maybe Text
650 -- | Additional external documentation for this tag.
794 -- | Additional external documentation for this tag.
651− , swaggerTagExternalDocs :: Maybe SwaggerExternalDocs
795+ , _tagExternalDocs :: Maybe ExternalDocs
652− } deriving (Show)
796+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
798+instance Hashable Tag
800+instance IsString Tag where
801+ fromString s = Tag (fromString s) Nothing Nothing
654-- | Allows referencing an external resource for extended documentation.
803-- | Allows referencing an external resource for extended documentation.
655−data SwaggerExternalDocs = SwaggerExternalDocs
804+data ExternalDocs = ExternalDocs
656 { -- | A short description of the target documentation.
805 { -- | A short description of the target documentation.
657 -- GFM syntax can be used for rich text representation.
806 -- GFM syntax can be used for rich text representation.
658− swaggerExternalDocsDescription :: Maybe Text
807+ _externalDocsDescription :: Maybe Text
660 -- | The URL for the target documentation.
809 -- | The URL for the target documentation.
661− , swaggerExternalDocsUrl :: URL
810+ , _externalDocsUrl :: URL
662− } deriving (Show)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
813+instance Hashable ExternalDocs
815+-- | A simple object to allow referencing other definitions in the specification.
816+-- It can be used to reference parameters and responses that are defined at the top level for reuse.
817+newtype Reference = Reference { getReference :: Text }
818+ deriving (Eq, Show, Data, Typeable)
823+ deriving (Eq, Show, Functor, Data, Typeable)
825+instance IsString a => IsString (Referenced a) where
826+ fromString = Inline . fromString
664−newtype URL = URL { getUrl :: Text } deriving (Show, ToJSON, FromJSON)
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
666−deriveToJSON' ''SwaggerOperation
830+data AdditionalProperties
667−deriveToJSON (jsonPrefix "SwaggerParameter") ''SwaggerParameterLocation
831+ = AdditionalPropertiesAllowed Bool
668−deriveToJSON (jsonPrefix "SwaggerParam") ''SwaggerParameterType
832+ | AdditionalPropertiesSchema (Referenced Schema)
669−deriveToJSON' ''SwaggerPathItem
833+ deriving (Eq, Show, Data, Typeable)
670−deriveToJSON' ''SwaggerInfo
834+
671−deriveToJSON' ''SwaggerContact
835+-- =======================================================================
672−deriveToJSON' ''SwaggerLicense
836+-- Monoid instances
673−deriveToJSON (jsonPrefix "SwaggerSchema") ''SwaggerSchemaType
837+-- =======================================================================
674−deriveToJSON (jsonPrefix "SwaggerItems") ''SwaggerItemsType
838+
675−deriveToJSON (jsonPrefix "SwaggerItemsCollection") ''SwaggerItemsCollectionFormat
839+instance Semigroup Swagger where
676−deriveToJSON (jsonPrefix "SwaggerCollection") ''SwaggerCollectionFormat
840+ (<>) = genericMappend
677−deriveToJSON (jsonPrefix "SwaggerSecuritySchemeType") ''SwaggerSecuritySchemeTypeName
841+instance Monoid Swagger where
678−deriveToJSON (jsonPrefix "SwaggerApiKey") ''SwaggerApiKeyLocation
842+ mempty = genericMempty
679−deriveToJSON (jsonPrefix "swaggerApiKey") ''SwaggerApiKeyParams
843+ mappend = (<>)
680−deriveToJSON' ''SwaggerResponse
844+
681−deriveToJSON' ''SwaggerSchemaCommon
845+instance Semigroup Info where
682−deriveToJSONDefault ''SwaggerScheme
846+ (<>) = genericMappend
683−deriveToJSON' ''SwaggerTag
847+instance Monoid Info where
684−deriveToJSON' ''SwaggerExternalDocs
848+ mempty = genericMempty
685−deriveToJSON' ''SwaggerXml
849+ mappend = (<>)
851+instance Semigroup Contact where
852+ (<>) = genericMappend
853+instance Monoid Contact where
854+ mempty = genericMempty
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
859+instance Monoid PathItem where
860+ mempty = genericMempty
863+instance Semigroup Schema where
864+ (<>) = genericMappend
865+instance Monoid Schema where
866+ mempty = genericMempty
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
871+instance Monoid (ParamSchema t) where
872+ mempty = genericMempty
875+instance Semigroup Param where
876+ (<>) = genericMappend
877+instance Monoid Param where
878+ mempty = genericMempty
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
883+instance Monoid ParamOtherSchema where
884+ mempty = genericMempty
887+instance Semigroup Header where
888+ (<>) = genericMappend
889+instance Monoid Header where
890+ mempty = genericMempty
893+instance Semigroup Responses where
894+ (<>) = genericMappend
895+instance Monoid Responses where
896+ mempty = genericMempty
899+instance Semigroup Response where
900+ (<>) = genericMappend
901+instance Monoid Response where
902+ mempty = genericMempty
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
907+instance Monoid ExternalDocs where
908+ mempty = genericMempty
911+instance Semigroup Operation where
912+ (<>) = genericMappend
913+instance Monoid Operation where
914+ mempty = genericMempty
917+instance Semigroup Example where
918+ (<>) = genericMappend
919+instance Monoid Example where
920+ mempty = genericMempty
923+instance Semigroup SecurityScheme where
924+ (<>) = mergeSecurityScheme
926+instance Semigroup SecurityDefinitions where
927+ (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928+ SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
930+instance Monoid SecurityDefinitions where
931+ mempty = SecurityDefinitions $ InsOrdHashMap.empty
934+-- =======================================================================
935+-- SwaggerMonoid helper instances
936+-- =======================================================================
938+instance SwaggerMonoid Info
939+instance SwaggerMonoid PathItem
940+instance SwaggerMonoid Schema
941+instance SwaggerMonoid (ParamSchema t)
942+instance SwaggerMonoid Param
943+instance SwaggerMonoid ParamOtherSchema
944+instance SwaggerMonoid Responses
945+instance SwaggerMonoid Response
946+instance SwaggerMonoid ExternalDocs
947+instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
951+instance SwaggerMonoid MimeList
952+deriving instance SwaggerMonoid URL
954+instance SwaggerMonoid (SwaggerType t) where
955+ swaggerMempty = SwaggerString
956+ swaggerMappend _ y = y
958+instance SwaggerMonoid ParamLocation where
959+ swaggerMempty = ParamQuery
960+ swaggerMappend _ y = y
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963+ swaggerMempty = InsOrdHashMap.empty
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
966+instance Monoid a => SwaggerMonoid (Referenced a) where
967+ swaggerMempty = Inline mempty
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
969+ swaggerMappend _ y = y
971+instance SwaggerMonoid ParamAnySchema where
972+ swaggerMempty = ParamOther swaggerMempty
973+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975+ swaggerMappend _ y = y
977+-- =======================================================================
978+-- Simple Generic-based ToJSON instances
979+-- =======================================================================
981+instance ToJSON ParamLocation where
982+ toJSON = genericToJSON (jsonPrefix "Param")
984+instance ToJSON Info where
985+ toJSON = genericToJSON (jsonPrefix "Info")
987+instance ToJSON Contact where
988+ toJSON = genericToJSON (jsonPrefix "Contact")
990+instance ToJSON License where
991+ toJSON = genericToJSON (jsonPrefix "License")
993+instance ToJSON ApiKeyLocation where
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
996+instance ToJSON ApiKeyParams where
997+ toJSON = genericToJSON (jsonPrefix "apiKey")
999+instance ToJSON Scheme where
1000+ toJSON = genericToJSON (jsonPrefix "")
1002+instance ToJSON Tag where
1003+ toJSON = genericToJSON (jsonPrefix "Tag")
1005+instance ToJSON ExternalDocs where
1006+ toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1008+instance ToJSON Xml where
1009+ toJSON = genericToJSON (jsonPrefix "Xml")
1011+-- =======================================================================
1012+-- Simple Generic-based FromJSON instances
1013+-- =======================================================================
1015+instance FromJSON ParamLocation where
1016+ parseJSON = genericParseJSON (jsonPrefix "Param")
1018+instance FromJSON Info where
1019+ parseJSON = genericParseJSON (jsonPrefix "Info")
1021+instance FromJSON Contact where
1022+ parseJSON = genericParseJSON (jsonPrefix "Contact")
1024+instance FromJSON License where
1025+ parseJSON = genericParseJSON (jsonPrefix "License")
1027+instance FromJSON ApiKeyLocation where
1028+ parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1030+instance FromJSON ApiKeyParams where
1031+ parseJSON = genericParseJSON (jsonPrefix "apiKey")
1033+instance FromJSON Scheme where
1034+ parseJSON = genericParseJSON (jsonPrefix "")
1036+instance FromJSON Tag where
1037+ parseJSON = genericParseJSON (jsonPrefix "Tag")
1039+instance FromJSON ExternalDocs where
1040+ parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
1042+-- =======================================================================
1043+-- Manual ToJSON instances
1044+-- =======================================================================
687−instance ToJSON SwaggerOAuth2Flow where
1046+instance ToJSON OAuth2Flow where
688− toJSON (SwaggerOAuth2Implicit authUrl) = object
1047+ toJSON (OAuth2Implicit authUrl) = object
689 [ "flow" .= ("implicit" :: Text)
1048 [ "flow" .= ("implicit" :: Text)
690 , "authorizationUrl" .= authUrl ]
1049 , "authorizationUrl" .= authUrl ]
691− toJSON (SwaggerOAuth2Password tokenUrl) = object
1050+ toJSON (OAuth2Password tokenUrl) = object
692 [ "flow" .= ("password" :: Text)
1051 [ "flow" .= ("password" :: Text)
693 , "tokenUrl" .= tokenUrl ]
1052 , "tokenUrl" .= tokenUrl ]
694− toJSON (SwaggerOAuth2Application tokenUrl) = object
1053+ toJSON (OAuth2Application tokenUrl) = object
695 [ "flow" .= ("application" :: Text)
1054 [ "flow" .= ("application" :: Text)
696 , "tokenUrl" .= tokenUrl ]
1055 , "tokenUrl" .= tokenUrl ]
697− toJSON (SwaggerOAuth2AccessCode authUrl tokenUrl) = object
1056+ toJSON (OAuth2AccessCode authUrl tokenUrl) = object
698 [ "flow" .= ("accessCode" :: Text)
1057 [ "flow" .= ("accessCode" :: Text)
699 , "authorizationUrl" .= authUrl
1058 , "authorizationUrl" .= authUrl
700 , "tokenUrl" .= tokenUrl ]
1059 , "tokenUrl" .= tokenUrl ]
702−instance ToJSON SwaggerOAuth2Params where
1061+instance ToJSON OAuth2Params where
703− toJSON = genericToJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1062+ toJSON = sopSwaggerGenericToJSON
705−instance ToJSON SwaggerSecuritySchemeType where
1065+instance ToJSON SecuritySchemeType where
706− toJSON SwaggerSecuritySchemeBasic
1066+ toJSON SecuritySchemeBasic
707− = object [ "type" .= SwaggerSecuritySchemeTypeBasic ]
1067+ = object [ "type" .= ("basic" :: Text) ]
708− toJSON (SwaggerSecuritySchemeApiKey params)
1068+ toJSON (SecuritySchemeApiKey params)
709 = toJSON params
1069 = toJSON params
710− <+> object [ "type" .= SwaggerSecuritySchemeTypeApiKey ]
1070+ <+> object [ "type" .= ("apiKey" :: Text) ]
711− toJSON (SwaggerSecuritySchemeOAuth2 params)
1071+ toJSON (SecuritySchemeOAuth2 params)
712 = toJSON params
1072 = toJSON params
713− <+> object [ "type" .= SwaggerSecuritySchemeTypeOAuth2 ]
1073+ <+> object [ "type" .= ("oauth2" :: Text) ]
715instance ToJSON Swagger where
1075instance ToJSON Swagger where
716− toJSON = addVersion . genericToJSON (jsonPrefix "swagger")
1076+ toJSON = sopSwaggerGenericToJSON
717− where
1077+ DEFINE_TOENCODING
718− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
1078+
719− addVersion _ = error "impossible"
1079+instance ToJSON SecurityScheme where
720−
1080+ toJSON = sopSwaggerGenericToJSON
1083+instance ToJSON Schema where
1084+ toJSON = sopSwaggerGenericToJSON
721−instance ToJSON SwaggerSecurityScheme where
1087+instance ToJSON Header where
722− toJSON = genericToJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
1088+ toJSON = sopSwaggerGenericToJSON
723−
1089+ DEFINE_TOENCODING
724−instance ToJSON SwaggerSchema where
1090+
725− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerSchema")
1091+-- | As for nullary schema for 0-arity type constructors, see
726−
1092+-- <https://github.com/GetShopTV/swagger2/issues/167>.
727−instance ToJSON SwaggerHeader where
1093+--
728− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerHeader")
1094+-- >>> encode (SwaggerItemsArray [])
729−
1095+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
730−instance ToJSON SwaggerItems where
1097+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
731− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerItems")
1098+ toJSON (SwaggerItemsPrimitive fmt schema) = object
1099+ [ "collectionFormat" .= fmt
1100+ , "items" .= schema ]
1101+ toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1102+ toJSON (SwaggerItemsArray []) = object
1103+ [ "items" .= object []
1104+ , "maxItems" .= (0 :: Int)
1105+ , "example" .= Array mempty
1107+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1109+instance ToJSON Host where
1110+ toJSON (Host host mport) = toJSON $
1113+ Just port -> host ++ ":" ++ show port
1115+instance ToJSON MimeList where
1116+ toJSON (MimeList xs) = toJSON (map show xs)
1118+instance ToJSON Param where
1119+ toJSON = sopSwaggerGenericToJSON
1122+instance ToJSON ParamAnySchema where
1123+ toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124+ toJSON (ParamOther s) = toJSON s
1126+instance ToJSON ParamOtherSchema where
1127+ toJSON = sopSwaggerGenericToJSON
1130+instance ToJSON Responses where
1131+ toJSON = sopSwaggerGenericToJSON
1134+instance ToJSON Response where
1135+ toJSON = sopSwaggerGenericToJSON
1138+instance ToJSON Operation where
1139+ toJSON = sopSwaggerGenericToJSON
1142+instance ToJSON PathItem where
1143+ toJSON = sopSwaggerGenericToJSON
1146+instance ToJSON Example where
1147+ toJSON = toJSON . Map.mapKeys show . getExample
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
1152+instance ToJSON Reference where
1153+ toJSON (Reference ref) = object [ "$ref" .= ref ]
1155+referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
1156+referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
1157+referencedToJSON _ (Inline x) = toJSON x
1159+instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
1160+instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
1161+instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
1163+instance ToJSON (SwaggerType t) where
1164+ toJSON SwaggerArray = "array"
1165+ toJSON SwaggerString = "string"
1166+ toJSON SwaggerInteger = "integer"
1167+ toJSON SwaggerNumber = "number"
1168+ toJSON SwaggerBoolean = "boolean"
1169+ toJSON SwaggerFile = "file"
1170+ toJSON SwaggerNull = "null"
1171+ toJSON SwaggerObject = "object"
1173+instance ToJSON (CollectionFormat t) where
1174+ toJSON CollectionCSV = "csv"
1175+ toJSON CollectionSSV = "ssv"
1176+ toJSON CollectionTSV = "tsv"
1177+ toJSON CollectionPipes = "pipes"
1178+ toJSON CollectionMulti = "multi"
1180+instance ToJSON (ParamSchema k) where
1181+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1182+ toJSON = sopSwaggerGenericToJSONWithOpts $
1183+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1185+instance ToJSON AdditionalProperties where
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
1189+-- =======================================================================
1190+-- Manual FromJSON instances
1191+-- =======================================================================
1193+instance FromJSON OAuth2Flow where
1194+ parseJSON (Object o) = do
1195+ (flow :: Text) <- o .: "flow"
1197+ "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
1198+ "password" -> OAuth2Password <$> o .: "tokenUrl"
1199+ "application" -> OAuth2Application <$> o .: "tokenUrl"
1200+ "accessCode" -> OAuth2AccessCode
1201+ <$> o .: "authorizationUrl"
1202+ <*> o .: "tokenUrl"
1204+ parseJSON _ = empty
1206+instance FromJSON OAuth2Params where
1207+ parseJSON = sopSwaggerGenericParseJSON
1209+instance FromJSON SecuritySchemeType where
1210+ parseJSON js@(Object o) = do
1211+ (t :: Text) <- o .: "type"
1213+ "basic" -> pure SecuritySchemeBasic
1214+ "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1215+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
1217+ parseJSON _ = empty
1219+instance FromJSON Swagger where
1220+ parseJSON = sopSwaggerGenericParseJSON
1222+instance FromJSON SecurityScheme where
1223+ parseJSON = sopSwaggerGenericParseJSON
1225+instance FromJSON Schema where
1226+ parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1227+ where nullaryCleanup :: Schema -> Schema
1228+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230+ then s { _schemaExample = Nothing
1231+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1234+instance FromJSON Header where
1235+ parseJSON = sopSwaggerGenericParseJSON
1237+instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1238+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1239+ <$> o .:? "collectionFormat"
1240+ <*> (o .: "items" >>= parseJSON)
1242+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1243+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244+ <$> o .:? "collectionFormat"
1245+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1249+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250+-- Just (SwaggerItemsArray [])
1252+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1255+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1258+instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1259+ parseJSON js@(Object obj)
1260+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1261+ | otherwise = SwaggerItemsObject <$> parseJSON js
1262+ parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1263+ parseJSON _ = empty
1265+instance FromJSON Host where
1266+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1267+ [host] -> return $ Host host Nothing
1268+ [host, port] -> case readMaybe port of
1269+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1270+ Just p -> return $ Host host (Just (fromInteger p))
1271+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1272+ parseJSON _ = empty
1274+instance FromJSON MimeList where
1275+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
1277+instance FromJSON Param where
1278+ parseJSON = sopSwaggerGenericParseJSON
1280+instance FromJSON ParamAnySchema where
1281+ parseJSON js@(Object o) = do
1282+ (i :: Text) <- o .: "in"
1285+ schema <- o .: "schema"
1286+ ParamBody <$> parseJSON schema
1287+ _ -> ParamOther <$> parseJSON js
1288+ parseJSON _ = empty
1290+instance FromJSON ParamOtherSchema where
1291+ parseJSON = sopSwaggerGenericParseJSON
1293+instance FromJSON Responses where
1294+ parseJSON (Object o) = Responses
1295+ <$> o .:? "default"
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
1297+ parseJSON _ = empty
1299+instance FromJSON Example where
1302+ pure $ Example (Map.mapKeys fromString m)
1304+instance FromJSON Response where
1305+ parseJSON = sopSwaggerGenericParseJSON
1307+instance FromJSON Operation where
1308+ parseJSON = sopSwaggerGenericParseJSON
1310+instance FromJSON PathItem where
1311+ parseJSON = sopSwaggerGenericParseJSON
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
1316+instance FromJSON Reference where
1317+ parseJSON (Object o) = Reference <$> o .: "$ref"
1318+ parseJSON _ = empty
1320+referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
1321+referencedParseJSON prefix js@(Object o) = do
1324+ Nothing -> Inline <$> parseJSON js
1325+ Just s -> Ref <$> parseRef s
1328+ case Text.stripPrefix prefix s of
1329+ Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1330+ Just suffix -> pure (Reference suffix)
1331+referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
1333+instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1334+instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
1335+instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#/responses/"
1337+instance FromJSON Xml where
1338+ parseJSON = genericParseJSON (jsonPrefix "xml")
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1341+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1344+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1347+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1350+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1352+-- NOTE: There aren't collections of 'Schema'
1353+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1354+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1356+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1357+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1359+instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1360+ parseJSON = sopSwaggerGenericParseJSON
1361+instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1362+ parseJSON = sopSwaggerGenericParseJSON
1363+instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1364+ parseJSON = sopSwaggerGenericParseJSON
1366+instance FromJSON AdditionalProperties where
1367+ parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368+ parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1370+-------------------------------------------------------------------------------
1372+-------------------------------------------------------------------------------
1374+deriveGeneric ''Header
1375+deriveGeneric ''OAuth2Params
1376+deriveGeneric ''Operation
1377+deriveGeneric ''Param
1378+deriveGeneric ''ParamOtherSchema
1379+deriveGeneric ''PathItem
1380+deriveGeneric ''Response
1381+deriveGeneric ''Responses
1382+deriveGeneric ''SecurityScheme
1383+deriveGeneric ''Schema
1384+deriveGeneric ''ParamSchema
1385+deriveGeneric ''Swagger
1387+instance HasSwaggerAesonOptions Header where
1388+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1389+instance HasSwaggerAesonOptions OAuth2Params where
1390+ swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
1391+instance HasSwaggerAesonOptions Operation where
1392+ swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
1393+instance HasSwaggerAesonOptions Param where
1394+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1395+instance HasSwaggerAesonOptions ParamOtherSchema where
1396+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1397+instance HasSwaggerAesonOptions PathItem where
1398+ swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
1399+instance HasSwaggerAesonOptions Response where
1400+ swaggerAesonOptions _ = mkSwaggerAesonOptions "response"
1401+instance HasSwaggerAesonOptions Responses where
1402+ swaggerAesonOptions _ = mkSwaggerAesonOptions "responses" & saoSubObject ?~ "responses"
1403+instance HasSwaggerAesonOptions SecurityScheme where
1404+ swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1405+instance HasSwaggerAesonOptions Schema where
1406+ swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1407+instance HasSwaggerAesonOptions Swagger where
1408+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("swagger", "2.0")]
1410+instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1411+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1412+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1413+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1414+-- NOTE: Schema doesn't have 'items' sub object!
1415+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1416+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1418+instance AesonDefaultValue (ParamSchema s)
1419+instance AesonDefaultValue OAuth2Flow
1420+instance AesonDefaultValue Responses
1421+instance AesonDefaultValue ParamAnySchema
1422+instance AesonDefaultValue SecuritySchemeType
1423+instance AesonDefaultValue (SwaggerType a)
1424+instance AesonDefaultValue MimeList where defaultValue = Just mempty
1425+instance AesonDefaultValue Info
1426+instance AesonDefaultValue ParamLocation
1427+instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty