@@ -1,3 +1,7 @@
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
1{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveGeneric #-}
2{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE DeriveTraversable #-}
3{-# LANGUAGE FlexibleContexts #-}
7{-# LANGUAGE FlexibleContexts #-}
@@ -9,88 +13,128 @@
9{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE StandaloneDeriving #-}
14{-# LANGUAGE StandaloneDeriving #-}
11{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
21+#include "overlapping-compat.h"
12module Data.Swagger.Internal where
22module Data.Swagger.Internal where
27+import Control.Lens ((&), (.~), (?~))
14import Control.Applicative
28import Control.Applicative
16import Data.Aeson
29import Data.Aeson
17−import Data.Aeson.TH (deriveJSON)
30+import qualified Data.Aeson.Types as JSON
18−import Data.HashMap.Strict (HashMap)
31+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32+import Data.Hashable (Hashable)
19import qualified Data.HashMap.Strict as HashMap
33import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
20import Data.Map (Map)
35import Data.Map (Map)
21import qualified Data.Map as Map
36import qualified Data.Map as Map
22−import Data.Monoid
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
23import Data.Scientific (Scientific)
39import Data.Scientific (Scientific)
24−import Data.String (fromString)
40+import Data.String (IsString(..))
25import Data.Text (Text)
41import Data.Text (Text)
26import qualified Data.Text as Text
42import qualified Data.Text as Text
27import GHC.Generics (Generic)
43import GHC.Generics (Generic)
28−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
29import Network.HTTP.Media (MediaType)
45import Network.HTTP.Media (MediaType)
30import Text.Read (readMaybe)
46import Text.Read (readMaybe)
48+import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
51+import Generics.SOP.TH (deriveGeneric)
52+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53+ ,sopSwaggerGenericToJSONWithOpts
54+ ,sopSwaggerGenericParseJSON
55+ ,HasSwaggerAesonOptions(..)
56+ ,AesonDefaultValue(..)
57+ ,mkSwaggerAesonOptions
32import Data.Swagger.Internal.Utils
60import Data.Swagger.Internal.Utils
62+#if MIN_VERSION_aeson(0,10,0)
63+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64+#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
66+#define DEFINE_TOENCODING
70+-- >>> :seti -XDataKinds
71+-- >>> import Data.Aeson
73+-- | A list of definitions that can be used in references.
74+type Definitions = InsOrdHashMap Text
34-- | This is the root document object for the API specification.
76-- | This is the root document object for the API specification.
35data Swagger = Swagger
77data Swagger = Swagger
36 { -- | Provides metadata about the API.
78 { -- | Provides metadata about the API.
37 -- The metadata can be used by the clients if needed.
79 -- The metadata can be used by the clients if needed.
38− _info :: Info
80+ _swaggerInfo :: Info
40 -- | The host (name or ip) serving the API. It MAY include a port.
82 -- | The host (name or ip) serving the API. It MAY include a port.
41 -- If the host is not included, the host serving the documentation is to be used (including the port).
83 -- If the host is not included, the host serving the documentation is to be used (including the port).
42− , _host :: Maybe Host
84+ , _swaggerHost :: Maybe Host
44 -- | The base path on which the API is served, which is relative to the host.
86 -- | The base path on which the API is served, which is relative to the host.
45 -- If it is not included, the API is served directly under the host.
87 -- If it is not included, the API is served directly under the host.
46 -- The value MUST start with a leading slash (/).
88 -- The value MUST start with a leading slash (/).
47− , _basePath :: Maybe FilePath
89+ , _swaggerBasePath :: Maybe FilePath
49 -- | The transfer protocol of the API.
91 -- | The transfer protocol of the API.
50 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
92 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
51− , _schemes :: Maybe [Scheme]
93+ , _swaggerSchemes :: Maybe [Scheme]
53 -- | A list of MIME types the APIs can consume.
95 -- | A list of MIME types the APIs can consume.
54 -- This is global to all APIs but can be overridden on specific API calls.
96 -- This is global to all APIs but can be overridden on specific API calls.
55− , _consumes :: MimeList
97+ , _swaggerConsumes :: MimeList
57 -- | A list of MIME types the APIs can produce.
99 -- | A list of MIME types the APIs can produce.
58− -- This is global to all APIs but can be overridden on specific API calls.
100+ -- This is global to all APIs but can be overridden on specific API calls.
59− , _produces :: MimeList
101+ , _swaggerProduces :: MimeList
61 -- | The available paths and operations for the API.
103 -- | 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
64 -- | An object to hold data types produced and consumed by operations.
108 -- | An object to hold data types produced and consumed by operations.
65− , _definitions :: HashMap Text Schema
109+ , _swaggerDefinitions :: Definitions Schema
67 -- | An object to hold parameters that can be used across operations.
111 -- | An object to hold parameters that can be used across operations.
68 -- This property does not define global parameters for all operations.
112 -- This property does not define global parameters for all operations.
69− , _parameters :: HashMap Text Param
113+ , _swaggerParameters :: Definitions Param
71 -- | An object to hold responses that can be used across operations.
115 -- | An object to hold responses that can be used across operations.
72 -- This property does not define global responses for all operations.
116 -- This property does not define global responses for all operations.
73− , _responses :: HashMap Text Response
117+ , _swaggerResponses :: Definitions Response
75 -- | Security scheme definitions that can be used across the specification.
119 -- | Security scheme definitions that can be used across the specification.
76− , _securityDefinitions :: HashMap Text SecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
78 -- | A declaration of which security schemes are applied for the API as a whole.
122 -- | A declaration of which security schemes are applied for the API as a whole.
79 -- The list of values describes alternative security schemes that can be used
123 -- The list of values describes alternative security schemes that can be used
80 -- (that is, there is a logical OR between the security requirements).
124 -- (that is, there is a logical OR between the security requirements).
81 -- Individual operations can override this definition.
125 -- Individual operations can override this definition.
82− , _security :: [SecurityRequirement]
126+ , _swaggerSecurity :: [SecurityRequirement]
84 -- | A list of tags used by the specification with additional metadata.
128 -- | A list of tags used by the specification with additional metadata.
85 -- The order of the tags can be used to reflect on their order by the parsing tools.
129 -- The order of the tags can be used to reflect on their order by the parsing tools.
86 -- Not all tags that are used by the Operation Object must be declared.
130 -- Not all tags that are used by the Operation Object must be declared.
87 -- The tags that are not declared may be organized randomly or based on the tools' logic.
131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
88 -- Each tag name in the list MUST be unique.
132 -- Each tag name in the list MUST be unique.
89− , _tags :: [Tag]
133+ , _swaggerTags :: InsOrdHashSet Tag
91 -- | Additional external documentation.
135 -- | Additional external documentation.
92− , _externalDocs :: Maybe ExternalDocs
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
93− } deriving (Eq, Show, Generic)
137+ } deriving (Eq, Show, Generic, Data, Typeable)
95-- | The object provides metadata about the API.
139-- | The object provides metadata about the API.
96-- The metadata can be used by the clients if needed,
140-- The metadata can be used by the clients if needed,
@@ -115,7 +159,7 @@ data Info = Info
115 -- | Provides the version of the application API
159 -- | Provides the version of the application API
116 -- (not to be confused with the specification version).
160 -- (not to be confused with the specification version).
117 , _infoVersion :: Text
161 , _infoVersion :: Text
118− } deriving (Eq, Show, Generic)
162+ } deriving (Eq, Show, Generic, Data, Typeable)
120-- | Contact information for the exposed API.
164-- | Contact information for the exposed API.
121data Contact = Contact
165data Contact = Contact
@@ -127,7 +171,7 @@ data Contact = Contact
128 -- | The email address of the contact person/organization.
172 -- | The email address of the contact person/organization.
129 , _contactEmail :: Maybe Text
173 , _contactEmail :: Maybe Text
130− } deriving (Eq, Show)
174+ } deriving (Eq, Show, Generic, Data, Typeable)
132-- | License information for the exposed API.
176-- | License information for the exposed API.
133data License = License
177data License = License
@@ -136,13 +180,32 @@ data License = License
137 -- | A URL to the license used for the API.
181 -- | A URL to the license used for the API.
138 , _licenseUrl :: Maybe URL
182 , _licenseUrl :: Maybe URL
139− } deriving (Eq, Show)
183+ } deriving (Eq, Show, Generic, Data, Typeable)
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
141-- | The host (name or ip) serving the API. It MAY include a port.
188-- | The host (name or ip) serving the API. It MAY include a port.
142data Host = Host
189data Host = Host
143 { _hostName :: HostName -- ^ Host name.
190 { _hostName :: HostName -- ^ Host name.
144 , _hostPort :: Maybe PortNumber -- ^ Optional port.
191 , _hostPort :: Maybe PortNumber -- ^ Optional port.
145− } deriving (Eq, Show)
192+ } deriving (Eq, Show, Generic, Typeable)
194+instance IsString Host where
195+ fromString s = Host s Nothing
198+hostConstr = mkConstr hostDataType "Host" [] Prefix
200+hostDataType :: DataType
201+hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
203+instance Data Host where
204+ gunfold k z c = case constrIndex c of
205+ 1 -> k (k (z (\name mport -> Host name (fromInteger <$> mport))))
206+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Host."
207+ toConstr (Host _ _) = hostConstr
208+ dataTypeOf _ = hostDataType
147-- | The transfer protocol of the API.
210-- | The transfer protocol of the API.
148data Scheme
211data Scheme
@@ -150,14 +213,7 @@ data Scheme
153− deriving (Eq, Show)
216+ deriving (Eq, Show, Generic, Data, Typeable)
155−-- | The available paths and operations for the API.
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)
162-- | Describes the operations available on a single path.
218-- | Describes the operations available on a single path.
163-- A @'PathItem'@ may be empty, due to ACL constraints.
219-- A @'PathItem'@ may be empty, due to ACL constraints.
@@ -190,13 +246,13 @@ data PathItem = PathItem
190 -- The list MUST NOT include duplicated parameters.
246 -- The list MUST NOT include duplicated parameters.
191 -- A unique parameter is defined by a combination of a name and location.
247 -- A unique parameter is defined by a combination of a name and location.
192 , _pathItemParameters :: [Referenced Param]
248 , _pathItemParameters :: [Referenced Param]
193− } deriving (Eq, Show, Generic)
249+ } deriving (Eq, Show, Generic, Data, Typeable)
195-- | Describes a single API operation on a path.
251-- | Describes a single API operation on a path.
196data Operation = Operation
252data Operation = Operation
197 { -- | A list of tags for API documentation control.
253 { -- | A list of tags for API documentation control.
198 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
199− _operationTags :: [Text]
255+ _operationTags :: InsOrdHashSet TagName
201 -- | A short summary of what the operation does.
257 -- | A short summary of what the operation does.
202 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -250,10 +306,23 @@ data Operation = Operation
250 -- This definition overrides any declared top-level security.
306 -- This definition overrides any declared top-level security.
251 -- To remove a top-level security declaration, @Just []@ can be used.
307 -- To remove a top-level security declaration, @Just []@ can be used.
252 , _operationSecurity :: [SecurityRequirement]
308 , _operationSecurity :: [SecurityRequirement]
253− } deriving (Eq, Show, Generic)
309+ } deriving (Eq, Show, Generic, Data, Typeable)
255newtype MimeList = MimeList { getMimeList :: [MediaType] }
311newtype MimeList = MimeList { getMimeList :: [MediaType] }
256− deriving (Eq, Show, Monoid)
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
314+mimeListConstr :: Constr
315+mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
317+mimeListDataType :: DataType
318+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
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
258-- | Describes a single operation parameter.
327-- | Describes a single operation parameter.
259-- A unique parameter is defined by a combination of a name and location.
328-- A unique parameter is defined by a combination of a name and location.
@@ -274,12 +343,12 @@ data Param = Param
275 -- | Parameter schema.
344 -- | Parameter schema.
276 , _paramSchema :: ParamAnySchema
345 , _paramSchema :: ParamAnySchema
277− } deriving (Eq, Show, Generic)
346+ } deriving (Eq, Show, Generic, Data, Typeable)
279data ParamAnySchema
348data ParamAnySchema
280 = ParamBody (Referenced Schema)
349 = ParamBody (Referenced Schema)
281 | ParamOther ParamOtherSchema
350 | ParamOther ParamOtherSchema
282− deriving (Eq, Show)
351+ deriving (Eq, Show, Generic, Data, Typeable)
284data ParamOtherSchema = ParamOtherSchema
353data ParamOtherSchema = ParamOtherSchema
285 { -- | The location of the parameter.
354 { -- | The location of the parameter.
@@ -291,12 +360,92 @@ data ParamOtherSchema = ParamOtherSchema
291 -- Default value is @False@.
360 -- Default value is @False@.
292 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
294− -- | Determines the format of the array if @'ParamArray'@ is used.
295− -- Default value is csv.
296− , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
298− , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema Items
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
299− } deriving (Eq, Show, Generic)
364+ } deriving (Eq, Show, Generic, Typeable, Data)
366+-- | Items for @'SwaggerArray'@ schemas.
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>.
373+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
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
382+deriving instance Eq (SwaggerItems t)
383+deriving instance Show (SwaggerItems t)
384+--deriving instance Typeable (SwaggerItems t)
386+swaggerItemsPrimitiveConstr :: Constr
387+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
395+swaggerItemsDataType :: DataType
396+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
398+-- Note: unfortunately we have to write these Data instances by hand,
399+-- to get better contexts / avoid duplicate name when using standalone deriving
401+instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
402+ -- TODO: define gfoldl
403+ gunfold k z c = case constrIndex c of
404+ 1 -> k (k (z SwaggerItemsPrimitive))
405+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406+ toConstr _ = swaggerItemsPrimitiveConstr
407+ dataTypeOf _ = swaggerItemsDataType
409+-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
410+instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411+ -- TODO: define gfoldl
412+ gunfold k z c = case constrIndex c of
413+ 1 -> k (k (z SwaggerItemsPrimitive))
414+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415+ toConstr _ = swaggerItemsPrimitiveConstr
416+ dataTypeOf _ = swaggerItemsDataType
418+instance Data (SwaggerItems 'SwaggerKindSchema) where
419+ gfoldl _ _ (SwaggerItemsPrimitive _ _) = error $ " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
420+ gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
421+ gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
423+ gunfold k z c = case constrIndex c of
424+ 2 -> k (z SwaggerItemsObject)
425+ 3 -> k (z SwaggerItemsArray)
426+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
428+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
432+ dataTypeOf _ = swaggerItemsDataType
434+-- | Type used as a kind to avoid overlapping instances.
436+ = SwaggerKindNormal t
437+ | SwaggerKindParamOtherSchema
441+deriving instance Typeable 'SwaggerKindNormal
442+deriving instance Typeable 'SwaggerKindParamOtherSchema
443+deriving instance Typeable 'SwaggerKindSchema
445+type family SwaggerKindType (k :: SwaggerKind *) :: *
446+type instance SwaggerKindType ('SwaggerKindNormal t) = t
447+type instance SwaggerKindType 'SwaggerKindSchema = Schema
448+type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
301data SwaggerType t where
450data SwaggerType t where
302 SwaggerString :: SwaggerType t
451 SwaggerString :: SwaggerType t
@@ -304,13 +453,48 @@ data SwaggerType t where
304 SwaggerInteger :: SwaggerType t
453 SwaggerInteger :: SwaggerType t
305 SwaggerBoolean :: SwaggerType t
454 SwaggerBoolean :: SwaggerType t
306 SwaggerArray :: SwaggerType t
455 SwaggerArray :: SwaggerType t
307− SwaggerFile :: SwaggerType ParamOtherSchema
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
308− SwaggerNull :: SwaggerType Schema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
309− SwaggerObject :: SwaggerType Schema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
311deriving instance Eq (SwaggerType t)
461deriving instance Eq (SwaggerType t)
312deriving instance Show (SwaggerType t)
462deriving instance Show (SwaggerType t)
464+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
470+swaggerCommonTypes :: [SwaggerType k]
471+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
479+swaggerTypeConstrs :: [Constr]
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485+ toConstr = swaggerTypeConstr
486+ dataTypeOf = swaggerTypeDataType
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490+ toConstr = swaggerTypeConstr
491+ dataTypeOf = swaggerTypeDataType
493+instance Data (SwaggerType 'SwaggerKindSchema) where
494+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495+ toConstr = swaggerTypeConstr
496+ dataTypeOf = swaggerTypeDataType
314data ParamLocation
498data ParamLocation
315 = -- | Parameters that are appended to the URL.
499 = -- | Parameters that are appended to the URL.
316 -- For example, in @/items?id=###@, the query parameter is @id@.
500 -- For example, in @/items?id=###@, the query parameter is @id@.
@@ -329,7 +513,7 @@ data ParamLocation
329 -- Form parameters have a different format based on the content-type used
513 -- Form parameters have a different format based on the content-type used
330 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
514 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
331 | ParamFormData
515 | ParamFormData
332− deriving (Eq, Show)
516+ deriving (Eq, Show, Generic, Data, Typeable)
334type Format = Text
518type Format = Text
@@ -346,11 +530,29 @@ data CollectionFormat t where
346 -- Corresponds to multiple parameter instances
530 -- Corresponds to multiple parameter instances
347 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
531 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
348 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
532 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
349− CollectionMulti :: CollectionFormat Param
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
351deriving instance Eq (CollectionFormat t)
536deriving instance Eq (CollectionFormat t)
352deriving instance Show (CollectionFormat t)
537deriving instance Show (CollectionFormat t)
539+collectionFormatConstr :: CollectionFormat t -> Constr
540+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
542+collectionFormatDataType :: DataType
543+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
544+ map collectionFormatConstr collectionCommonFormats
546+collectionCommonFormats :: [CollectionFormat t]
547+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551+ toConstr = collectionFormatConstr
552+ dataTypeOf _ = collectionFormatDataType
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
354type ParamName = Text
556type ParamName = Text
356data Schema = Schema
558data Schema = Schema
@@ -358,9 +560,9 @@ data Schema = Schema
358 , _schemaDescription :: Maybe Text
560 , _schemaDescription :: Maybe Text
359 , _schemaRequired :: [ParamName]
561 , _schemaRequired :: [ParamName]
361− , _schemaAllOf :: Maybe [Schema]
563+ , _schemaAllOf :: Maybe [Referenced Schema]
362− , _schemaProperties :: HashMap Text (Referenced Schema)
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
363− , _schemaAdditionalProperties :: Maybe Schema
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
365 , _schemaDiscriminator :: Maybe Text
567 , _schemaDiscriminator :: Maybe Text
366 , _schemaReadOnly :: Maybe Bool
568 , _schemaReadOnly :: Maybe Bool
@@ -371,15 +573,20 @@ data Schema = Schema
371 , _schemaMaxProperties :: Maybe Integer
573 , _schemaMaxProperties :: Maybe Integer
372 , _schemaMinProperties :: Maybe Integer
574 , _schemaMinProperties :: Maybe Integer
374− , _schemaParamSchema :: ParamSchema Schema SchemaItems
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
577+ } deriving (Eq, Show, Generic, Data, Typeable)
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
375− } deriving (Eq, Show, Generic)
584+ } deriving (Eq, Show, Generic, Data, Typeable)
377−data SchemaItems
586+-- | Regex pattern for @string@ type.
378− = SchemaItemsObject (Referenced Schema)
587+type Pattern = Text
379− | SchemaItemsArray [Referenced Schema]
382−data ParamSchema t items = ParamSchema
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
383 { -- | Declares the value of the parameter that the server will use if none is provided,
590 { -- | Declares the value of the parameter that the server will use if none is provided,
384 -- for example a @"count"@ to control the number of results per page might default to @100@
591 -- for example a @"count"@ to control the number of results per page might default to @100@
385 -- if not supplied by the client in the request.
592 -- if not supplied by the client in the request.
@@ -387,26 +594,28 @@ data ParamSchema t items = ParamSchema
387 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
388 _paramSchemaDefault :: Maybe Value
595 _paramSchemaDefault :: Maybe Value
390− , _paramSchemaType :: SwaggerType t
597+ , _paramSchemaType :: Maybe (SwaggerType t)
391 , _paramSchemaFormat :: Maybe Format
598 , _paramSchemaFormat :: Maybe Format
392− , _paramSchemaItems :: Maybe items
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
393 , _paramSchemaMaximum :: Maybe Scientific
600 , _paramSchemaMaximum :: Maybe Scientific
394 , _paramSchemaExclusiveMaximum :: Maybe Bool
601 , _paramSchemaExclusiveMaximum :: Maybe Bool
395 , _paramSchemaMinimum :: Maybe Scientific
602 , _paramSchemaMinimum :: Maybe Scientific
396 , _paramSchemaExclusiveMinimum :: Maybe Bool
603 , _paramSchemaExclusiveMinimum :: Maybe Bool
397 , _paramSchemaMaxLength :: Maybe Integer
604 , _paramSchemaMaxLength :: Maybe Integer
398 , _paramSchemaMinLength :: Maybe Integer
605 , _paramSchemaMinLength :: Maybe Integer
399− , _paramSchemaPattern :: Maybe Text
606+ , _paramSchemaPattern :: Maybe Pattern
400 , _paramSchemaMaxItems :: Maybe Integer
607 , _paramSchemaMaxItems :: Maybe Integer
401 , _paramSchemaMinItems :: Maybe Integer
608 , _paramSchemaMinItems :: Maybe Integer
402 , _paramSchemaUniqueItems :: Maybe Bool
609 , _paramSchemaUniqueItems :: Maybe Bool
403 , _paramSchemaEnum :: Maybe [Value]
610 , _paramSchemaEnum :: Maybe [Value]
404 , _paramSchemaMultipleOf :: Maybe Scientific
611 , _paramSchemaMultipleOf :: Maybe Scientific
405− } deriving (Eq, Show, Generic)
612+ } deriving (Eq, Show, Generic, Typeable)
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
407data Xml = Xml
616data Xml = Xml
408 { -- | Replaces the name of the element/attribute used for the described schema property.
617 { -- | Replaces the name of the element/attribute used for the described schema property.
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.
410 -- When defined alongside type being array (outside the items),
619 -- When defined alongside type being array (outside the items),
411 -- it will affect the wrapping element and only if wrapped is true.
620 -- it will affect the wrapping element and only if wrapped is true.
412 -- If wrapped is false, it will be ignored.
621 -- If wrapped is false, it will be ignored.
@@ -430,15 +639,7 @@ data Xml = Xml
430 -- Default value is @False@.
639 -- Default value is @False@.
431 -- The definition takes effect only when defined alongside type being array (outside the items).
640 -- The definition takes effect only when defined alongside type being array (outside the items).
432 , _xmlWrapped :: Maybe Bool
641 , _xmlWrapped :: Maybe Bool
433− } deriving (Eq, Show, Generic)
642+ } deriving (Eq, Show, Generic, Data, Typeable)
436− { -- | Determines the format of the array if type array is used.
437− -- Default value is @'ItemsCollectionCSV'@.
438− _itemsCollectionFormat :: Maybe (CollectionFormat Items)
440− , _itemsParamSchema :: ParamSchema Items Items
441− } deriving (Eq, Show, Generic)
443-- | A container for the expected responses of an operation.
644-- | A container for the expected responses of an operation.
444-- The container maps a HTTP response code to the expected response.
645-- The container maps a HTTP response code to the expected response.
@@ -452,8 +653,8 @@ data Responses = Responses
453 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
454 -- Describes the expected response for those HTTP status codes.
655 -- Describes the expected response for those HTTP status codes.
455− , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
456− } deriving (Eq, Show, Generic)
657+ } deriving (Eq, Show, Generic, Data, Typeable)
458type HttpStatusCode = Int
659type HttpStatusCode = Int
@@ -471,11 +672,14 @@ data Response = Response
471 , _responseSchema :: Maybe (Referenced Schema)
672 , _responseSchema :: Maybe (Referenced Schema)
473 -- | A list of headers that are sent with the response.
674 -- | A list of headers that are sent with the response.
474− , _responseHeaders :: HashMap HeaderName Header
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
476 -- | An example of the response message.
677 -- | An example of the response message.
477 , _responseExamples :: Maybe Example
678 , _responseExamples :: Maybe Example
478− } deriving (Eq, Show, Generic)
679+ } deriving (Eq, Show, Generic, Data, Typeable)
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
480type HeaderName = Text
684type HeaderName = Text
@@ -483,21 +687,30 @@ data Header = Header
483 { -- | A short description of the header.
687 { -- | A short description of the header.
484 _headerDescription :: Maybe Text
688 _headerDescription :: Maybe Text
486− -- | Determines the format of the array if type array is used.
487− -- Default value is @'ItemsCollectionCSV'@.
488− , _headerCollectionFormat :: Maybe (CollectionFormat Items)
490− , _headerParamSchema :: ParamSchema Header Items
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
491− } deriving (Eq, Show, Generic)
691+ } deriving (Eq, Show, Generic, Data, Typeable)
493data Example = Example { getExample :: Map MediaType Value }
693data Example = Example { getExample :: Map MediaType Value }
494− deriving (Eq, Show)
694+ deriving (Eq, Show, Generic, Typeable)
696+exampleConstr :: Constr
697+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
699+exampleDataType :: DataType
700+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
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
496-- | The location of the API key.
709-- | The location of the API key.
497data ApiKeyLocation
710data ApiKeyLocation
498 = ApiKeyQuery
711 = ApiKeyQuery
499 | ApiKeyHeader
712 | ApiKeyHeader
500− deriving (Eq, Show)
713+ deriving (Eq, Show, Generic, Data, Typeable)
502data ApiKeyParams = ApiKeyParams
715data ApiKeyParams = ApiKeyParams
503 { -- | The name of the header or query parameter to be used.
716 { -- | The name of the header or query parameter to be used.
@@ -505,7 +718,7 @@ data ApiKeyParams = ApiKeyParams
506 -- | The location of the API key.
719 -- | The location of the API key.
507 , _apiKeyIn :: ApiKeyLocation
720 , _apiKeyIn :: ApiKeyLocation
508− } deriving (Eq, Show)
721+ } deriving (Eq, Show, Generic, Data, Typeable)
510-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
511type AuthorizationURL = Text
724type AuthorizationURL = Text
@@ -518,21 +731,21 @@ data OAuth2Flow
518 | OAuth2Password TokenURL
731 | OAuth2Password TokenURL
519 | OAuth2Application TokenURL
732 | OAuth2Application TokenURL
520 | OAuth2AccessCode AuthorizationURL TokenURL
733 | OAuth2AccessCode AuthorizationURL TokenURL
521− deriving (Eq, Show)
734+ deriving (Eq, Show, Generic, Data, Typeable)
523data OAuth2Params = OAuth2Params
736data OAuth2Params = OAuth2Params
524 { -- | The flow used by the OAuth2 security scheme.
737 { -- | The flow used by the OAuth2 security scheme.
525 _oauth2Flow :: OAuth2Flow
738 _oauth2Flow :: OAuth2Flow
527 -- | The available scopes for the OAuth2 security scheme.
740 -- | The available scopes for the OAuth2 security scheme.
528− , _oauth2Scopes :: HashMap Text Text
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
529− } deriving (Eq, Show, Generic)
742+ } deriving (Eq, Show, Generic, Data, Typeable)
531data SecuritySchemeType
744data SecuritySchemeType
532 = SecuritySchemeBasic
745 = SecuritySchemeBasic
533 | SecuritySchemeApiKey ApiKeyParams
746 | SecuritySchemeApiKey ApiKeyParams
534 | SecuritySchemeOAuth2 OAuth2Params
747 | SecuritySchemeOAuth2 OAuth2Params
535− deriving (Eq, Show)
748+ deriving (Eq, Show, Generic, Data, Typeable)
537data SecurityScheme = SecurityScheme
750data SecurityScheme = SecurityScheme
538 { -- | The type of the security scheme.
751 { -- | The type of the security scheme.
@@ -540,20 +753,39 @@ data SecurityScheme = SecurityScheme
541 -- | A short description for security scheme.
754 -- | A short description for security scheme.
542 , _securitySchemeDescription :: Maybe Text
755 , _securitySchemeDescription :: Maybe Text
543− } deriving (Eq, Show, Generic)
756+ } deriving (Eq, Show, Generic, Data, Typeable)
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
768+mergeSecurityScheme s1 _ = s1
770+newtype SecurityDefinitions
771+ = SecurityDefinitions (Definitions SecurityScheme)
772+ deriving (Eq, Show, Generic, Data, Typeable)
545-- | Lists the required security schemes to execute this operation.
774-- | Lists the required security schemes to execute this operation.
546-- The object can have multiple security schemes declared in it which are all required
775-- The object can have multiple security schemes declared in it which are all required
547-- (that is, there is a logical AND between the schemes).
776-- (that is, there is a logical AND between the schemes).
548newtype SecurityRequirement = SecurityRequirement
777newtype SecurityRequirement = SecurityRequirement
549− { getSecurityRequirement :: HashMap Text [Text]
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
550− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
552-- | Allows adding meta data to a single tag that is used by @Operation@.
784-- | Allows adding meta data to a single tag that is used by @Operation@.
553-- It is not mandatory to have a @Tag@ per tag used there.
785-- It is not mandatory to have a @Tag@ per tag used there.
554data Tag = Tag
786data Tag = Tag
555 { -- | The name of the tag.
787 { -- | The name of the tag.
556− _tagName :: Text
788+ _tagName :: TagName
558 -- | A short description for the tag.
790 -- | A short description for the tag.
559 -- GFM syntax can be used for rich text representation.
791 -- GFM syntax can be used for rich text representation.
@@ -561,7 +793,12 @@ data Tag = Tag
562 -- | Additional external documentation for this tag.
794 -- | Additional external documentation for this tag.
563 , _tagExternalDocs :: Maybe ExternalDocs
795 , _tagExternalDocs :: Maybe ExternalDocs
564− } deriving (Eq, Show)
796+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
798+instance Hashable Tag
800+instance IsString Tag where
801+ fromString s = Tag (fromString s) Nothing Nothing
566-- | Allows referencing an external resource for extended documentation.
803-- | Allows referencing an external resource for extended documentation.
567data ExternalDocs = ExternalDocs
804data ExternalDocs = ExternalDocs
@@ -571,87 +808,145 @@ data ExternalDocs = ExternalDocs
572 -- | The URL for the target documentation.
809 -- | The URL for the target documentation.
573 , _externalDocsUrl :: URL
810 , _externalDocsUrl :: URL
574− } deriving (Eq, Show, Generic)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
813+instance Hashable ExternalDocs
576-- | A simple object to allow referencing other definitions in the specification.
815-- | A simple object to allow referencing other definitions in the specification.
577-- It can be used to reference parameters and responses that are defined at the top level for reuse.
816-- It can be used to reference parameters and responses that are defined at the top level for reuse.
578newtype Reference = Reference { getReference :: Text }
817newtype Reference = Reference { getReference :: Text }
579− deriving (Eq, Show)
818+ deriving (Eq, Show, Data, Typeable)
581data Referenced a
820data Referenced a
582 = Ref Reference
821 = Ref Reference
583 | Inline a
822 | Inline a
584− deriving (Eq, Show)
823+ deriving (Eq, Show, Functor, Data, Typeable)
825+instance IsString a => IsString (Referenced a) where
826+ fromString = Inline . fromString
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
586−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
588-- =======================================================================
835-- =======================================================================
589-- Monoid instances
836-- Monoid instances
590-- =======================================================================
837-- =======================================================================
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
592instance Monoid Swagger where
841instance Monoid Swagger where
593 mempty = genericMempty
842 mempty = genericMempty
594− mappend = genericMappend
843+ mappend = (<>)
845+instance Semigroup Info where
846+ (<>) = genericMappend
596instance Monoid Info where
847instance Monoid Info where
597 mempty = genericMempty
848 mempty = genericMempty
598− mappend = genericMappend
849+ mappend = (<>)
851+instance Semigroup Contact where
852+ (<>) = genericMappend
600−instance Monoid Paths where
853+instance Monoid Contact where
601 mempty = genericMempty
854 mempty = genericMempty
602− mappend = genericMappend
855+ mappend = (<>)
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
604instance Monoid PathItem where
859instance Monoid PathItem where
605 mempty = genericMempty
860 mempty = genericMempty
606− mappend = genericMappend
861+ mappend = (<>)
863+instance Semigroup Schema where
864+ (<>) = genericMappend
608instance Monoid Schema where
865instance Monoid Schema where
609 mempty = genericMempty
866 mempty = genericMempty
610− mappend = genericMappend
867+ mappend = (<>)
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
612−instance Monoid (ParamSchema t i) where
871+instance Monoid (ParamSchema t) where
613 mempty = genericMempty
872 mempty = genericMempty
614− mappend = genericMappend
873+ mappend = (<>)
875+instance Semigroup Param where
876+ (<>) = genericMappend
616instance Monoid Param where
877instance Monoid Param where
617 mempty = genericMempty
878 mempty = genericMempty
618− mappend = genericMappend
879+ mappend = (<>)
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
620instance Monoid ParamOtherSchema where
883instance Monoid ParamOtherSchema where
621 mempty = genericMempty
884 mempty = genericMempty
622− mappend = genericMappend
885+ mappend = (<>)
887+instance Semigroup Header where
888+ (<>) = genericMappend
889+instance Monoid Header where
890+ mempty = genericMempty
893+instance Semigroup Responses where
894+ (<>) = genericMappend
624instance Monoid Responses where
895instance Monoid Responses where
625 mempty = genericMempty
896 mempty = genericMempty
626− mappend = genericMappend
897+ mappend = (<>)
899+instance Semigroup Response where
900+ (<>) = genericMappend
628instance Monoid Response where
901instance Monoid Response where
629 mempty = genericMempty
902 mempty = genericMempty
630− mappend = genericMappend
903+ mappend = (<>)
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
632instance Monoid ExternalDocs where
907instance Monoid ExternalDocs where
633 mempty = genericMempty
908 mempty = genericMempty
634− mappend = genericMappend
909+ mappend = (<>)
911+instance Semigroup Operation where
912+ (<>) = genericMappend
636instance Monoid Operation where
913instance Monoid Operation where
637 mempty = genericMempty
914 mempty = genericMempty
917+instance Semigroup Example where
638− mappend = genericMappend
918+ (<>) = genericMappend
919+instance Monoid Example where
920+ mempty = genericMempty
923+instance Semigroup SecurityScheme where
924+ (<>) = mergeSecurityScheme
926+instance Semigroup SecurityDefinitions where
927+ (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928+ SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
930+instance Monoid SecurityDefinitions where
931+ mempty = SecurityDefinitions $ InsOrdHashMap.empty
640-- =======================================================================
934-- =======================================================================
641-- SwaggerMonoid helper instances
935-- SwaggerMonoid helper instances
642-- =======================================================================
936-- =======================================================================
644instance SwaggerMonoid Info
938instance SwaggerMonoid Info
645−instance SwaggerMonoid Paths
646instance SwaggerMonoid PathItem
939instance SwaggerMonoid PathItem
647instance SwaggerMonoid Schema
940instance SwaggerMonoid Schema
648−instance SwaggerMonoid (ParamSchema t i)
941+instance SwaggerMonoid (ParamSchema t)
649instance SwaggerMonoid Param
942instance SwaggerMonoid Param
650instance SwaggerMonoid ParamOtherSchema
943instance SwaggerMonoid ParamOtherSchema
651instance SwaggerMonoid Responses
944instance SwaggerMonoid Responses
652instance SwaggerMonoid Response
945instance SwaggerMonoid Response
653instance SwaggerMonoid ExternalDocs
946instance SwaggerMonoid ExternalDocs
654instance SwaggerMonoid Operation
947instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
656instance SwaggerMonoid MimeList
951instance SwaggerMonoid MimeList
657deriving instance SwaggerMonoid URL
952deriving instance SwaggerMonoid URL
@@ -664,67 +959,85 @@ instance SwaggerMonoid ParamLocation where
664 swaggerMempty = ParamQuery
959 swaggerMempty = ParamQuery
665 swaggerMappend _ y = y
960 swaggerMappend _ y = y
667−instance SwaggerMonoid (HashMap Text Schema) where
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
668− swaggerMempty = HashMap.empty
963+ swaggerMempty = InsOrdHashMap.empty
669− swaggerMappend = HashMap.unionWith mappend
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
671−instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
672− swaggerMempty = HashMap.empty
673− swaggerMappend = HashMap.unionWith swaggerMappend
675instance Monoid a => SwaggerMonoid (Referenced a) where
966instance Monoid a => SwaggerMonoid (Referenced a) where
676 swaggerMempty = Inline mempty
967 swaggerMempty = Inline mempty
677− swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
678 swaggerMappend _ y = y
969 swaggerMappend _ y = y
680−instance SwaggerMonoid (HashMap Text Param) where
971+instance SwaggerMonoid ParamAnySchema where
681− swaggerMempty = HashMap.empty
972+ swaggerMempty = ParamOther swaggerMempty
682− swaggerMappend = HashMap.unionWith mappend
973+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975+ swaggerMappend _ y = y
684−instance SwaggerMonoid (HashMap Text Response) where
977+-- =======================================================================
685− swaggerMempty = HashMap.empty
978+-- Simple Generic-based ToJSON instances
686− swaggerMappend = flip HashMap.union
979+-- =======================================================================
688−instance SwaggerMonoid (HashMap Text SecurityScheme) where
981+instance ToJSON ParamLocation where
689− swaggerMempty = HashMap.empty
982+ toJSON = genericToJSON (jsonPrefix "Param")
690− swaggerMappend = flip HashMap.union
692−instance SwaggerMonoid (HashMap FilePath PathItem) where
984+instance ToJSON Info where
693− swaggerMempty = HashMap.empty
985+ toJSON = genericToJSON (jsonPrefix "Info")
694− swaggerMappend = HashMap.unionWith mappend
696−instance SwaggerMonoid (HashMap HeaderName Header) where
987+instance ToJSON Contact where
697− swaggerMempty = HashMap.empty
988+ toJSON = genericToJSON (jsonPrefix "Contact")
698− swaggerMappend = flip HashMap.union
700−instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
990+instance ToJSON License where
701− swaggerMempty = HashMap.empty
991+ toJSON = genericToJSON (jsonPrefix "License")
702− swaggerMappend = flip HashMap.union
704−instance SwaggerMonoid ParamAnySchema where
993+instance ToJSON ApiKeyLocation where
705− swaggerMempty = ParamOther swaggerMempty
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
706− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
995+
707− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
996+instance ToJSON ApiKeyParams where
708− swaggerMappend _ y = y
997+ toJSON = genericToJSON (jsonPrefix "apiKey")
999+instance ToJSON Scheme where
1000+ toJSON = genericToJSON (jsonPrefix "")
1002+instance ToJSON Tag where
1003+ toJSON = genericToJSON (jsonPrefix "Tag")
1005+instance ToJSON ExternalDocs where
1006+ toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1008+instance ToJSON Xml where
1009+ toJSON = genericToJSON (jsonPrefix "Xml")
710-- =======================================================================
1011-- =======================================================================
711−-- TH derived ToJSON and FromJSON instances
1012+-- Simple Generic-based FromJSON instances
712-- =======================================================================
1013-- =======================================================================
714−deriveJSON (jsonPrefix "Param") ''ParamLocation
1015+instance FromJSON ParamLocation where
715−deriveJSON' ''Info
1016+ parseJSON = genericParseJSON (jsonPrefix "Param")
716−deriveJSON' ''Contact
1017+
717−deriveJSON' ''License
1018+instance FromJSON Info where
718−deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
1019+ parseJSON = genericParseJSON (jsonPrefix "Info")
1021+instance FromJSON Contact where
1022+ parseJSON = genericParseJSON (jsonPrefix "Contact")
1024+instance FromJSON License where
1025+ parseJSON = genericParseJSON (jsonPrefix "License")
1027+instance FromJSON ApiKeyLocation where
1028+ parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1030+instance FromJSON ApiKeyParams where
719−deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
1031+ parseJSON = genericParseJSON (jsonPrefix "apiKey")
720−deriveJSONDefault ''Scheme
1032+
721−deriveJSON' ''Tag
1033+instance FromJSON Scheme where
722−deriveJSON' ''ExternalDocs
1034+ parseJSON = genericParseJSON (jsonPrefix "")
724−deriveToJSON' ''Operation
1036+instance FromJSON Tag where
725−deriveToJSON' ''Response
1037+ parseJSON = genericParseJSON (jsonPrefix "Tag")
726−deriveToJSON' ''PathItem
1038+
727−deriveToJSON' ''Xml
1039+instance FromJSON ExternalDocs where
1040+ parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
729-- =======================================================================
1042-- =======================================================================
730-- Manual ToJSON instances
1043-- Manual ToJSON instances
@@ -746,7 +1059,8 @@ instance ToJSON OAuth2Flow where
746 , "tokenUrl" .= tokenUrl ]
1059 , "tokenUrl" .= tokenUrl ]
748instance ToJSON OAuth2Params where
1061instance ToJSON OAuth2Params where
749− toJSON = genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1062+ toJSON = sopSwaggerGenericToJSON
751instance ToJSON SecuritySchemeType where
1065instance ToJSON SecuritySchemeType where
752 toJSON SecuritySchemeBasic
1066 toJSON SecuritySchemeBasic
@@ -759,22 +1073,38 @@ instance ToJSON SecuritySchemeType where
759 <+> object [ "type" .= ("oauth2" :: Text) ]
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
761instance ToJSON Swagger where
1075instance ToJSON Swagger where
762− toJSON = addVersion . genericToJSON (jsonPrefix "")
1076+ toJSON = sopSwaggerGenericToJSON
763− where
1077+ DEFINE_TOENCODING
764− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
765− addVersion _ = error "impossible"
767instance ToJSON SecurityScheme where
1079instance ToJSON SecurityScheme where
768− toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1080+ toJSON = sopSwaggerGenericToJSON
770instance ToJSON Schema where
1083instance ToJSON Schema where
771− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1084+ toJSON = sopSwaggerGenericToJSON
773instance ToJSON Header where
1087instance ToJSON Header where
774− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
1088+ toJSON = sopSwaggerGenericToJSON
775−
1089+ DEFINE_TOENCODING
1091+-- | As for nullary schema for 0-arity type constructors, see
1092+-- <https://github.com/GetShopTV/swagger2/issues/167>.
1094+-- >>> encode (SwaggerItemsArray [])
1095+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
776−instance ToJSON Items where
1097+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
777− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
1098+ toJSON (SwaggerItemsPrimitive fmt schema) = object
1099+ [ "collectionFormat" .= fmt
1100+ , "items" .= schema ]
1101+ toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1102+ toJSON (SwaggerItemsArray []) = object
1103+ [ "items" .= object []
1104+ , "maxItems" .= (0 :: Int)
1105+ , "example" .= Array mempty
1107+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
779instance ToJSON Host where
1109instance ToJSON Host where
780 toJSON (Host host mport) = toJSON $
1110 toJSON (Host host mport) = toJSON $
@@ -782,38 +1112,53 @@ instance ToJSON Host where
782 Nothing -> host
1112 Nothing -> host
783 Just port -> host ++ ":" ++ show port
1113 Just port -> host ++ ":" ++ show port
785−instance ToJSON Paths where
786− toJSON (Paths m) = toJSON m
788instance ToJSON MimeList where
1115instance ToJSON MimeList where
789 toJSON (MimeList xs) = toJSON (map show xs)
1116 toJSON (MimeList xs) = toJSON (map show xs)
791instance ToJSON Param where
1118instance ToJSON Param where
792− toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1119+ toJSON = sopSwaggerGenericToJSON
794instance ToJSON ParamAnySchema where
1122instance ToJSON ParamAnySchema where
795 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
796 toJSON (ParamOther s) = toJSON s
1124 toJSON (ParamOther s) = toJSON s
798instance ToJSON ParamOtherSchema where
1126instance ToJSON ParamOtherSchema where
799− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1127+ toJSON = sopSwaggerGenericToJSON
800−
1128+ DEFINE_TOENCODING
801−instance ToJSON SchemaItems where
802− toJSON (SchemaItemsObject x) = toJSON x
803− toJSON (SchemaItemsArray xs) = toJSON xs
805instance ToJSON Responses where
1130instance ToJSON Responses where
806− toJSON (Responses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1131+ toJSON = sopSwaggerGenericToJSON
1134+instance ToJSON Response where
1135+ toJSON = sopSwaggerGenericToJSON
1138+instance ToJSON Operation where
1139+ toJSON = sopSwaggerGenericToJSON
1142+instance ToJSON PathItem where
1143+ toJSON = sopSwaggerGenericToJSON
808instance ToJSON Example where
1146instance ToJSON Example where
809 toJSON = toJSON . Map.mapKeys show . getExample
1147 toJSON = toJSON . Map.mapKeys show . getExample
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
811instance ToJSON Reference where
1152instance ToJSON Reference where
812 toJSON (Reference ref) = object [ "$ref" .= ref ]
1153 toJSON (Reference ref) = object [ "$ref" .= ref ]
814−instance ToJSON a => ToJSON (Referenced a) where
1155+referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
815− toJSON (Ref ref) = toJSON ref
1156+referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
816− toJSON (Inline x) = toJSON x
1157+referencedToJSON _ (Inline x) = toJSON x
1159+instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
1160+instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
1161+instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
818instance ToJSON (SwaggerType t) where
1163instance ToJSON (SwaggerType t) where
819 toJSON SwaggerArray = "array"
1164 toJSON SwaggerArray = "array"
@@ -832,8 +1177,14 @@ instance ToJSON (CollectionFormat t) where
832 toJSON CollectionPipes = "pipes"
1177 toJSON CollectionPipes = "pipes"
833 toJSON CollectionMulti = "multi"
1178 toJSON CollectionMulti = "multi"
835−instance ToJSON i => ToJSON (ParamSchema t i) where
1180+instance ToJSON (ParamSchema k) where
836− toJSON = genericToJSON (jsonPrefix "paramSchema")
1181+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1182+ toJSON = sopSwaggerGenericToJSONWithOpts $
1183+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1185+instance ToJSON AdditionalProperties where
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
838-- =======================================================================
1189-- =======================================================================
839-- Manual FromJSON instances
1190-- Manual FromJSON instances
@@ -853,7 +1204,7 @@ instance FromJSON OAuth2Flow where
853 parseJSON _ = empty
1204 parseJSON _ = empty
855instance FromJSON OAuth2Params where
1206instance FromJSON OAuth2Params where
856− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1207+ parseJSON = sopSwaggerGenericParseJSON
858instance FromJSON SecuritySchemeType where
1209instance FromJSON SecuritySchemeType where
859 parseJSON js@(Object o) = do
1210 parseJSON js@(Object o) = do
@@ -866,53 +1217,65 @@ instance FromJSON SecuritySchemeType where
866 parseJSON _ = empty
1217 parseJSON _ = empty
868instance FromJSON Swagger where
1219instance FromJSON Swagger where
869− parseJSON js@(Object o) = do
1220+ parseJSON = sopSwaggerGenericParseJSON
870− (version :: Text) <- o .: "swagger"
871− when (version /= "2.0") empty
872− (genericParseJSON (jsonPrefix "")
873− `withDefaults` [ "consumes" .= (mempty :: MimeList)
874− , "produces" .= (mempty :: MimeList)
875− , "security" .= ([] :: [SecurityRequirement])
876− , "tags" .= ([] :: [Tag])
877− , "definitions" .= (mempty :: HashMap Text Schema)
878− , "parameters" .= (mempty :: HashMap Text Param)
879− , "responses" .= (mempty :: HashMap Text Response)
880− , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
884instance FromJSON SecurityScheme where
1222instance FromJSON SecurityScheme where
885− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1223+ parseJSON = sopSwaggerGenericParseJSON
887instance FromJSON Schema where
1225instance FromJSON Schema where
888− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1226+ parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
889− `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1227+ where nullaryCleanup :: Schema -> Schema
890− , "required" .= ([] :: [ParamName]) ]
1228+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230+ then s { _schemaExample = Nothing
1231+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
892instance FromJSON Header where
1234instance FromJSON Header where
893− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
1235+ parseJSON = sopSwaggerGenericParseJSON
1237+instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1238+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1239+ <$> o .:? "collectionFormat"
1240+ <*> (o .: "items" >>= parseJSON)
895−instance FromJSON Items where
1242+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
896− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
1243+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244+ <$> o .:? "collectionFormat"
1245+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1249+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250+-- Just (SwaggerItemsArray [])
1252+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1255+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1258+instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1259+ parseJSON js@(Object obj)
1260+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1261+ | otherwise = SwaggerItemsObject <$> parseJSON js
1262+ parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1263+ parseJSON _ = empty
898instance FromJSON Host where
1265instance FromJSON Host where
899− parseJSON (String s) =
1266+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
900− case fromInteger <$> readMaybe portStr of
1267+ [host] -> return $ Host host Nothing
901− Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1268+ [host, port] -> case readMaybe port of
902− mport -> pure $ Host host mport
1269+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
903− where
1270+ Just p -> return $ Host host (Just (fromInteger p))
904− (hostText, portText) = Text.breakOn ":" s
1271+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
905− [host, portStr] = map Text.unpack [hostText, portText]
906 parseJSON _ = empty
1272 parseJSON _ = empty
908−instance FromJSON Paths where
909− parseJSON js = Paths <$> parseJSON js
911instance FromJSON MimeList where
1274instance FromJSON MimeList where
912 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
914instance FromJSON Param where
1277instance FromJSON Param where
915− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1278+ parseJSON = sopSwaggerGenericParseJSON
917instance FromJSON ParamAnySchema where
1280instance FromJSON ParamAnySchema where
918 parseJSON js@(Object o) = do
1281 parseJSON js@(Object o) = do
@@ -925,17 +1288,12 @@ instance FromJSON ParamAnySchema where
925 parseJSON _ = empty
1288 parseJSON _ = empty
927instance FromJSON ParamOtherSchema where
1290instance FromJSON ParamOtherSchema where
928− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1291+ parseJSON = sopSwaggerGenericParseJSON
930−instance FromJSON SchemaItems where
931− parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
932− parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
935instance FromJSON Responses where
1293instance FromJSON Responses where
936 parseJSON (Object o) = Responses
1294 parseJSON (Object o) = Responses
937 <$> o .:? "default"
1295 <$> o .:? "default"
938− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
939 parseJSON _ = empty
1297 parseJSON _ = empty
941instance FromJSON Example where
1299instance FromJSON Example where
@@ -944,46 +1302,126 @@ instance FromJSON Example where
944 pure $ Example (Map.mapKeys fromString m)
1302 pure $ Example (Map.mapKeys fromString m)
946instance FromJSON Response where
1304instance FromJSON Response where
947− parseJSON = genericParseJSON (jsonPrefix "response")
1305+ parseJSON = sopSwaggerGenericParseJSON
948− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
950instance FromJSON Operation where
1307instance FromJSON Operation where
951− parseJSON = genericParseJSON (jsonPrefix "operation")
1308+ parseJSON = sopSwaggerGenericParseJSON
952− `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
954instance FromJSON PathItem where
1310instance FromJSON PathItem where
955− parseJSON = genericParseJSON (jsonPrefix "pathItem")
1311+ parseJSON = sopSwaggerGenericParseJSON
956− `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1312+
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
958instance FromJSON Reference where
1316instance FromJSON Reference where
959 parseJSON (Object o) = Reference <$> o .: "$ref"
1317 parseJSON (Object o) = Reference <$> o .: "$ref"
960 parseJSON _ = empty
1318 parseJSON _ = empty
962−instance FromJSON a => FromJSON (Referenced a) where
1320+referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
963− parseJSON js
1321+referencedParseJSON prefix js@(Object o) = do
964− = Ref <$> parseJSON js
1322+ ms <- o .:? "$ref"
965− <|> Inline <$> parseJSON js
1324+ Nothing -> Inline <$> parseJSON js
1325+ Just s -> Ref <$> parseRef s
1328+ case Text.stripPrefix prefix s of
1329+ Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1330+ Just suffix -> pure (Reference suffix)
1331+referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
1333+instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1334+instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
1335+instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#/responses/"
967instance FromJSON Xml where
1337instance FromJSON Xml where
968 parseJSON = genericParseJSON (jsonPrefix "xml")
1338 parseJSON = genericParseJSON (jsonPrefix "xml")
970−instance FromJSON (SwaggerType Schema) where
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
971 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1341 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
973−instance FromJSON (SwaggerType ParamOtherSchema) where
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
974 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1344 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
976−instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
977 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1347 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
979−instance FromJSON (CollectionFormat Param) where
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
980− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
982−instance FromJSON (CollectionFormat Items) where
983 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1350 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
985−-- NOTE: The constraint @FromJSON (SwaggerType t)@ is necessary here!
1352+-- NOTE: There aren't collections of 'Schema'
986−-- Without the constraint the general instance will be used
1353+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
987−-- that only accepts common types (i.e. NOT object, null or file).
1354+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1356+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1357+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
988−instance (FromJSON (SwaggerType t), FromJSON i) => FromJSON (ParamSchema t i) where
1359+instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
989− parseJSON = genericParseJSON (jsonPrefix "ParamSchema")
1360+ parseJSON = sopSwaggerGenericParseJSON
1361+instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1362+ parseJSON = sopSwaggerGenericParseJSON
1363+instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1364+ parseJSON = sopSwaggerGenericParseJSON
1366+instance FromJSON AdditionalProperties where
1367+ parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368+ parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1370+-------------------------------------------------------------------------------
1372+-------------------------------------------------------------------------------
1374+deriveGeneric ''Header
1375+deriveGeneric ''OAuth2Params
1376+deriveGeneric ''Operation
1377+deriveGeneric ''Param
1378+deriveGeneric ''ParamOtherSchema
1379+deriveGeneric ''PathItem
1380+deriveGeneric ''Response
1381+deriveGeneric ''Responses
1382+deriveGeneric ''SecurityScheme
1383+deriveGeneric ''Schema
1384+deriveGeneric ''ParamSchema
1385+deriveGeneric ''Swagger
1387+instance HasSwaggerAesonOptions Header where
1388+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1389+instance HasSwaggerAesonOptions OAuth2Params where
1390+ swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
1391+instance HasSwaggerAesonOptions Operation where
1392+ swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
1393+instance HasSwaggerAesonOptions Param where
1394+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1395+instance HasSwaggerAesonOptions ParamOtherSchema where
1396+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1397+instance HasSwaggerAesonOptions PathItem where
1398+ swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
1399+instance HasSwaggerAesonOptions Response where
1400+ swaggerAesonOptions _ = mkSwaggerAesonOptions "response"
1401+instance HasSwaggerAesonOptions Responses where
1402+ swaggerAesonOptions _ = mkSwaggerAesonOptions "responses" & saoSubObject ?~ "responses"
1403+instance HasSwaggerAesonOptions SecurityScheme where
1404+ swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1405+instance HasSwaggerAesonOptions Schema where
1406+ swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1407+instance HasSwaggerAesonOptions Swagger where
1408+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("swagger", "2.0")]
1410+instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1411+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1412+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1413+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1414+-- NOTE: Schema doesn't have 'items' sub object!
1415+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1416+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1418+instance AesonDefaultValue (ParamSchema s)
1419+instance AesonDefaultValue OAuth2Flow
1420+instance AesonDefaultValue Responses
1421+instance AesonDefaultValue ParamAnySchema
1422+instance AesonDefaultValue SecuritySchemeType
1423+instance AesonDefaultValue (SwaggerType a)
1424+instance AesonDefaultValue MimeList where defaultValue = Just mempty
1425+instance AesonDefaultValue Info
1426+instance AesonDefaultValue ParamLocation
1427+instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty