@@ -1,3 +1,7 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
15{-# LANGUAGE DeriveGeneric #-}
26{-# LANGUAGE DeriveTraversable #-}
37{-# LANGUAGE FlexibleContexts #-}
@@ -9,88 +13,128 @@
913{-# LANGUAGE ScopedTypeVariables #-}
1014{-# LANGUAGE StandaloneDeriving #-}
1115{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
20+#endif
21+#include "overlapping-compat.h"
1222module Data.Swagger.Internal where
1323
24+import Prelude ()
25+import Prelude.Compat
26+
27+import Control.Lens ((&), (.~), (?~))
1428import Control.Applicative
15−import Control.Monad
1629import Data.Aeson
17−import Data.Aeson.TH (deriveJSON)
18−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)
1933import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
2035import Data.Map (Map)
2136import qualified Data.Map as Map
22−import Data.Monoid
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
2339import Data.Scientific (Scientific)
24−import Data.String (fromString)
40+import Data.String (IsString(..))
2541import Data.Text (Text)
2642import qualified Data.Text as Text
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− _info :: Info
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− , _host :: Maybe Host
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− , _basePath :: 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− , _schemes :: Maybe [Scheme]
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− , _consumes :: MimeList
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− , _produces :: MimeList
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− , _paths :: Paths
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− , _definitions :: HashMap Text Schema
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− , _parameters :: HashMap Text Param
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− , _responses :: HashMap Text Response
117+ , _swaggerResponses :: Definitions Response
74118
75119 -- | Security scheme definitions that can be used across the specification.
76− , _securityDefinitions :: HashMap Text SecurityScheme
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− , _security :: [SecurityRequirement]
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− , _tags :: [Tag]
133+ , _swaggerTags :: InsOrdHashSet Tag
90134
91135 -- | Additional external documentation.
92− , _externalDocs :: Maybe ExternalDocs
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,
@@ -115,7 +159,7 @@ data Info = Info
115159 -- | Provides the version of the application API
116160 -- (not to be confused with the specification version).
117161 , _infoVersion :: Text
118− } deriving (Eq, Show, Generic)
162+ } deriving (Eq, Show, Generic, Data, Typeable)
119163
120164-- | Contact information for the exposed API.
121165data Contact = Contact
@@ -127,7 +171,7 @@ data Contact = Contact
127171
128172 -- | The email address of the contact person/organization.
129173 , _contactEmail :: Maybe Text
130− } deriving (Eq, Show)
174+ } deriving (Eq, Show, Generic, Data, Typeable)
131175
132176-- | License information for the exposed API.
133177data License = License
@@ -136,13 +180,32 @@ data License = License
136180
137181 -- | A URL to the license used for the API.
138182 , _licenseUrl :: Maybe URL
139− } deriving (Eq, Show)
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.
142189data Host = Host
143190 { _hostName :: HostName -- ^ Host name.
144191 , _hostPort :: Maybe PortNumber -- ^ Optional port.
145− } deriving (Eq, Show)
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.
148211data Scheme
@@ -150,14 +213,7 @@ data Scheme
150213 | Https
151214 | Ws
152215 | Wss
153− deriving (Eq, Show)
154−
155−-- | The available paths and operations for the API.
156−data Paths = Paths
157− { -- | Holds the relative paths to the individual endpoints.
158− -- The path is appended to the @'basePath'@ in order to construct the full URL.
159− _pathsMap :: HashMap FilePath PathItem
160− } deriving (Eq, Show, Generic)
216+ deriving (Eq, Show, Generic, Data, Typeable)
161217
162218-- | Describes the operations available on a single path.
163219-- A @'PathItem'@ may be empty, due to ACL constraints.
@@ -190,13 +246,13 @@ data PathItem = PathItem
190246 -- The list MUST NOT include duplicated parameters.
191247 -- A unique parameter is defined by a combination of a name and location.
192248 , _pathItemParameters :: [Referenced Param]
193− } deriving (Eq, Show, Generic)
249+ } deriving (Eq, Show, Generic, Data, Typeable)
194250
195251-- | Describes a single API operation on a path.
196252data 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− _operationTags :: [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.
@@ -250,10 +306,23 @@ data Operation = Operation
250306 -- This definition overrides any declared top-level security.
251307 -- To remove a top-level security declaration, @Just []@ can be used.
252308 , _operationSecurity :: [SecurityRequirement]
253− } deriving (Eq, Show, Generic)
309+ } deriving (Eq, Show, Generic, Data, Typeable)
254310
255311newtype MimeList = MimeList { getMimeList :: [MediaType] }
256− deriving (Eq, Show, Monoid)
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
313+
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.
@@ -274,12 +343,12 @@ data Param = Param
274343
275344 -- | Parameter schema.
276345 , _paramSchema :: ParamAnySchema
277− } deriving (Eq, Show, Generic)
346+ } deriving (Eq, Show, Generic, Data, Typeable)
278347
279348data ParamAnySchema
280349 = ParamBody (Referenced Schema)
281350 | ParamOther ParamOtherSchema
282− deriving (Eq, Show)
351+ deriving (Eq, Show, Generic, Data, Typeable)
283352
284353data ParamOtherSchema = ParamOtherSchema
285354 { -- | The location of the parameter.
@@ -291,12 +360,92 @@ data ParamOtherSchema = ParamOtherSchema
291360 -- Default value is @False@.
292361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
293362
294− -- | Determines the format of the array if @'ParamArray'@ is used.
295− -- Default value is csv.
296− , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
297−
298− , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema Items
299− } deriving (Eq, Show, Generic)
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
300449
301450data SwaggerType t where
302451 SwaggerString :: SwaggerType t
@@ -304,13 +453,48 @@ data SwaggerType t where
304453 SwaggerInteger :: SwaggerType t
305454 SwaggerBoolean :: SwaggerType t
306455 SwaggerArray :: SwaggerType t
307− SwaggerFile :: SwaggerType ParamOtherSchema
308− SwaggerNull :: SwaggerType Schema
309− SwaggerObject :: SwaggerType Schema
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
459+ deriving (Typeable)
310460
311461deriving instance Eq (SwaggerType t)
312462deriving instance Show (SwaggerType t)
313463
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+
314498data ParamLocation
315499 = -- | Parameters that are appended to the URL.
316500 -- For example, in @/items?id=###@, the query parameter is @id@.
@@ -329,7 +513,7 @@ data ParamLocation
329513 -- Form parameters have a different format based on the content-type used
330514 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
331515 | ParamFormData
332− deriving (Eq, Show)
516+ deriving (Eq, Show, Generic, Data, Typeable)
333517
334518type Format = Text
335519
@@ -346,11 +530,29 @@ data CollectionFormat t where
346530 -- Corresponds to multiple parameter instances
347531 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
348532 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
349− CollectionMulti :: CollectionFormat Param
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534+ deriving (Typeable)
350535
351536deriving instance Eq (CollectionFormat t)
352537deriving instance Show (CollectionFormat t)
353538
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+
354556type ParamName = Text
355557
356558data Schema = Schema
@@ -358,9 +560,9 @@ data Schema = Schema
358560 , _schemaDescription :: Maybe Text
359561 , _schemaRequired :: [ParamName]
360562
361− , _schemaAllOf :: Maybe [Schema]
362− , _schemaProperties :: HashMap Text (Referenced Schema)
363− , _schemaAdditionalProperties :: Maybe Schema
563+ , _schemaAllOf :: Maybe [Referenced Schema]
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
364566
365567 , _schemaDiscriminator :: Maybe Text
366568 , _schemaReadOnly :: Maybe Bool
@@ -371,15 +573,20 @@ data Schema = Schema
371573 , _schemaMaxProperties :: Maybe Integer
372574 , _schemaMinProperties :: Maybe Integer
373575
374− , _schemaParamSchema :: ParamSchema Schema SchemaItems
375− } deriving (Eq, Show, Generic)
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
577+ } deriving (Eq, Show, Generic, Data, Typeable)
376578
377−data SchemaItems
378− = SchemaItemsObject (Referenced Schema)
379− | SchemaItemsArray [Referenced Schema]
380− deriving (Eq, Show)
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)
381585
382−data ParamSchema t items = ParamSchema
586+-- | Regex pattern for @string@ type.
587+type Pattern = Text
588+
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
383590 { -- | Declares the value of the parameter that the server will use if none is provided,
384591 -- for example a @"count"@ to control the number of results per page might default to @100@
385592 -- if not supplied by the client in the request.
@@ -387,26 +594,28 @@ data ParamSchema t items = ParamSchema
387594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
388595 _paramSchemaDefault :: Maybe Value
389596
390− , _paramSchemaType :: SwaggerType t
597+ , _paramSchemaType :: Maybe (SwaggerType t)
391598 , _paramSchemaFormat :: Maybe Format
392− , _paramSchemaItems :: Maybe items
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
393600 , _paramSchemaMaximum :: Maybe Scientific
394601 , _paramSchemaExclusiveMaximum :: Maybe Bool
395602 , _paramSchemaMinimum :: Maybe Scientific
396603 , _paramSchemaExclusiveMinimum :: Maybe Bool
397604 , _paramSchemaMaxLength :: Maybe Integer
398605 , _paramSchemaMinLength :: Maybe Integer
399− , _paramSchemaPattern :: Maybe Text
606+ , _paramSchemaPattern :: Maybe Pattern
400607 , _paramSchemaMaxItems :: Maybe Integer
401608 , _paramSchemaMinItems :: Maybe Integer
402609 , _paramSchemaUniqueItems :: Maybe Bool
403610 , _paramSchemaEnum :: Maybe [Value]
404611 , _paramSchemaMultipleOf :: Maybe Scientific
405− } deriving (Eq, Show, Generic)
612+ } deriving (Eq, Show, Generic, Typeable)
613+
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
406615
407616data Xml = Xml
408617 { -- | Replaces the name of the element/attribute used for the described schema property.
409− -- When defined within the @'Items'@ (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.
410619 -- When defined alongside type being array (outside the items),
411620 -- it will affect the wrapping element and only if wrapped is true.
412621 -- If wrapped is false, it will be ignored.
@@ -430,15 +639,7 @@ data Xml = Xml
430639 -- Default value is @False@.
431640 -- The definition takes effect only when defined alongside type being array (outside the items).
432641 , _xmlWrapped :: Maybe Bool
433− } deriving (Eq, Show, Generic)
434−
435−data Items = Items
436− { -- | Determines the format of the array if type array is used.
437− -- Default value is @'ItemsCollectionCSV'@.
438− _itemsCollectionFormat :: Maybe (CollectionFormat Items)
439−
440− , _itemsParamSchema :: ParamSchema Items Items
441− } deriving (Eq, Show, Generic)
642+ } deriving (Eq, Show, Generic, Data, Typeable)
442643
443644-- | A container for the expected responses of an operation.
444645-- The container maps a HTTP response code to the expected response.
@@ -452,8 +653,8 @@ data Responses = Responses
452653
453654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
454655 -- Describes the expected response for those HTTP status codes.
455− , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
456− } deriving (Eq, Show, Generic)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
657+ } deriving (Eq, Show, Generic, Data, Typeable)
457658
458659type HttpStatusCode = Int
459660
@@ -471,11 +672,14 @@ data Response = Response
471672 , _responseSchema :: Maybe (Referenced Schema)
472673
473674 -- | A list of headers that are sent with the response.
474− , _responseHeaders :: HashMap HeaderName Header
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
475676
476677 -- | An example of the response message.
477678 , _responseExamples :: Maybe Example
478− } deriving (Eq, Show, Generic)
679+ } deriving (Eq, Show, Generic, Data, Typeable)
680+
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
479683
480684type HeaderName = Text
481685
@@ -483,21 +687,30 @@ data Header = Header
483687 { -- | A short description of the header.
484688 _headerDescription :: Maybe Text
485689
486− -- | Determines the format of the array if type array is used.
487− -- Default value is @'ItemsCollectionCSV'@.
488− , _headerCollectionFormat :: Maybe (CollectionFormat Items)
489−
490− , _headerParamSchema :: ParamSchema Header Items
491− } deriving (Eq, Show, Generic)
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
691+ } deriving (Eq, Show, Generic, Data, Typeable)
492692
493693data Example = Example { getExample :: Map MediaType Value }
494− deriving (Eq, Show)
694+ deriving (Eq, Show, Generic, Typeable)
695+
696+exampleConstr :: Constr
697+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
698+
699+exampleDataType :: DataType
700+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
701+
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
495708
496709-- | The location of the API key.
497710data ApiKeyLocation
498711 = ApiKeyQuery
499712 | ApiKeyHeader
500− deriving (Eq, Show)
713+ deriving (Eq, Show, Generic, Data, Typeable)
501714
502715data ApiKeyParams = ApiKeyParams
503716 { -- | The name of the header or query parameter to be used.
@@ -505,7 +718,7 @@ data ApiKeyParams = ApiKeyParams
505718
506719 -- | The location of the API key.
507720 , _apiKeyIn :: ApiKeyLocation
508− } deriving (Eq, Show)
721+ } deriving (Eq, Show, Generic, Data, Typeable)
509722
510723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
511724type AuthorizationURL = Text
@@ -518,21 +731,21 @@ data OAuth2Flow
518731 | OAuth2Password TokenURL
519732 | OAuth2Application TokenURL
520733 | OAuth2AccessCode AuthorizationURL TokenURL
521− deriving (Eq, Show)
734+ deriving (Eq, Show, Generic, Data, Typeable)
522735
523736data OAuth2Params = OAuth2Params
524737 { -- | The flow used by the OAuth2 security scheme.
525738 _oauth2Flow :: OAuth2Flow
526739
527740 -- | The available scopes for the OAuth2 security scheme.
528− , _oauth2Scopes :: HashMap Text Text
529− } deriving (Eq, Show, Generic)
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
742+ } deriving (Eq, Show, Generic, Data, Typeable)
530743
531744data SecuritySchemeType
532745 = SecuritySchemeBasic
533746 | SecuritySchemeApiKey ApiKeyParams
534747 | SecuritySchemeOAuth2 OAuth2Params
535− deriving (Eq, Show)
748+ deriving (Eq, Show, Generic, Data, Typeable)
536749
537750data SecurityScheme = SecurityScheme
538751 { -- | The type of the security scheme.
@@ -540,20 +753,39 @@ data SecurityScheme = SecurityScheme
540753
541754 -- | A short description for security scheme.
542755 , _securitySchemeDescription :: Maybe Text
543− } deriving (Eq, Show, Generic)
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)
544773
545774-- | Lists the required security schemes to execute this operation.
546775-- The object can have multiple security schemes declared in it which are all required
547776-- (that is, there is a logical AND between the schemes).
548777newtype SecurityRequirement = SecurityRequirement
549− { getSecurityRequirement :: HashMap Text [Text]
550− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
780+
781+-- | Tag name.
782+type TagName = Text
551783
552784-- | Allows adding meta data to a single tag that is used by @Operation@.
553785-- It is not mandatory to have a @Tag@ per tag used there.
554786data Tag = Tag
555787 { -- | The name of the tag.
556− _tagName :: Text
788+ _tagName :: TagName
557789
558790 -- | A short description for the tag.
559791 -- GFM syntax can be used for rich text representation.
@@ -561,7 +793,12 @@ data Tag = Tag
561793
562794 -- | Additional external documentation for this tag.
563795 , _tagExternalDocs :: Maybe ExternalDocs
564− } deriving (Eq, Show)
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
565802
566803-- | Allows referencing an external resource for extended documentation.
567804data ExternalDocs = ExternalDocs
@@ -571,87 +808,145 @@ data ExternalDocs = ExternalDocs
571808
572809 -- | The URL for the target documentation.
573810 , _externalDocsUrl :: URL
574− } deriving (Eq, Show, Generic)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812+
813+instance Hashable ExternalDocs
575814
576815-- | A simple object to allow referencing other definitions in the specification.
577816-- It can be used to reference parameters and responses that are defined at the top level for reuse.
578817newtype Reference = Reference { getReference :: Text }
579− deriving (Eq, Show)
818+ deriving (Eq, Show, Data, Typeable)
580819
581820data Referenced a
582821 = Ref Reference
583822 | Inline a
584− deriving (Eq, Show)
823+ deriving (Eq, Show, Functor, Data, Typeable)
585824
586−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
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)
587834
588835-- =======================================================================
589836-- Monoid instances
590837-- =======================================================================
591838
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
592841instance Monoid Swagger where
593842 mempty = genericMempty
594− mappend = genericMappend
843+ mappend = (<>)
595844
845+instance Semigroup Info where
846+ (<>) = genericMappend
596847instance Monoid Info where
597848 mempty = genericMempty
598− mappend = genericMappend
849+ mappend = (<>)
599850
600−instance Monoid Paths where
851+instance Semigroup Contact where
852+ (<>) = genericMappend
853+instance Monoid Contact where
601854 mempty = genericMempty
602− mappend = genericMappend
855+ mappend = (<>)
603856
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
604859instance Monoid PathItem where
605860 mempty = genericMempty
606− mappend = genericMappend
861+ mappend = (<>)
607862
863+instance Semigroup Schema where
864+ (<>) = genericMappend
608865instance Monoid Schema where
609866 mempty = genericMempty
610− mappend = genericMappend
867+ mappend = (<>)
611868
612−instance Monoid (ParamSchema t i) where
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
871+instance Monoid (ParamSchema t) where
613872 mempty = genericMempty
614− mappend = genericMappend
873+ mappend = (<>)
615874
875+instance Semigroup Param where
876+ (<>) = genericMappend
616877instance Monoid Param where
617878 mempty = genericMempty
618− mappend = genericMappend
879+ mappend = (<>)
619880
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
620883instance Monoid ParamOtherSchema where
621884 mempty = genericMempty
622− mappend = genericMappend
885+ mappend = (<>)
886+
887+instance Semigroup Header where
888+ (<>) = genericMappend
889+instance Monoid Header where
890+ mempty = genericMempty
891+ mappend = (<>)
623892
893+instance Semigroup Responses where
894+ (<>) = genericMappend
624895instance Monoid Responses where
625896 mempty = genericMempty
626− mappend = genericMappend
897+ mappend = (<>)
627898
899+instance Semigroup Response where
900+ (<>) = genericMappend
628901instance Monoid Response where
629902 mempty = genericMempty
630− mappend = genericMappend
903+ mappend = (<>)
631904
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
632907instance Monoid ExternalDocs where
633908 mempty = genericMempty
634− mappend = genericMappend
909+ mappend = (<>)
635910
911+instance Semigroup Operation where
912+ (<>) = genericMappend
636913instance Monoid Operation where
637914 mempty = genericMempty
638− 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 = (<>)
639933
640934-- =======================================================================
641935-- SwaggerMonoid helper instances
642936-- =======================================================================
643937
644938instance SwaggerMonoid Info
645−instance SwaggerMonoid Paths
646939instance SwaggerMonoid PathItem
647940instance SwaggerMonoid Schema
648−instance SwaggerMonoid (ParamSchema t i)
941+instance SwaggerMonoid (ParamSchema t)
649942instance SwaggerMonoid Param
650943instance SwaggerMonoid ParamOtherSchema
651944instance SwaggerMonoid Responses
652945instance SwaggerMonoid Response
653946instance SwaggerMonoid ExternalDocs
654947instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
655950
656951instance SwaggerMonoid MimeList
657952deriving instance SwaggerMonoid URL
@@ -664,68 +959,85 @@ instance SwaggerMonoid ParamLocation where
664959 swaggerMempty = ParamQuery
665960 swaggerMappend _ y = y
666961
667−instance SwaggerMonoid (HashMap Text Schema) where
668− swaggerMempty = HashMap.empty
669− swaggerMappend = HashMap.unionWith mappend
670−
671−instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
672− swaggerMempty = HashMap.empty
673− swaggerMappend = HashMap.unionWith swaggerMappend
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963+ swaggerMempty = InsOrdHashMap.empty
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
674965
675966instance Monoid a => SwaggerMonoid (Referenced a) where
676967 swaggerMempty = Inline mempty
677− swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
678969 swaggerMappend _ y = y
679970
680−instance SwaggerMonoid (HashMap Text Param) where
681− swaggerMempty = HashMap.empty
682− 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
683976
684−instance SwaggerMonoid (HashMap Text Response) where
685− swaggerMempty = HashMap.empty
686− swaggerMappend = flip HashMap.union
977+-- =======================================================================
978+-- Simple Generic-based ToJSON instances
979+-- =======================================================================
687980
688−instance SwaggerMonoid (HashMap Text SecurityScheme) where
689− swaggerMempty = HashMap.empty
690− swaggerMappend = flip HashMap.union
981+instance ToJSON ParamLocation where
982+ toJSON = genericToJSON (jsonPrefix "Param")
691983
692−instance SwaggerMonoid (HashMap FilePath PathItem) where
693− swaggerMempty = HashMap.empty
694− swaggerMappend = HashMap.unionWith mappend
984+instance ToJSON Info where
985+ toJSON = genericToJSON (jsonPrefix "Info")
695986
696−instance SwaggerMonoid (HashMap HeaderName Header) where
697− swaggerMempty = HashMap.empty
698− swaggerMappend = flip HashMap.union
987+instance ToJSON Contact where
988+ toJSON = genericToJSON (jsonPrefix "Contact")
699989
700−instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
701− swaggerMempty = HashMap.empty
702− swaggerMappend = flip HashMap.union
990+instance ToJSON License where
991+ toJSON = genericToJSON (jsonPrefix "License")
703992
704−instance SwaggerMonoid ParamAnySchema where
705− swaggerMempty = ParamOther swaggerMempty
706− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
707− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
708− swaggerMappend _ y = y
993+instance ToJSON ApiKeyLocation where
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
995+
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")
7091010
7101011-- =======================================================================
711−-- TH derived ToJSON and FromJSON instances
1012+-- Simple Generic-based FromJSON instances
7121013-- =======================================================================
7131014
714−deriveJSON (jsonPrefix "Param") ''ParamLocation
715−deriveJSON' ''Info
716−deriveJSON' ''Contact
717−deriveJSON' ''License
718−deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
719−deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
720−deriveJSONDefault ''Scheme
721−deriveJSON' ''Tag
722−deriveJSON' ''ExternalDocs
723−
724−deriveToJSON' ''ParamSchema
725−deriveToJSON' ''Operation
726−deriveToJSON' ''Response
727−deriveToJSON' ''PathItem
728−deriveToJSON' ''Xml
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")
7291041
7301042-- =======================================================================
7311043-- Manual ToJSON instances
@@ -747,7 +1059,8 @@ instance ToJSON OAuth2Flow where
7471059 , "tokenUrl" .= tokenUrl ]
7481060
7491061instance ToJSON OAuth2Params where
750− toJSON = genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1062+ toJSON = sopSwaggerGenericToJSON
1063+ DEFINE_TOENCODING
7511064
7521065instance ToJSON SecuritySchemeType where
7531066 toJSON SecuritySchemeBasic
@@ -760,22 +1073,38 @@ instance ToJSON SecuritySchemeType where
7601073 <+> object [ "type" .= ("oauth2" :: Text) ]
7611074
7621075instance ToJSON Swagger where
763− toJSON = addVersion . genericToJSON (jsonPrefix "")
764− where
765− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
766− addVersion _ = error "impossible"
1076+ toJSON = sopSwaggerGenericToJSON
1077+ DEFINE_TOENCODING
7671078
7681079instance ToJSON SecurityScheme where
769− toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1080+ toJSON = sopSwaggerGenericToJSON
1081+ DEFINE_TOENCODING
7701082
7711083instance ToJSON Schema where
772− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1084+ toJSON = sopSwaggerGenericToJSON
1085+ DEFINE_TOENCODING
7731086
7741087instance ToJSON Header where
775− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
776−
777−instance ToJSON Items where
778− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
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 ]
7791108
7801109instance ToJSON Host where
7811110 toJSON (Host host mport) = toJSON $
@@ -783,38 +1112,53 @@ instance ToJSON Host where
7831112 Nothing -> host
7841113 Just port -> host ++ ":" ++ show port
7851114
786−instance ToJSON Paths where
787− toJSON (Paths m) = toJSON m
788−
7891115instance ToJSON MimeList where
7901116 toJSON (MimeList xs) = toJSON (map show xs)
7911117
7921118instance ToJSON Param where
793− toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1119+ toJSON = sopSwaggerGenericToJSON
1120+ DEFINE_TOENCODING
7941121
7951122instance ToJSON ParamAnySchema where
7961123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
7971124 toJSON (ParamOther s) = toJSON s
7981125
7991126instance ToJSON ParamOtherSchema where
800− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
801−
802−instance ToJSON SchemaItems where
803− toJSON (SchemaItemsObject x) = toJSON x
804− toJSON (SchemaItemsArray xs) = toJSON xs
1127+ toJSON = sopSwaggerGenericToJSON
1128+ DEFINE_TOENCODING
8051129
8061130instance ToJSON Responses where
807− toJSON (Responses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
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
8081145
8091146instance ToJSON Example where
8101147 toJSON = toJSON . Map.mapKeys show . getExample
8111148
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
1151+
8121152instance ToJSON Reference where
8131153 toJSON (Reference ref) = object [ "$ref" .= ref ]
8141154
815−instance ToJSON a => ToJSON (Referenced a) where
816− toJSON (Ref ref) = toJSON ref
817− toJSON (Inline x) = toJSON x
1155+referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
1156+referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
1157+referencedToJSON _ (Inline x) = toJSON x
1158+
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/"
8181162
8191163instance ToJSON (SwaggerType t) where
8201164 toJSON SwaggerArray = "array"
@@ -833,6 +1177,15 @@ instance ToJSON (CollectionFormat t) where
8331177 toJSON CollectionPipes = "pipes"
8341178 toJSON CollectionMulti = "multi"
8351179
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"
1184+
1185+instance ToJSON AdditionalProperties where
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
1188+
8361189-- =======================================================================
8371190-- Manual FromJSON instances
8381191-- =======================================================================
@@ -851,7 +1204,7 @@ instance FromJSON OAuth2Flow where
8511204 parseJSON _ = empty
8521205
8531206instance FromJSON OAuth2Params where
854− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1207+ parseJSON = sopSwaggerGenericParseJSON
8551208
8561209instance FromJSON SecuritySchemeType where
8571210 parseJSON js@(Object o) = do
@@ -864,53 +1217,65 @@ instance FromJSON SecuritySchemeType where
8641217 parseJSON _ = empty
8651218
8661219instance FromJSON Swagger where
867− parseJSON js@(Object o) = do
868− (version :: Text) <- o .: "swagger"
869− when (version /= "2.0") empty
870− (genericParseJSON (jsonPrefix "")
871− `withDefaults` [ "consumes" .= (mempty :: MimeList)
872− , "produces" .= (mempty :: MimeList)
873− , "security" .= ([] :: [SecurityRequirement])
874− , "tags" .= ([] :: [Tag])
875− , "definitions" .= (mempty :: HashMap Text Schema)
876− , "parameters" .= (mempty :: HashMap Text Param)
877− , "responses" .= (mempty :: HashMap Text Response)
878− , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
879− ] ) js
880− parseJSON _ = empty
1220+ parseJSON = sopSwaggerGenericParseJSON
8811221
8821222instance FromJSON SecurityScheme where
883− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1223+ parseJSON = sopSwaggerGenericParseJSON
8841224
8851225instance FromJSON Schema where
886− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
887− `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
888− , "required" .= ([] :: [ParamName]) ]
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
8891233
8901234instance FromJSON Header where
891− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
892−
893−instance FromJSON Items where
894− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
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
1263+ parseJSON _ = empty
8951264
8961265instance FromJSON Host where
897− parseJSON (String s) =
898− case fromInteger <$> readMaybe portStr of
899− Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
900− mport -> pure $ Host host mport
901− where
902− (hostText, portText) = Text.breakOn ":" s
903− [host, portStr] = map Text.unpack [hostText, portText]
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 ++ "'"
9041272 parseJSON _ = empty
9051273
906−instance FromJSON Paths where
907− parseJSON js = Paths <$> parseJSON js
908−
9091274instance FromJSON MimeList where
9101275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
9111276
9121277instance FromJSON Param where
913− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1278+ parseJSON = sopSwaggerGenericParseJSON
9141279
9151280instance FromJSON ParamAnySchema where
9161281 parseJSON js@(Object o) = do
@@ -923,17 +1288,12 @@ instance FromJSON ParamAnySchema where
9231288 parseJSON _ = empty
9241289
9251290instance FromJSON ParamOtherSchema where
926− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
927−
928−instance FromJSON SchemaItems where
929− parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
930− parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
931− parseJSON _ = empty
1291+ parseJSON = sopSwaggerGenericParseJSON
9321292
9331293instance FromJSON Responses where
9341294 parseJSON (Object o) = Responses
9351295 <$> o .:? "default"
936− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
9371297 parseJSON _ = empty
9381298
9391299instance FromJSON Example where
@@ -942,46 +1302,126 @@ instance FromJSON Example where
9421302 pure $ Example (Map.mapKeys fromString m)
9431303
9441304instance FromJSON Response where
945− parseJSON = genericParseJSON (jsonPrefix "response")
946− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1305+ parseJSON = sopSwaggerGenericParseJSON
9471306
9481307instance FromJSON Operation where
949− parseJSON = genericParseJSON (jsonPrefix "operation")
950− `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1308+ parseJSON = sopSwaggerGenericParseJSON
9511309
9521310instance FromJSON PathItem where
953− parseJSON = genericParseJSON (jsonPrefix "pathItem")
954− `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1311+ parseJSON = sopSwaggerGenericParseJSON
1312+
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
9551315
9561316instance FromJSON Reference where
9571317 parseJSON (Object o) = Reference <$> o .: "$ref"
9581318 parseJSON _ = empty
9591319
960−instance FromJSON a => FromJSON (Referenced a) where
961− parseJSON js
962− = Ref <$> parseJSON js
963− <|> Inline <$> parseJSON js
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/"
9641336
9651337instance FromJSON Xml where
9661338 parseJSON = genericParseJSON (jsonPrefix "xml")
9671339
968−instance FromJSON (SwaggerType Schema) where
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
9691341 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
9701342
971−instance FromJSON (SwaggerType ParamOtherSchema) where
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
9721344 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
9731345
974−instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
9751347 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
9761348
977−instance FromJSON (CollectionFormat Param) where
978− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
979−
980−instance FromJSON (CollectionFormat Items) where
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
9811350 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
9821351
983−-- NOTE: The constraint @FromJSON (SwaggerType t)@ is necessary here!
984−-- Without the constraint the general instance will be used
985−-- that only accepts common types (i.e. NOT object, null or file).
986−instance (FromJSON (SwaggerType t), FromJSON i) => FromJSON (ParamSchema t i) where
987− parseJSON = genericParseJSON (jsonPrefix "ParamSchema")
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