@@ -1,457 +1,636 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
15{-# LANGUAGE DeriveGeneric #-}
26{-# LANGUAGE DeriveTraversable #-}
7+{-# LANGUAGE FlexibleContexts #-}
38{-# LANGUAGE FlexibleInstances #-}
9+{-# LANGUAGE GADTs #-}
410{-# LANGUAGE GeneralizedNewtypeDeriving #-}
511{-# LANGUAGE OverloadedStrings #-}
612{-# LANGUAGE RecordWildCards #-}
713{-# LANGUAGE ScopedTypeVariables #-}
814{-# LANGUAGE StandaloneDeriving #-}
915{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
20+#endif
21+#include "overlapping-compat.h"
1022module Data.Swagger.Internal where
1123
24+import Prelude ()
25+import Prelude.Compat
26+
27+import Control.Lens ((&), (.~), (?~))
1228import Control.Applicative
13−import Control.Monad
1429import Data.Aeson
15−import Data.Aeson.TH (deriveJSON)
16−import Data.Foldable (Foldable)
17−import Data.HashMap.Strict (HashMap)
30+import qualified Data.Aeson.Types as JSON
31+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32+import Data.Hashable (Hashable)
1833import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
1935import Data.Map (Map)
2036import qualified Data.Map as Map
21−import Data.Monoid
22−import Data.String (fromString)
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
39+import Data.Scientific (Scientific)
40+import Data.String (IsString(..))
2341import Data.Text (Text)
2442import qualified Data.Text as Text
25−import Data.Traversable (Traversable)
26−import Data.Hashable (Hashable)
2743import GHC.Generics (Generic)
28−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
2945import Network.HTTP.Media (MediaType)
3046import Text.Read (readMaybe)
3147
48+import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50+
51+import Generics.SOP.TH (deriveGeneric)
52+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53+ ,sopSwaggerGenericToJSONWithOpts
54+ ,sopSwaggerGenericParseJSON
55+ ,HasSwaggerAesonOptions(..)
56+ ,AesonDefaultValue(..)
57+ ,mkSwaggerAesonOptions
58+ ,saoAdditionalPairs
59+ ,saoSubObject)
3260import Data.Swagger.Internal.Utils
3361
62+#if MIN_VERSION_aeson(0,10,0)
63+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64+#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
65+#else
66+#define DEFINE_TOENCODING
67+#endif
68+
69+-- $setup
70+-- >>> :seti -XDataKinds
71+-- >>> import Data.Aeson
72+
73+-- | A list of definitions that can be used in references.
74+type Definitions = InsOrdHashMap Text
75+
3476-- | This is the root document object for the API specification.
3577data Swagger = Swagger
3678 { -- | Provides metadata about the API.
3779 -- The metadata can be used by the clients if needed.
38− swaggerInfo :: SwaggerInfo
80+ _swaggerInfo :: Info
3981
4082 -- | The host (name or ip) serving the API. It MAY include a port.
4183 -- If the host is not included, the host serving the documentation is to be used (including the port).
42− , swaggerHost :: Maybe SwaggerHost
84+ , _swaggerHost :: Maybe Host
4385
4486 -- | The base path on which the API is served, which is relative to the host.
4587 -- If it is not included, the API is served directly under the host.
4688 -- The value MUST start with a leading slash (/).
47− , swaggerBasePath :: Maybe FilePath
89+ , _swaggerBasePath :: Maybe FilePath
4890
4991 -- | The transfer protocol of the API.
5092 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
51− , swaggerSchemes :: Maybe [SwaggerScheme]
93+ , _swaggerSchemes :: Maybe [Scheme]
5294
5395 -- | A list of MIME types the APIs can consume.
5496 -- This is global to all APIs but can be overridden on specific API calls.
55− , swaggerConsumes :: SwaggerMimeList
97+ , _swaggerConsumes :: MimeList
5698
5799 -- | A list of MIME types the APIs can produce.
58− -- This is global to all APIs but can be overridden on specific API calls.
59− , swaggerProduces :: SwaggerMimeList
100+ -- This is global to all APIs but can be overridden on specific API calls.
101+ , _swaggerProduces :: MimeList
60102
61103 -- | The available paths and operations for the API.
62− , 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
63107
64108 -- | An object to hold data types produced and consumed by operations.
65− , swaggerDefinitions :: HashMap Text SwaggerSchema
109+ , _swaggerDefinitions :: Definitions Schema
66110
67111 -- | An object to hold parameters that can be used across operations.
68112 -- This property does not define global parameters for all operations.
69− , swaggerParameters :: HashMap Text SwaggerParameter
113+ , _swaggerParameters :: Definitions Param
70114
71115 -- | An object to hold responses that can be used across operations.
72116 -- This property does not define global responses for all operations.
73− , swaggerResponses :: HashMap Text SwaggerResponse
117+ , _swaggerResponses :: Definitions Response
74118
75119 -- | Security scheme definitions that can be used across the specification.
76− , swaggerSecurityDefinitions :: HashMap Text SwaggerSecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
77121
78122 -- | A declaration of which security schemes are applied for the API as a whole.
79123 -- The list of values describes alternative security schemes that can be used
80124 -- (that is, there is a logical OR between the security requirements).
81125 -- Individual operations can override this definition.
82− , swaggerSecurity :: [SwaggerSecurityRequirement]
126+ , _swaggerSecurity :: [SecurityRequirement]
83127
84128 -- | A list of tags used by the specification with additional metadata.
85129 -- The order of the tags can be used to reflect on their order by the parsing tools.
86130 -- Not all tags that are used by the Operation Object must be declared.
87131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
88132 -- Each tag name in the list MUST be unique.
89− , swaggerTags :: [SwaggerTag]
133+ , _swaggerTags :: InsOrdHashSet Tag
90134
91135 -- | Additional external documentation.
92− , swaggerExternalDocs :: Maybe SwaggerExternalDocs
93− } deriving (Eq, Show, Generic)
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
137+ } deriving (Eq, Show, Generic, Data, Typeable)
94138
95139-- | The object provides metadata about the API.
96140-- The metadata can be used by the clients if needed,
97141-- and can be presented in the Swagger-UI for convenience.
98−data SwaggerInfo = SwaggerInfo
142+data Info = Info
99143 { -- | The title of the application.
100− swaggerInfoTitle :: Text
144+ _infoTitle :: Text
101145
102146 -- | A short description of the application.
103147 -- GFM syntax can be used for rich text representation.
104− , swaggerInfoDescription :: Maybe Text
148+ , _infoDescription :: Maybe Text
105149
106150 -- | The Terms of Service for the API.
107− , swaggerInfoTermsOfService :: Maybe Text
151+ , _infoTermsOfService :: Maybe Text
108152
109153 -- | The contact information for the exposed API.
110− , swaggerInfoContact :: Maybe SwaggerContact
154+ , _infoContact :: Maybe Contact
111155
112156 -- | The license information for the exposed API.
113− , swaggerInfoLicense :: Maybe SwaggerLicense
157+ , _infoLicense :: Maybe License
114158
115159 -- | Provides the version of the application API
116160 -- (not to be confused with the specification version).
117− , swaggerInfoVersion :: Text
118− } deriving (Eq, Show, Generic)
161+ , _infoVersion :: Text
162+ } deriving (Eq, Show, Generic, Data, Typeable)
119163
120164-- | Contact information for the exposed API.
121−data SwaggerContact = SwaggerContact
165+data Contact = Contact
122166 { -- | The identifying name of the contact person/organization.
123− swaggerContactName :: Maybe Text
167+ _contactName :: Maybe Text
124168
125169 -- | The URL pointing to the contact information.
126− , swaggerContactUrl :: Maybe URL
170+ , _contactUrl :: Maybe URL
127171
128172 -- | The email address of the contact person/organization.
129− , swaggerContactEmail :: Maybe Text
130− } deriving (Eq, Show)
173+ , _contactEmail :: Maybe Text
174+ } deriving (Eq, Show, Generic, Data, Typeable)
131175
132176-- | License information for the exposed API.
133−data SwaggerLicense = SwaggerLicense
177+data License = License
134178 { -- | The license name used for the API.
135− swaggerLicenseName :: Text
179+ _licenseName :: Text
136180
137181 -- | A URL to the license used for the API.
138− , swaggerLicenseUrl :: Maybe URL
139− } deriving (Eq, Show)
182+ , _licenseUrl :: Maybe URL
183+ } deriving (Eq, Show, Generic, Data, Typeable)
184+
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
140187
141188-- | The host (name or ip) serving the API. It MAY include a port.
142−data SwaggerHost = SwaggerHost
143− { swaggerHostName :: HostName -- ^ Host name.
144− , swaggerHostPort :: Maybe PortNumber -- ^ Optional port.
145− } deriving (Eq, Show)
189+data Host = Host
190+ { _hostName :: HostName -- ^ Host name.
191+ , _hostPort :: Maybe PortNumber -- ^ Optional port.
192+ } deriving (Eq, Show, Generic, Typeable)
193+
194+instance IsString Host where
195+ fromString s = Host s Nothing
196+
197+hostConstr :: Constr
198+hostConstr = mkConstr hostDataType "Host" [] Prefix
199+
200+hostDataType :: DataType
201+hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
202+
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
146209
147210-- | The transfer protocol of the API.
148−data SwaggerScheme
211+data Scheme
149212 = Http
150213 | Https
151214 | Ws
152215 | Wss
153− deriving (Eq, Show)
154−
155−-- | The available paths and operations for the API.
156−data SwaggerPaths = SwaggerPaths
157− { -- | Holds the relative paths to the individual endpoints.
158− -- The path is appended to the @'swaggerBasePath'@ in order to construct the full URL.
159− swaggerPathsMap :: HashMap FilePath SwaggerPathItem
160− } deriving (Eq, Show, Generic)
216+ deriving (Eq, Show, Generic, Data, Typeable)
161217
162218-- | Describes the operations available on a single path.
163−-- A @'SwaggerPathItem'@ may be empty, due to ACL constraints.
219+-- A @'PathItem'@ may be empty, due to ACL constraints.
164220-- The path itself is still exposed to the documentation viewer
165221-- but they will not know which operations and parameters are available.
166−data SwaggerPathItem = SwaggerPathItem
222+data PathItem = PathItem
167223 { -- | A definition of a GET operation on this path.
168− swaggerPathItemGet :: Maybe SwaggerOperation
224+ _pathItemGet :: Maybe Operation
169225
170226 -- | A definition of a PUT operation on this path.
171− , swaggerPathItemPut :: Maybe SwaggerOperation
227+ , _pathItemPut :: Maybe Operation
172228
173229 -- | A definition of a POST operation on this path.
174− , swaggerPathItemPost :: Maybe SwaggerOperation
230+ , _pathItemPost :: Maybe Operation
175231
176232 -- | A definition of a DELETE operation on this path.
177− , swaggerPathItemDelete :: Maybe SwaggerOperation
233+ , _pathItemDelete :: Maybe Operation
178234
179235 -- | A definition of a OPTIONS operation on this path.
180− , swaggerPathItemOptions :: Maybe SwaggerOperation
236+ , _pathItemOptions :: Maybe Operation
181237
182238 -- | A definition of a HEAD operation on this path.
183− , swaggerPathItemHead :: Maybe SwaggerOperation
239+ , _pathItemHead :: Maybe Operation
184240
185241 -- | A definition of a PATCH operation on this path.
186− , swaggerPathItemPatch :: Maybe SwaggerOperation
242+ , _pathItemPatch :: Maybe Operation
187243
188244 -- | A list of parameters that are applicable for all the operations described under this path.
189245 -- These parameters can be overridden at the operation level, but cannot be removed there.
190246 -- The list MUST NOT include duplicated parameters.
191247 -- A unique parameter is defined by a combination of a name and location.
192− , swaggerPathItemParameters :: [SwaggerParameter]
193− } deriving (Eq, Show, Generic)
248+ , _pathItemParameters :: [Referenced Param]
249+ } deriving (Eq, Show, Generic, Data, Typeable)
194250
195251-- | Describes a single API operation on a path.
196−data SwaggerOperation = SwaggerOperation
252+data Operation = Operation
197253 { -- | A list of tags for API documentation control.
198254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
199− swaggerOperationTags :: [Text]
255+ _operationTags :: InsOrdHashSet TagName
200256
201257 -- | A short summary of what the operation does.
202258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
203− , swaggerOperationSummary :: Maybe Text
259+ , _operationSummary :: Maybe Text
204260
205261 -- | A verbose explanation of the operation behavior.
206262 -- GFM syntax can be used for rich text representation.
207− , swaggerOperationDescription :: Maybe Text
263+ , _operationDescription :: Maybe Text
208264
209265 -- | Additional external documentation for this operation.
210− , swaggerOperationExternalDocs :: Maybe SwaggerExternalDocs
266+ , _operationExternalDocs :: Maybe ExternalDocs
211267
212268 -- | Unique string used to identify the operation.
213269 -- The id MUST be unique among all operations described in the API.
214270 -- Tools and libraries MAY use the it to uniquely identify an operation,
215271 -- therefore, it is recommended to follow common programming naming conventions.
216− , swaggerOperationOperationId :: Maybe Text
272+ , _operationOperationId :: Maybe Text
217273
218274 -- | A list of MIME types the operation can consume.
219− -- This overrides the @'swaggerConsumes'@.
275+ -- This overrides the @'consumes'@.
220276 -- @Just []@ MAY be used to clear the global definition.
221− , swaggerOperationConsumes :: Maybe SwaggerMimeList
277+ , _operationConsumes :: Maybe MimeList
222278
223279 -- | A list of MIME types the operation can produce.
224− -- This overrides the @'swaggerProduces'@.
280+ -- This overrides the @'produces'@.
225281 -- @Just []@ MAY be used to clear the global definition.
226− , swaggerOperationProduces :: Maybe SwaggerMimeList
282+ , _operationProduces :: Maybe MimeList
227283
228284 -- | A list of parameters that are applicable for this operation.
229− -- If a parameter is already defined at the @'SwaggerPathItem'@,
285+ -- If a parameter is already defined at the @'PathItem'@,
230286 -- the new definition will override it, but can never remove it.
231287 -- The list MUST NOT include duplicated parameters.
232288 -- A unique parameter is defined by a combination of a name and location.
233− , swaggerOperationParameters :: [SwaggerParameter]
289+ , _operationParameters :: [Referenced Param]
234290
235291 -- | The list of possible responses as they are returned from executing this operation.
236− , swaggerOperationResponses :: SwaggerResponses
292+ , _operationResponses :: Responses
237293
238294 -- | The transfer protocol for the operation.
239− -- The value overrides @'swaggerSchemes'@.
240− , swaggerOperationSchemes :: Maybe [SwaggerScheme]
295+ -- The value overrides @'schemes'@.
296+ , _operationSchemes :: Maybe [Scheme]
241297
242298 -- | Declares this operation to be deprecated.
243299 -- Usage of the declared operation should be refrained.
244300 -- Default value is @False@.
245− , swaggerOperationDeprecated :: Bool
301+ , _operationDeprecated :: Maybe Bool
246302
247303 -- | A declaration of which security schemes are applied for this operation.
248304 -- The list of values describes alternative security schemes that can be used
249305 -- (that is, there is a logical OR between the security requirements).
250306 -- This definition overrides any declared top-level security.
251307 -- To remove a top-level security declaration, @Just []@ can be used.
252− , swaggerOperationSecurity :: [SwaggerSecurityRequirement]
253− } deriving (Eq, Show, Generic)
308+ , _operationSecurity :: [SecurityRequirement]
309+ } deriving (Eq, Show, Generic, Data, Typeable)
310+
311+newtype MimeList = MimeList { getMimeList :: [MediaType] }
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
254313
255−newtype SwaggerMimeList = SwaggerMimeList { getSwaggerMimeList :: [MediaType] }
256− deriving (Eq, Show, Monoid)
314+mimeListConstr :: Constr
315+mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
316+
317+mimeListDataType :: DataType
318+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
319+
320+instance Data MimeList where
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
257326
258327-- | Describes a single operation parameter.
259328-- A unique parameter is defined by a combination of a name and location.
260−data SwaggerParameter = SwaggerParameter
329+data Param = Param
261330 { -- | The name of the parameter.
262331 -- Parameter names are case sensitive.
263− swaggerParameterName :: Text
332+ _paramName :: Text
264333
265334 -- | A brief description of the parameter.
266335 -- This could contain examples of use.
267336 -- GFM syntax can be used for rich text representation.
268− , swaggerParameterDescription :: Maybe Text
337+ , _paramDescription :: Maybe Text
269338
270339 -- | Determines whether this parameter is mandatory.
271340 -- If the parameter is in "path", this property is required and its value MUST be true.
272341 -- Otherwise, the property MAY be included and its default value is @False@.
273− , swaggerParameterRequired :: Bool
342+ , _paramRequired :: Maybe Bool
274343
275344 -- | Parameter schema.
276− , swaggerParameterSchema :: SwaggerParameterSchema
277− } deriving (Eq, Show, Generic)
345+ , _paramSchema :: ParamAnySchema
346+ } deriving (Eq, Show, Generic, Data, Typeable)
278347
279−data SwaggerParameterSchema
280− = SwaggerParameterBody SwaggerSchema
281− | SwaggerParameterOther SwaggerParameterOtherSchema
282− deriving (Eq, Show)
348+data ParamAnySchema
349+ = ParamBody (Referenced Schema)
350+ | ParamOther ParamOtherSchema
351+ deriving (Eq, Show, Generic, Data, Typeable)
283352
284−data SwaggerParameterOtherSchema = SwaggerParameterOtherSchema
353+data ParamOtherSchema = ParamOtherSchema
285354 { -- | The location of the parameter.
286− swaggerParameterOtherSchemaIn :: SwaggerParameterLocation
287−
288− -- | The type of the parameter.
289− -- Since the parameter is not located at the request body,
290− -- it is limited to simple types (that is, not an object).
291− -- If type is @'SwaggerParamFile'@, the @consumes@ MUST be either
292− -- "multipart/form-data" or " application/x-www-form-urlencoded"
293− -- and the parameter MUST be in @'SwaggerParameterFormData'@.
294− , swaggerParameterOtherSchemaType :: SwaggerParameterType
295−
296− -- | The extending format for the previously mentioned type.
297− , swaggerParameterOtherSchemaFormat :: Maybe SwaggerFormat
355+ _paramOtherSchemaIn :: ParamLocation
298356
299357 -- | Sets the ability to pass empty-valued parameters.
300− -- This is valid only for either @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@
358+ -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
301359 -- and allows you to send a parameter with a name only or an empty value.
302360 -- Default value is @False@.
303− , swaggerParameterOtherSchemaAllowEmptyValue :: Bool
304−
305− -- | __Required if type is @'SwaggerParamArray'@__.
306− -- Describes the type of items in the array.
307− , swaggerParameterOtherSchemaItems :: Maybe SwaggerItems
308−
309− -- | Determines the format of the array if @'SwaggerParamArray'@ is used.
310− -- Default value is csv.
311− , swaggerParameterOtherSchemaCollectionFormat :: Maybe SwaggerCollectionFormat
312−
313− , swaggerParameterOtherSchemaCommon :: SwaggerSchemaCommon
314− } deriving (Eq, Show, Generic)
315−
316−data SwaggerParameterType
317− = SwaggerParamString
318− | SwaggerParamNumber
319− | SwaggerParamInteger
320− | SwaggerParamBoolean
321− | SwaggerParamArray
322− | SwaggerParamFile
323− deriving (Eq, Show)
324−
325−data SwaggerParameterLocation
361+ , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362+
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
364+ } deriving (Eq, Show, Generic, Typeable, Data)
365+
366+-- | Items for @'SwaggerArray'@ schemas.
367+--
368+-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
369+-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
370+-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
371+-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
372+--
373+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
374+--
375+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
376+data SwaggerItems t where
377+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
378+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
379+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
380+ deriving (Typeable)
381+
382+deriving instance Eq (SwaggerItems t)
383+deriving instance Show (SwaggerItems t)
384+--deriving instance Typeable (SwaggerItems t)
385+
386+swaggerItemsPrimitiveConstr :: Constr
387+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388+
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391+
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394+
395+swaggerItemsDataType :: DataType
396+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397+
398+-- Note: unfortunately we have to write these Data instances by hand,
399+-- to get better contexts / avoid duplicate name when using standalone deriving
400+
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
408+
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
417+
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
422+
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)."
427+
428+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
431+
432+ dataTypeOf _ = swaggerItemsDataType
433+
434+-- | Type used as a kind to avoid overlapping instances.
435+data SwaggerKind t
436+ = SwaggerKindNormal t
437+ | SwaggerKindParamOtherSchema
438+ | SwaggerKindSchema
439+ deriving (Typeable)
440+
441+deriving instance Typeable 'SwaggerKindNormal
442+deriving instance Typeable 'SwaggerKindParamOtherSchema
443+deriving instance Typeable 'SwaggerKindSchema
444+
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
449+
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
459+ deriving (Typeable)
460+
461+deriving instance Eq (SwaggerType t)
462+deriving instance Show (SwaggerType t)
463+
464+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466+
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
469+
470+swaggerCommonTypes :: [SwaggerType k]
471+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472+
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475+
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
478+
479+swaggerTypeConstrs :: [Constr]
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
482+
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485+ toConstr = swaggerTypeConstr
486+ dataTypeOf = swaggerTypeDataType
487+
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490+ toConstr = swaggerTypeConstr
491+ dataTypeOf = swaggerTypeDataType
492+
493+instance Data (SwaggerType 'SwaggerKindSchema) where
494+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495+ toConstr = swaggerTypeConstr
496+ dataTypeOf = swaggerTypeDataType
497+
498+data ParamLocation
326499 = -- | Parameters that are appended to the URL.
327500 -- For example, in @/items?id=###@, the query parameter is @id@.
328− SwaggerParameterQuery
501+ ParamQuery
329502 -- | Custom headers that are expected as part of the request.
330− | SwaggerParameterHeader
503+ | ParamHeader
331504 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
332505 -- This does not include the host or base path of the API.
333506 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
334− | SwaggerParameterPath
507+ | ParamPath
335508 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
336509 -- or @multipart/form-data@ are used as the content type of the request
337510 -- (in Swagger's definition, the @consumes@ property of an operation).
338− -- 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.
339512 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
340513 -- Form parameters have a different format based on the content-type used
341514 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
342− | SwaggerParameterFormData
343− deriving (Eq, Show)
515+ | ParamFormData
516+ deriving (Eq, Show, Generic, Data, Typeable)
344517
345−type SwaggerFormat = Text
518+type Format = Text
346519
347520-- | Determines the format of the array.
348−data SwaggerCollectionFormat
349− = SwaggerCollectionCSV -- ^ Comma separated values: @foo,bar@.
350− | SwaggerCollectionSSV -- ^ Space separated values: @foo bar@.
351− | SwaggerCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
352− | SwaggerCollectionPipes -- ^ Pipe separated values: @foo|bar@.
353− | SwaggerCollectionMulti -- ^ Corresponds to multiple parameter instances
354− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
355− -- This is valid only for parameters in @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@.
356− deriving (Eq, Show)
357−
358−data SwaggerItemsType
359− = SwaggerItemsString
360− | SwaggerItemsNumber
361− | SwaggerItemsInteger
362− | SwaggerItemsBoolean
363− | SwaggerItemsArray
364− deriving (Eq, Show)
365−
366−data SwaggerSchemaType
367− = SwaggerSchemaArray
368− | SwaggerSchemaBoolean
369− | SwaggerSchemaInteger
370− | SwaggerSchemaNumber
371− | SwaggerSchemaNull
372− | SwaggerSchemaObject
373− | SwaggerSchemaString
374− deriving (Eq, Show)
375−
376−-- | Determines the format of the nested array.
377−data SwaggerItemsCollectionFormat
378− = SwaggerItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
379− | SwaggerItemsCollectionSSV -- ^ Space separated values: @foo bar@.
380− | SwaggerItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
381− | SwaggerItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
382− deriving (Eq, Show)
383−
384−type SwaggerParamName = Text
385−
386−data SwaggerSchema = SwaggerSchema
387− { swaggerSchemaType :: SwaggerSchemaType
388− , swaggerSchemaFormat :: Maybe SwaggerFormat
389− , swaggerSchemaTitle :: Maybe Text
390− , swaggerSchemaDescription :: Maybe Text
391− , swaggerSchemaRequired :: [SwaggerParamName]
392−
393− , swaggerSchemaItems :: Maybe SwaggerSchemaItems
394− , swaggerSchemaAllOf :: Maybe [SwaggerSchema]
395− , swaggerSchemaProperties :: HashMap Text SwaggerSchema
396− , swaggerSchemaAdditionalProperties :: Maybe SwaggerSchema
397−
398− , swaggerSchemaDiscriminator :: Maybe Text
399− , swaggerSchemaReadOnly :: Maybe Bool
400− , swaggerSchemaXml :: Maybe SwaggerXml
401− , swaggerSchemaExternalDocs :: Maybe SwaggerExternalDocs
402− , swaggerSchemaExample :: Maybe Value
403−
404− , swaggerSchemaMaxProperties :: Maybe Integer
405− , swaggerSchemaMinProperties :: Maybe Integer
406−
407− , swaggerSchemaCommon :: SwaggerSchemaCommon
408− } deriving (Eq, Show, Generic)
409−
410−data SwaggerSchemaItems
411− = SwaggerSchemaItemsObject SwaggerSchema
412− | SwaggerSchemaItemsArray [SwaggerSchema]
413− deriving (Eq, Show)
414−
415−data SwaggerSchemaCommon = SwaggerSchemaCommon
521+data CollectionFormat t where
522+ -- Comma separated values: @foo,bar@.
523+ CollectionCSV :: CollectionFormat t
524+ -- Space separated values: @foo bar@.
525+ CollectionSSV :: CollectionFormat t
526+ -- Tab separated values: @foo\\tbar@.
527+ CollectionTSV :: CollectionFormat t
528+ -- Pipe separated values: @foo|bar@.
529+ CollectionPipes :: CollectionFormat t
530+ -- Corresponds to multiple parameter instances
531+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534+ deriving (Typeable)
535+
536+deriving instance Eq (CollectionFormat t)
537+deriving instance Show (CollectionFormat t)
538+
539+collectionFormatConstr :: CollectionFormat t -> Constr
540+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
541+
542+collectionFormatDataType :: DataType
543+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
544+ map collectionFormatConstr collectionCommonFormats
545+
546+collectionCommonFormats :: [CollectionFormat t]
547+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548+
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551+ toConstr = collectionFormatConstr
552+ dataTypeOf _ = collectionFormatDataType
553+
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
555+
556+type ParamName = Text
557+
558+data Schema = Schema
559+ { _schemaTitle :: Maybe Text
560+ , _schemaDescription :: Maybe Text
561+ , _schemaRequired :: [ParamName]
562+
563+ , _schemaAllOf :: Maybe [Referenced Schema]
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
566+
567+ , _schemaDiscriminator :: Maybe Text
568+ , _schemaReadOnly :: Maybe Bool
569+ , _schemaXml :: Maybe Xml
570+ , _schemaExternalDocs :: Maybe ExternalDocs
571+ , _schemaExample :: Maybe Value
572+
573+ , _schemaMaxProperties :: Maybe Integer
574+ , _schemaMinProperties :: Maybe Integer
575+
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
577+ } deriving (Eq, Show, Generic, Data, Typeable)
578+
579+-- | A @'Schema'@ with an optional name.
580+-- This name can be used in references.
581+data NamedSchema = NamedSchema
582+ { _namedSchemaName :: Maybe Text
583+ , _namedSchemaSchema :: Schema
584+ } deriving (Eq, Show, Generic, Data, Typeable)
585+
586+-- | Regex pattern for @string@ type.
587+type Pattern = Text
588+
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
416590 { -- | Declares the value of the parameter that the server will use if none is provided,
417591 -- for example a @"count"@ to control the number of results per page might default to @100@
418592 -- if not supplied by the client in the request.
419593 -- (Note: "default" has no meaning for required parameters.)
420594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
421− swaggerSchemaDefault :: Maybe Value
422−
423− , swaggerSchemaMaximum :: Maybe Integer
424− , swaggerSchemaExclusiveMaximum :: Maybe Bool
425− , swaggerSchemaMinimum :: Maybe Integer
426− , swaggerSchemaExclusiveMinimum :: Maybe Bool
427− , swaggerSchemaMaxLength :: Maybe Integer
428− , swaggerSchemaMinLength :: Maybe Integer
429− , swaggerSchemaPattern :: Maybe Text
430− , swaggerSchemaMaxItems :: Maybe Integer
431− , swaggerSchemaMinItems :: Maybe Integer
432− , swaggerSchemaUniqueItems :: Maybe Bool
433− , swaggerSchemaEnum :: Maybe [Value]
434− , swaggerSchemaMultipleOf :: Maybe Integer
435− } deriving (Eq, Show, Generic)
436−
437−data SwaggerXml = SwaggerXml
595+ _paramSchemaDefault :: Maybe Value
596+
597+ , _paramSchemaType :: Maybe (SwaggerType t)
598+ , _paramSchemaFormat :: Maybe Format
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
600+ , _paramSchemaMaximum :: Maybe Scientific
601+ , _paramSchemaExclusiveMaximum :: Maybe Bool
602+ , _paramSchemaMinimum :: Maybe Scientific
603+ , _paramSchemaExclusiveMinimum :: Maybe Bool
604+ , _paramSchemaMaxLength :: Maybe Integer
605+ , _paramSchemaMinLength :: Maybe Integer
606+ , _paramSchemaPattern :: Maybe Pattern
607+ , _paramSchemaMaxItems :: Maybe Integer
608+ , _paramSchemaMinItems :: Maybe Integer
609+ , _paramSchemaUniqueItems :: Maybe Bool
610+ , _paramSchemaEnum :: Maybe [Value]
611+ , _paramSchemaMultipleOf :: Maybe Scientific
612+ } deriving (Eq, Show, Generic, Typeable)
613+
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
615+
616+data Xml = Xml
438617 { -- | Replaces the name of the element/attribute used for the described schema property.
439618 -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
440619 -- When defined alongside type being array (outside the items),
441620 -- it will affect the wrapping element and only if wrapped is true.
442621 -- If wrapped is false, it will be ignored.
443− swaggerXmlName :: Maybe Text
622+ _xmlName :: Maybe Text
444623
445624 -- | The URL of the namespace definition.
446625 -- Value SHOULD be in the form of a URL.
447− , swaggerXmlNamespace :: Maybe Text
626+ , _xmlNamespace :: Maybe Text
448627
449628 -- | The prefix to be used for the name.
450− , swaggerXmlPrefix :: Maybe Text
629+ , _xmlPrefix :: Maybe Text
451630
452631 -- | Declares whether the property definition translates to an attribute instead of an element.
453632 -- Default value is @False@.
454− , swaggerXmlAttribute :: Bool
633+ , _xmlAttribute :: Maybe Bool
455634
456635 -- | MAY be used only for an array definition.
457636 -- Signifies whether the array is wrapped
@@ -459,103 +638,87 @@ data SwaggerXml = SwaggerXml
459638 -- or unwrapped (@\<book/\>\<book/\>@).
460639 -- Default value is @False@.
461640 -- The definition takes effect only when defined alongside type being array (outside the items).
462− , swaggerXmlWrapped :: Bool
463− } deriving (Eq, Show)
464−
465−data SwaggerItems = SwaggerItems
466− { -- | The internal type of the array.
467− swaggerItemsType :: SwaggerItemsType
468−
469− -- | The extending format for the previously mentioned type.
470− , swaggerItemsFormat :: SwaggerFormat
471−
472− -- | __Required if type is @'SwaggerItemsArray'@.__
473− -- Describes the type of items in the array.
474− , swaggerItemsItems :: SwaggerItems
475−
476− -- | Determines the format of the array if type array is used.
477− -- Default value is @'SwaggerItemsCollectionCSV'@.
478− , swaggerItemsCollectionFormat :: SwaggerItemsCollectionFormat
479−
480− , swaggerItemsCommon :: SwaggerSchemaCommon
481− } deriving (Eq, Show, Generic)
641+ , _xmlWrapped :: Maybe Bool
642+ } deriving (Eq, Show, Generic, Data, Typeable)
482643
483644-- | A container for the expected responses of an operation.
484645-- The container maps a HTTP response code to the expected response.
485646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
486647-- since they may not be known in advance.
487648-- However, it is expected from the documentation to cover a successful operation response and any known errors.
488−data SwaggerResponses = SwaggerResponses
649+data Responses = Responses
489650 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
490651 -- It can be used to cover undeclared responses.
491− swaggerResponsesDefault :: Maybe SwaggerResponse
652+ _responsesDefault :: Maybe (Referenced Response)
492653
493654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
494655 -- Describes the expected response for those HTTP status codes.
495− , swaggerResponsesResponses :: HashMap HttpStatusCode SwaggerResponse
496− } deriving (Eq, Show, Generic)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
657+ } deriving (Eq, Show, Generic, Data, Typeable)
497658
498659type HttpStatusCode = Int
499660
500661-- | Describes a single response from an API Operation.
501−data SwaggerResponse = SwaggerResponse
662+data Response = Response
502663 { -- | A short description of the response.
503664 -- GFM syntax can be used for rich text representation.
504− swaggerResponseDescription :: Text
665+ _responseDescription :: Text
505666
506667 -- | A definition of the response structure.
507668 -- It can be a primitive, an array or an object.
508669 -- If this field does not exist, it means no content is returned as part of the response.
509670 -- As an extension to the Schema Object, its root type value may also be "file".
510671 -- This SHOULD be accompanied by a relevant produces mime-type.
511− , swaggerResponseSchema :: Maybe SwaggerSchema
672+ , _responseSchema :: Maybe (Referenced Schema)
512673
513674 -- | A list of headers that are sent with the response.
514− , swaggerResponseHeaders :: HashMap HeaderName SwaggerHeader
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
515676
516677 -- | An example of the response message.
517− , swaggerResponseExamples :: Maybe SwaggerExample
518− } deriving (Eq, Show, Generic)
678+ , _responseExamples :: Maybe Example
679+ } deriving (Eq, Show, Generic, Data, Typeable)
680+
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
519683
520684type HeaderName = Text
521685
522−data SwaggerHeader = SwaggerHeader
686+data Header = Header
523687 { -- | A short description of the header.
524− swaggerHeaderDescription :: Maybe String
525−
526− -- | The type of the object.
527− , swaggerHeaderType :: SwaggerItemsType
688+ _headerDescription :: Maybe Text
528689
529− -- | The extending format for the previously mentioned type. See Data Type Formats for further details.
530− , swaggerHeaderFormat :: Maybe SwaggerFormat
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
691+ } deriving (Eq, Show, Generic, Data, Typeable)
531692
532− -- | __Required if type is @'SwaggerItemsArray'@__.
533− -- Describes the type of items in the array.
534− , swaggerHeaderItems :: SwaggerItems
693+data Example = Example { getExample :: Map MediaType Value }
694+ deriving (Eq, Show, Generic, Typeable)
535695
536− -- | Determines the format of the array if type array is used.
537− -- Default value is @'SwaggerItemsCollectionCSV'@.
538− , swaggerHeaderCollectionFormat :: SwaggerItemsCollectionFormat
696+exampleConstr :: Constr
697+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
539698
540− , swaggerHeaderCommon :: SwaggerSchemaCommon
541− } deriving (Eq, Show, Generic)
699+exampleDataType :: DataType
700+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
542701
543−data SwaggerExample = SwaggerExample { getSwaggerExample :: Map MediaType Value }
544− deriving (Eq, Show)
702+instance Data Example where
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
545708
546709-- | The location of the API key.
547−data SwaggerApiKeyLocation
548− = SwaggerApiKeyQuery
549− | SwaggerApiKeyHeader
550− deriving (Eq, Show)
710+data ApiKeyLocation
711+ = ApiKeyQuery
712+ | ApiKeyHeader
713+ deriving (Eq, Show, Generic, Data, Typeable)
551714
552−data SwaggerApiKeyParams = SwaggerApiKeyParams
715+data ApiKeyParams = ApiKeyParams
553716 { -- | The name of the header or query parameter to be used.
554− swaggerApiKeyName :: Text
717+ _apiKeyName :: Text
555718
556719 -- | The location of the API key.
557− , swaggerApiKeyIn :: SwaggerApiKeyLocation
558− } deriving (Eq, Show)
720+ , _apiKeyIn :: ApiKeyLocation
721+ } deriving (Eq, Show, Generic, Data, Typeable)
559722
560723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
561724type AuthorizationURL = Text
@@ -563,410 +726,702 @@ type AuthorizationURL = Text
563726-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
564727type TokenURL = Text
565728
566−data SwaggerOAuth2Flow
567− = SwaggerOAuth2Implicit AuthorizationURL
568− | SwaggerOAuth2Password TokenURL
569− | SwaggerOAuth2Application TokenURL
570− | SwaggerOAuth2AccessCode AuthorizationURL TokenURL
571− deriving (Eq, Show)
729+data OAuth2Flow
730+ = OAuth2Implicit AuthorizationURL
731+ | OAuth2Password TokenURL
732+ | OAuth2Application TokenURL
733+ | OAuth2AccessCode AuthorizationURL TokenURL
734+ deriving (Eq, Show, Generic, Data, Typeable)
572735
573−data SwaggerOAuth2Params = SwaggerOAuth2Params
736+data OAuth2Params = OAuth2Params
574737 { -- | The flow used by the OAuth2 security scheme.
575− swaggerOAuth2Flow :: SwaggerOAuth2Flow
738+ _oauth2Flow :: OAuth2Flow
576739
577740 -- | The available scopes for the OAuth2 security scheme.
578− , swaggerOAuth2Scopes :: HashMap Text Text
579− } deriving (Eq, Show, Generic)
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
742+ } deriving (Eq, Show, Generic, Data, Typeable)
580743
581−data SwaggerSecuritySchemeType
582− = SwaggerSecuritySchemeBasic
583− | SwaggerSecuritySchemeApiKey SwaggerApiKeyParams
584− | SwaggerSecuritySchemeOAuth2 SwaggerOAuth2Params
585− deriving (Eq, Show)
744+data SecuritySchemeType
745+ = SecuritySchemeBasic
746+ | SecuritySchemeApiKey ApiKeyParams
747+ | SecuritySchemeOAuth2 OAuth2Params
748+ deriving (Eq, Show, Generic, Data, Typeable)
586749
587−data SwaggerSecurityScheme = SwaggerSecurityScheme
750+data SecurityScheme = SecurityScheme
588751 { -- | The type of the security scheme.
589− swaggerSecuritySchemeType :: SwaggerSecuritySchemeType
752+ _securitySchemeType :: SecuritySchemeType
590753
591754 -- | A short description for security scheme.
592− , swaggerSecuritySchemeDescription :: Maybe Text
593− } deriving (Eq, Show, Generic)
755+ , _securitySchemeDescription :: Maybe Text
756+ } deriving (Eq, Show, Generic, Data, Typeable)
757+
758+
759+-- | merge scopes of two OAuth2 security schemes when their flows are identical.
760+-- In other case returns first security scheme
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
766+ else
767+ s1
768+mergeSecurityScheme s1 _ = s1
769+
770+newtype SecurityDefinitions
771+ = SecurityDefinitions (Definitions SecurityScheme)
772+ deriving (Eq, Show, Generic, Data, Typeable)
594773
595774-- | Lists the required security schemes to execute this operation.
596775-- The object can have multiple security schemes declared in it which are all required
597776-- (that is, there is a logical AND between the schemes).
598−newtype SwaggerSecurityRequirement = SwaggerSecurityRequirement
599− { getSwaggerSecurityRequirement :: HashMap Text [Text]
600− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
777+newtype SecurityRequirement = SecurityRequirement
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
601780
602−-- | Allows adding meta data to a single tag that is used by @SwaggerOperation@.
603−-- It is not mandatory to have a @SwaggerTag@ per tag used there.
604−data SwaggerTag = SwaggerTag
781+-- | Tag name.
782+type TagName = Text
783+
784+-- | Allows adding meta data to a single tag that is used by @Operation@.
785+-- It is not mandatory to have a @Tag@ per tag used there.
786+data Tag = Tag
605787 { -- | The name of the tag.
606− swaggerTagName :: Text
788+ _tagName :: TagName
607789
608790 -- | A short description for the tag.
609791 -- GFM syntax can be used for rich text representation.
610− , swaggerTagDescription :: Maybe Text
792+ , _tagDescription :: Maybe Text
611793
612794 -- | Additional external documentation for this tag.
613− , swaggerTagExternalDocs :: Maybe SwaggerExternalDocs
614− } deriving (Eq, Show)
795+ , _tagExternalDocs :: Maybe ExternalDocs
796+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
797+
798+instance Hashable Tag
799+
800+instance IsString Tag where
801+ fromString s = Tag (fromString s) Nothing Nothing
615802
616803-- | Allows referencing an external resource for extended documentation.
617−data SwaggerExternalDocs = SwaggerExternalDocs
804+data ExternalDocs = ExternalDocs
618805 { -- | A short description of the target documentation.
619806 -- GFM syntax can be used for rich text representation.
620− swaggerExternalDocsDescription :: Maybe Text
807+ _externalDocsDescription :: Maybe Text
621808
622809 -- | The URL for the target documentation.
623− , swaggerExternalDocsUrl :: URL
624− } deriving (Eq, Show, Generic)
810+ , _externalDocsUrl :: URL
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812+
813+instance Hashable ExternalDocs
814+
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)
625819
626−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
820+data Referenced a
821+ = Ref Reference
822+ | Inline a
823+ deriving (Eq, Show, Functor, Data, Typeable)
824+
825+instance IsString a => IsString (Referenced a) where
826+ fromString = Inline . fromString
827+
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
829+
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
627834
628835-- =======================================================================
629836-- Monoid instances
630837-- =======================================================================
631838
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
632841instance Monoid Swagger where
633842 mempty = genericMempty
634− mappend = genericMappend
843+ mappend = (<>)
844+
845+instance Semigroup Info where
846+ (<>) = genericMappend
847+instance Monoid Info where
848+ mempty = genericMempty
849+ mappend = (<>)
635850
636−instance Monoid SwaggerInfo where
851+instance Semigroup Contact where
852+ (<>) = genericMappend
853+instance Monoid Contact where
637854 mempty = genericMempty
638− mappend = genericMappend
855+ mappend = (<>)
639856
640−instance Monoid SwaggerPaths where
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
859+instance Monoid PathItem where
641860 mempty = genericMempty
642− mappend = genericMappend
861+ mappend = (<>)
643862
644−instance Monoid SwaggerPathItem where
863+instance Semigroup Schema where
864+ (<>) = genericMappend
865+instance Monoid Schema where
645866 mempty = genericMempty
646− mappend = genericMappend
867+ mappend = (<>)
647868
648−instance Monoid SwaggerSchema where
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
871+instance Monoid (ParamSchema t) where
649872 mempty = genericMempty
650− mappend = genericMappend
873+ mappend = (<>)
651874
652−instance Monoid SwaggerSchemaCommon where
875+instance Semigroup Param where
876+ (<>) = genericMappend
877+instance Monoid Param where
653878 mempty = genericMempty
654− mappend = genericMappend
879+ mappend = (<>)
655880
656−instance Monoid SwaggerParameter where
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
883+instance Monoid ParamOtherSchema where
657884 mempty = genericMempty
658− mappend = genericMappend
885+ mappend = (<>)
659886
660−instance Monoid SwaggerParameterOtherSchema where
887+instance Semigroup Header where
888+ (<>) = genericMappend
889+instance Monoid Header where
661890 mempty = genericMempty
662− mappend = genericMappend
891+ mappend = (<>)
663892
664−instance Monoid SwaggerResponses where
893+instance Semigroup Responses where
894+ (<>) = genericMappend
895+instance Monoid Responses where
665896 mempty = genericMempty
666− mappend = genericMappend
897+ mappend = (<>)
667898
668−instance Monoid SwaggerResponse where
899+instance Semigroup Response where
900+ (<>) = genericMappend
901+instance Monoid Response where
669902 mempty = genericMempty
670− mappend = genericMappend
903+ mappend = (<>)
671904
672−instance Monoid SwaggerExternalDocs where
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
907+instance Monoid ExternalDocs where
673908 mempty = genericMempty
674− mappend = genericMappend
909+ mappend = (<>)
675910
676−instance Monoid SwaggerOperation where
911+instance Semigroup Operation where
912+ (<>) = genericMappend
913+instance Monoid Operation where
677914 mempty = genericMempty
678− mappend = genericMappend
915+ mappend = (<>)
916+
917+instance Semigroup Example where
918+ (<>) = genericMappend
919+instance Monoid Example where
920+ mempty = genericMempty
921+ mappend = (<>)
922+
923+instance Semigroup SecurityScheme where
924+ (<>) = mergeSecurityScheme
925+
926+instance Semigroup SecurityDefinitions where
927+ (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928+ SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
929+
930+instance Monoid SecurityDefinitions where
931+ mempty = SecurityDefinitions $ InsOrdHashMap.empty
932+ mappend = (<>)
679933
680934-- =======================================================================
681935-- SwaggerMonoid helper instances
682936-- =======================================================================
683937
684−instance SwaggerMonoid SwaggerInfo
685−instance SwaggerMonoid SwaggerPaths
686−instance SwaggerMonoid SwaggerPathItem
687−instance SwaggerMonoid SwaggerSchema
688−instance SwaggerMonoid SwaggerSchemaCommon
689−instance SwaggerMonoid SwaggerParameter
690−instance SwaggerMonoid SwaggerParameterOtherSchema
691−instance SwaggerMonoid SwaggerResponses
692−instance SwaggerMonoid SwaggerResponse
693−instance SwaggerMonoid SwaggerExternalDocs
694−instance SwaggerMonoid SwaggerOperation
695−
696−instance SwaggerMonoid SwaggerMimeList
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)
950+
951+instance SwaggerMonoid MimeList
697952deriving instance SwaggerMonoid URL
698953
699−instance SwaggerMonoid SwaggerSchemaType where
700− swaggerMempty = SwaggerSchemaNull
954+instance SwaggerMonoid (SwaggerType t) where
955+ swaggerMempty = SwaggerString
701956 swaggerMappend _ y = y
702957
703−instance SwaggerMonoid SwaggerParameterType where
704− swaggerMempty = SwaggerParamString
958+instance SwaggerMonoid ParamLocation where
959+ swaggerMempty = ParamQuery
705960 swaggerMappend _ y = y
706961
707−instance SwaggerMonoid SwaggerParameterLocation where
708− swaggerMempty = SwaggerParameterQuery
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963+ swaggerMempty = InsOrdHashMap.empty
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
965+
966+instance Monoid a => SwaggerMonoid (Referenced a) where
967+ swaggerMempty = Inline mempty
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
709969 swaggerMappend _ y = y
710970
711−instance SwaggerMonoid (HashMap Text SwaggerSchema) where
712− swaggerMempty = HashMap.empty
713− swaggerMappend = HashMap.unionWith mappend
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
714976
715−instance SwaggerMonoid (HashMap Text SwaggerParameter) where
716− swaggerMempty = HashMap.empty
717− swaggerMappend = HashMap.unionWith mappend
977+-- =======================================================================
978+-- Simple Generic-based ToJSON instances
979+-- =======================================================================
718980
719−instance SwaggerMonoid (HashMap Text SwaggerResponse) where
720− swaggerMempty = HashMap.empty
721− swaggerMappend = flip HashMap.union
981+instance ToJSON ParamLocation where
982+ toJSON = genericToJSON (jsonPrefix "Param")
722983
723−instance SwaggerMonoid (HashMap Text SwaggerSecurityScheme) where
724− swaggerMempty = HashMap.empty
725− swaggerMappend = flip HashMap.union
984+instance ToJSON Info where
985+ toJSON = genericToJSON (jsonPrefix "Info")
726986
727−instance SwaggerMonoid (HashMap FilePath SwaggerPathItem) where
728− swaggerMempty = HashMap.empty
729− swaggerMappend = HashMap.unionWith mappend
987+instance ToJSON Contact where
988+ toJSON = genericToJSON (jsonPrefix "Contact")
730989
731−instance SwaggerMonoid (HashMap HeaderName SwaggerHeader) where
732− swaggerMempty = HashMap.empty
733− swaggerMappend = flip HashMap.union
990+instance ToJSON License where
991+ toJSON = genericToJSON (jsonPrefix "License")
734992
735−instance SwaggerMonoid (HashMap HttpStatusCode SwaggerResponse) where
736− swaggerMempty = HashMap.empty
737− swaggerMappend = flip HashMap.union
993+instance ToJSON ApiKeyLocation where
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
738995
739−instance SwaggerMonoid SwaggerParameterSchema where
740− swaggerMempty = SwaggerParameterOther swaggerMempty
741− swaggerMappend (SwaggerParameterBody x) (SwaggerParameterBody y) = SwaggerParameterBody (swaggerMappend x y)
742− swaggerMappend (SwaggerParameterOther x) (SwaggerParameterOther y) = SwaggerParameterOther (swaggerMappend x y)
743− swaggerMappend _ y = y
996+instance ToJSON ApiKeyParams where
997+ toJSON = genericToJSON (jsonPrefix "apiKey")
998+
999+instance ToJSON Scheme where
1000+ toJSON = genericToJSON (jsonPrefix "")
1001+
1002+instance ToJSON Tag where
1003+ toJSON = genericToJSON (jsonPrefix "Tag")
1004+
1005+instance ToJSON ExternalDocs where
1006+ toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1007+
1008+instance ToJSON Xml where
1009+ toJSON = genericToJSON (jsonPrefix "Xml")
7441010
7451011-- =======================================================================
746−-- TH derived ToJSON and FromJSON instances
1012+-- Simple Generic-based FromJSON instances
7471013-- =======================================================================
7481014
749−deriveJSON (jsonPrefix "SwaggerParameter") ''SwaggerParameterLocation
750−deriveJSON (jsonPrefix "SwaggerParam") ''SwaggerParameterType
751−deriveJSON' ''SwaggerInfo
752−deriveJSON' ''SwaggerContact
753−deriveJSON' ''SwaggerLicense
754−deriveJSON (jsonPrefix "SwaggerSchema") ''SwaggerSchemaType
755−deriveJSON (jsonPrefix "SwaggerItems") ''SwaggerItemsType
756−deriveJSON (jsonPrefix "SwaggerItemsCollection") ''SwaggerItemsCollectionFormat
757−deriveJSON (jsonPrefix "SwaggerCollection") ''SwaggerCollectionFormat
758−deriveJSON (jsonPrefix "SwaggerApiKey") ''SwaggerApiKeyLocation
759−deriveJSON (jsonPrefix "swaggerApiKey") ''SwaggerApiKeyParams
760−deriveJSON (jsonPrefix "swaggerSchema") ''SwaggerSchemaCommon
761−deriveJSONDefault ''SwaggerScheme
762−deriveJSON' ''SwaggerTag
763−deriveJSON' ''SwaggerExternalDocs
764−deriveJSON' ''SwaggerXml
765−
766−deriveToJSON' ''SwaggerOperation
767−deriveToJSON' ''SwaggerResponse
768−deriveToJSON' ''SwaggerPathItem
1015+instance FromJSON ParamLocation where
1016+ parseJSON = genericParseJSON (jsonPrefix "Param")
1017+
1018+instance FromJSON Info where
1019+ parseJSON = genericParseJSON (jsonPrefix "Info")
1020+
1021+instance FromJSON Contact where
1022+ parseJSON = genericParseJSON (jsonPrefix "Contact")
1023+
1024+instance FromJSON License where
1025+ parseJSON = genericParseJSON (jsonPrefix "License")
1026+
1027+instance FromJSON ApiKeyLocation where
1028+ parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1029+
1030+instance FromJSON ApiKeyParams where
1031+ parseJSON = genericParseJSON (jsonPrefix "apiKey")
1032+
1033+instance FromJSON Scheme where
1034+ parseJSON = genericParseJSON (jsonPrefix "")
1035+
1036+instance FromJSON Tag where
1037+ parseJSON = genericParseJSON (jsonPrefix "Tag")
1038+
1039+instance FromJSON ExternalDocs where
1040+ parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
7691041
7701042-- =======================================================================
7711043-- Manual ToJSON instances
7721044-- =======================================================================
7731045
774−instance ToJSON SwaggerOAuth2Flow where
775− toJSON (SwaggerOAuth2Implicit authUrl) = object
1046+instance ToJSON OAuth2Flow where
1047+ toJSON (OAuth2Implicit authUrl) = object
7761048 [ "flow" .= ("implicit" :: Text)
7771049 , "authorizationUrl" .= authUrl ]
778− toJSON (SwaggerOAuth2Password tokenUrl) = object
1050+ toJSON (OAuth2Password tokenUrl) = object
7791051 [ "flow" .= ("password" :: Text)
7801052 , "tokenUrl" .= tokenUrl ]
781− toJSON (SwaggerOAuth2Application tokenUrl) = object
1053+ toJSON (OAuth2Application tokenUrl) = object
7821054 [ "flow" .= ("application" :: Text)
7831055 , "tokenUrl" .= tokenUrl ]
784− toJSON (SwaggerOAuth2AccessCode authUrl tokenUrl) = object
1056+ toJSON (OAuth2AccessCode authUrl tokenUrl) = object
7851057 [ "flow" .= ("accessCode" :: Text)
7861058 , "authorizationUrl" .= authUrl
7871059 , "tokenUrl" .= tokenUrl ]
7881060
789−instance ToJSON SwaggerOAuth2Params where
790− toJSON = genericToJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1061+instance ToJSON OAuth2Params where
1062+ toJSON = sopSwaggerGenericToJSON
1063+ DEFINE_TOENCODING
7911064
792−instance ToJSON SwaggerSecuritySchemeType where
793− toJSON SwaggerSecuritySchemeBasic
1065+instance ToJSON SecuritySchemeType where
1066+ toJSON SecuritySchemeBasic
7941067 = object [ "type" .= ("basic" :: Text) ]
795− toJSON (SwaggerSecuritySchemeApiKey params)
1068+ toJSON (SecuritySchemeApiKey params)
7961069 = toJSON params
7971070 <+> object [ "type" .= ("apiKey" :: Text) ]
798− toJSON (SwaggerSecuritySchemeOAuth2 params)
1071+ toJSON (SecuritySchemeOAuth2 params)
7991072 = toJSON params
8001073 <+> object [ "type" .= ("oauth2" :: Text) ]
8011074
8021075instance ToJSON Swagger where
803− toJSON = addVersion . genericToJSON (jsonPrefix "swagger")
804− where
805− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
806− addVersion _ = error "impossible"
1076+ toJSON = sopSwaggerGenericToJSON
1077+ DEFINE_TOENCODING
1078+
1079+instance ToJSON SecurityScheme where
1080+ toJSON = sopSwaggerGenericToJSON
1081+ DEFINE_TOENCODING
1082+
1083+instance ToJSON Schema where
1084+ toJSON = sopSwaggerGenericToJSON
1085+ DEFINE_TOENCODING
1086+
1087+instance ToJSON Header where
1088+ toJSON = sopSwaggerGenericToJSON
1089+ DEFINE_TOENCODING
1090+
1091+-- | As for nullary schema for 0-arity type constructors, see
1092+-- <https://github.com/GetShopTV/swagger2/issues/167>.
1093+--
1094+-- >>> encode (SwaggerItemsArray [])
1095+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1096+--
1097+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
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
1106+ ]
1107+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1108+
1109+instance ToJSON Host where
1110+ toJSON (Host host mport) = toJSON $
1111+ case mport of
1112+ Nothing -> host
1113+ Just port -> host ++ ":" ++ show port
8071114
808−instance ToJSON SwaggerSecurityScheme where
809− toJSON = genericToJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
1115+instance ToJSON MimeList where
1116+ toJSON (MimeList xs) = toJSON (map show xs)
8101117
811−instance ToJSON SwaggerSchema where
812− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerSchema")
1118+instance ToJSON Param where
1119+ toJSON = sopSwaggerGenericToJSON
1120+ DEFINE_TOENCODING
8131121
814−instance ToJSON SwaggerHeader where
815− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerHeader")
1122+instance ToJSON ParamAnySchema where
1123+ toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124+ toJSON (ParamOther s) = toJSON s
8161125
817−instance ToJSON SwaggerItems where
818− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerItems")
1126+instance ToJSON ParamOtherSchema where
1127+ toJSON = sopSwaggerGenericToJSON
1128+ DEFINE_TOENCODING
8191129
820−instance ToJSON SwaggerHost where
821− toJSON (SwaggerHost host mport) = toJSON $
822− case mport of
823− Nothing -> host
824− Just port -> host ++ ":" ++ show port
1130+instance ToJSON Responses where
1131+ toJSON = sopSwaggerGenericToJSON
1132+ DEFINE_TOENCODING
1133+
1134+instance ToJSON Response where
1135+ toJSON = sopSwaggerGenericToJSON
1136+ DEFINE_TOENCODING
1137+
1138+instance ToJSON Operation where
1139+ toJSON = sopSwaggerGenericToJSON
1140+ DEFINE_TOENCODING
1141+
1142+instance ToJSON PathItem where
1143+ toJSON = sopSwaggerGenericToJSON
1144+ DEFINE_TOENCODING
1145+
1146+instance ToJSON Example where
1147+ toJSON = toJSON . Map.mapKeys show . getExample
8251148
826−instance ToJSON SwaggerPaths where
827− toJSON (SwaggerPaths m) = toJSON m
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
8281151
829−instance ToJSON SwaggerMimeList where
830− toJSON (SwaggerMimeList xs) = toJSON (map show xs)
1152+instance ToJSON Reference where
1153+ toJSON (Reference ref) = object [ "$ref" .= ref ]
8311154
832−instance ToJSON SwaggerParameter where
833− toJSON = genericToJSONWithSub "schema" (jsonPrefix "swaggerParameter")
1155+referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
1156+referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
1157+referencedToJSON _ (Inline x) = toJSON x
8341158
835−instance ToJSON SwaggerParameterSchema where
836− toJSON (SwaggerParameterBody s) = toJSON s <+> object [ "in" .= ("body" :: Text) ]
837− toJSON (SwaggerParameterOther s) = toJSON s
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/"
8381162
839−instance ToJSON SwaggerParameterOtherSchema where
840− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
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"
8411172
842−instance ToJSON SwaggerSchemaItems where
843− toJSON (SwaggerSchemaItemsObject x) = toJSON x
844− toJSON (SwaggerSchemaItemsArray xs) = toJSON xs
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"
8451179
846−instance ToJSON SwaggerResponses where
847− toJSON (SwaggerResponses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
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"
8481184
849−instance ToJSON SwaggerExample where
850− toJSON = toJSON . Map.mapKeys show . getSwaggerExample
1185+instance ToJSON AdditionalProperties where
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
8511188
8521189-- =======================================================================
8531190-- Manual FromJSON instances
8541191-- =======================================================================
8551192
856−instance FromJSON SwaggerOAuth2Flow where
1193+instance FromJSON OAuth2Flow where
8571194 parseJSON (Object o) = do
8581195 (flow :: Text) <- o .: "flow"
8591196 case flow of
860− "implicit" -> SwaggerOAuth2Implicit <$> o .: "authorizationUrl"
861− "password" -> SwaggerOAuth2Password <$> o .: "tokenUrl"
862− "application" -> SwaggerOAuth2Application <$> o .: "tokenUrl"
863− "accessCode" -> SwaggerOAuth2AccessCode
1197+ "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
1198+ "password" -> OAuth2Password <$> o .: "tokenUrl"
1199+ "application" -> OAuth2Application <$> o .: "tokenUrl"
1200+ "accessCode" -> OAuth2AccessCode
8641201 <$> o .: "authorizationUrl"
8651202 <*> o .: "tokenUrl"
8661203 _ -> empty
8671204 parseJSON _ = empty
8681205
869−instance FromJSON SwaggerOAuth2Params where
870− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1206+instance FromJSON OAuth2Params where
1207+ parseJSON = sopSwaggerGenericParseJSON
8711208
872−instance FromJSON SwaggerSecuritySchemeType where
873− parseJSON json@(Object o) = do
1209+instance FromJSON SecuritySchemeType where
1210+ parseJSON js@(Object o) = do
8741211 (t :: Text) <- o .: "type"
8751212 case t of
876− "basic" -> pure SwaggerSecuritySchemeBasic
877− "apiKey" -> SwaggerSecuritySchemeApiKey <$> parseJSON json
878− "oauth2" -> SwaggerSecuritySchemeOAuth2 <$> parseJSON json
1213+ "basic" -> pure SecuritySchemeBasic
1214+ "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1215+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
8791216 _ -> empty
8801217 parseJSON _ = empty
8811218
8821219instance FromJSON Swagger where
883− parseJSON json@(Object o) = do
884− (version :: Text) <- o .: "swagger"
885− when (version /= "2.0") empty
886− (genericParseJSON (jsonPrefix "swagger")
887− `withDefaults` [ "consumes" .= (mempty :: SwaggerMimeList)
888− , "produces" .= (mempty :: SwaggerMimeList)
889− , "security" .= ([] :: [SwaggerSecurityRequirement])
890− , "tags" .= ([] :: [SwaggerTag])
891− , "definitions" .= (mempty :: HashMap Text SwaggerSchema)
892− , "parameters" .= (mempty :: HashMap Text SwaggerParameter)
893− , "responses" .= (mempty :: HashMap Text SwaggerResponse)
894− , "securityDefinitions" .= (mempty :: HashMap Text SwaggerSecurityScheme)
895− ] ) json
1220+ parseJSON = sopSwaggerGenericParseJSON
1221+
1222+instance FromJSON SecurityScheme where
1223+ parseJSON = sopSwaggerGenericParseJSON
1224+
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 } }
1232+ else s
1233+
1234+instance FromJSON Header where
1235+ parseJSON = sopSwaggerGenericParseJSON
1236+
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)
1241+
1242+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1243+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244+ <$> o .:? "collectionFormat"
1245+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1246+
1247+-- |
1248+--
1249+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250+-- Just (SwaggerItemsArray [])
1251+--
1252+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1254+--
1255+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1257+--
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
8961263 parseJSON _ = empty
8971264
898−instance FromJSON SwaggerSecurityScheme where
899− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
900−
901−instance FromJSON SwaggerSchema where
902− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerSchema")
903− `withDefaults` [ "properties" .= (mempty :: HashMap Text SwaggerSchema)
904− , "required" .= ([] :: [SwaggerParamName]) ]
905−
906−instance FromJSON SwaggerHeader where
907− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerHeader")
908−
909−instance FromJSON SwaggerItems where
910− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerItems")
911−
912−instance FromJSON SwaggerHost where
913− parseJSON (String s) =
914− case fromInteger <$> readMaybe portStr of
915− Nothing | not (null portStr) -> empty
916− mport -> pure $ SwaggerHost host mport
917− where
918− (hostText, portText) = Text.breakOnEnd ":" s
919− [host, portStr] = map Text.unpack [hostText, portText]
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 ++ "'"
9201272 parseJSON _ = empty
9211273
922−instance FromJSON SwaggerPaths where
923− parseJSON json = SwaggerPaths <$> parseJSON json
924−
925−instance FromJSON SwaggerMimeList where
926− parseJSON json = (SwaggerMimeList . map fromString) <$> parseJSON json
1274+instance FromJSON MimeList where
1275+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
9271276
928−instance FromJSON SwaggerParameter where
929− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "swaggerParameter")
930− `withDefaults` [ "required" .= False ]
1277+instance FromJSON Param where
1278+ parseJSON = sopSwaggerGenericParseJSON
9311279
932−instance FromJSON SwaggerParameterSchema where
933− parseJSON json@(Object o) = do
1280+instance FromJSON ParamAnySchema where
1281+ parseJSON js@(Object o) = do
9341282 (i :: Text) <- o .: "in"
9351283 case i of
936− "body" -> SwaggerParameterBody <$> parseJSON json
937− _ -> SwaggerParameterOther <$> parseJSON json
1284+ "body" -> do
1285+ schema <- o .: "schema"
1286+ ParamBody <$> parseJSON schema
1287+ _ -> ParamOther <$> parseJSON js
9381288 parseJSON _ = empty
9391289
940−instance FromJSON SwaggerParameterOtherSchema where
941− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
942− `withDefaults` [ "allowEmptyValue" .= False ]
1290+instance FromJSON ParamOtherSchema where
1291+ parseJSON = sopSwaggerGenericParseJSON
9431292
944−instance FromJSON SwaggerSchemaItems where
945− parseJSON json@(Object _) = SwaggerSchemaItemsObject <$> parseJSON json
946− parseJSON json@(Array _) = SwaggerSchemaItemsArray <$> parseJSON json
947− parseJSON _ = empty
948−
949−instance FromJSON SwaggerResponses where
950− parseJSON (Object o) = SwaggerResponses
1293+instance FromJSON Responses where
1294+ parseJSON (Object o) = Responses
9511295 <$> o .:? "default"
952− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
9531297 parseJSON _ = empty
9541298
955−instance FromJSON SwaggerExample where
956− parseJSON json = do
957− m <- parseJSON json
958− pure $ SwaggerExample (Map.mapKeys fromString m)
1299+instance FromJSON Example where
1300+ parseJSON js = do
1301+ m <- parseJSON js
1302+ pure $ Example (Map.mapKeys fromString m)
1303+
1304+instance FromJSON Response where
1305+ parseJSON = sopSwaggerGenericParseJSON
9591306
960−instance FromJSON SwaggerResponse where
961− parseJSON = genericParseJSON (jsonPrefix "swaggerResponse")
962− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName SwaggerHeader) ]
1307+instance FromJSON Operation where
1308+ parseJSON = sopSwaggerGenericParseJSON
9631309
964−instance FromJSON SwaggerOperation where
965− parseJSON = genericParseJSON (jsonPrefix "swaggerOperation")
966− `withDefaults` [ "deprecated" .= False
967− , "security" .= ([] :: [SwaggerSecurityRequirement]) ]
1310+instance FromJSON PathItem where
1311+ parseJSON = sopSwaggerGenericParseJSON
9681312
969−instance FromJSON SwaggerPathItem where
970− parseJSON = genericParseJSON (jsonPrefix "swaggerPathItem")
971− `withDefaults` [ "parameters" .= ([] :: [SwaggerParameter]) ]
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
1315+
1316+instance FromJSON Reference where
1317+ parseJSON (Object o) = Reference <$> o .: "$ref"
1318+ parseJSON _ = empty
9721319
1320+referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
1321+referencedParseJSON prefix js@(Object o) = do
1322+ ms <- o .:? "$ref"
1323+ case ms of
1324+ Nothing -> Inline <$> parseJSON js
1325+ Just s -> Ref <$> parseRef s
1326+ where
1327+ parseRef s = do
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"
1332+
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/"
1336+
1337+instance FromJSON Xml where
1338+ parseJSON = genericParseJSON (jsonPrefix "xml")
1339+
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1341+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1342+
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1344+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1345+
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1347+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1348+
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1350+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1351+
1352+-- NOTE: There aren't collections of 'Schema'
1353+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1354+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1355+
1356+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1357+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1358+
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
1365+
1366+instance FromJSON AdditionalProperties where
1367+ parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368+ parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1369+
1370+-------------------------------------------------------------------------------
1371+-- TH splices
1372+-------------------------------------------------------------------------------
1373+
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
1386+
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")]
1409+
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"
1417+
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