@@ -1,4 +1,7 @@
2+{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DeriveDataTypeable #-}
3{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
2{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveGeneric #-}
3{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE DeriveTraversable #-}
4{-# LANGUAGE FlexibleContexts #-}
7{-# LANGUAGE FlexibleContexts #-}
@@ -10,89 +13,127 @@
10{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE StandaloneDeriving #-}
14{-# LANGUAGE StandaloneDeriving #-}
12{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
21+#include "overlapping-compat.h"
13module Data.Swagger.Internal where
22module Data.Swagger.Internal where
27+import Control.Lens ((&), (.~), (?~))
15import Control.Applicative
28import Control.Applicative
17import Data.Aeson
29import Data.Aeson
18−import Data.Aeson.TH (deriveJSON)
19import qualified Data.Aeson.Types as JSON
30import qualified Data.Aeson.Types as JSON
20import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
31import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
21−import Data.HashMap.Strict (HashMap)
32+import Data.Hashable (Hashable)
22import qualified Data.HashMap.Strict as HashMap
33import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
23import Data.Map (Map)
35import Data.Map (Map)
24import qualified Data.Map as Map
36import qualified Data.Map as Map
25−import Data.Monoid
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
26import Data.Scientific (Scientific)
39import Data.Scientific (Scientific)
27−import Data.String (fromString)
40+import Data.String (IsString(..))
28import Data.Text (Text)
41import Data.Text (Text)
29import qualified Data.Text as Text
42import qualified Data.Text as Text
30import GHC.Generics (Generic)
43import GHC.Generics (Generic)
31−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
32import Network.HTTP.Media (MediaType)
45import Network.HTTP.Media (MediaType)
33import 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
35import 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
37-- | This is the root document object for the API specification.
76-- | This is the root document object for the API specification.
38data Swagger = Swagger
77data Swagger = Swagger
39 { -- | Provides metadata about the API.
78 { -- | Provides metadata about the API.
40 -- The metadata can be used by the clients if needed.
79 -- The metadata can be used by the clients if needed.
41− _info :: Info
80+ _swaggerInfo :: Info
43 -- | 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.
44 -- 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).
45− , _host :: Maybe Host
84+ , _swaggerHost :: Maybe Host
47 -- | 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.
48 -- 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.
49 -- The value MUST start with a leading slash (/).
88 -- The value MUST start with a leading slash (/).
50− , _basePath :: Maybe FilePath
89+ , _swaggerBasePath :: Maybe FilePath
52 -- | The transfer protocol of the API.
91 -- | The transfer protocol of the API.
53 -- 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.
54− , _schemes :: Maybe [Scheme]
93+ , _swaggerSchemes :: Maybe [Scheme]
56 -- | A list of MIME types the APIs can consume.
95 -- | A list of MIME types the APIs can consume.
57 -- 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.
58− , _consumes :: MimeList
97+ , _swaggerConsumes :: MimeList
60 -- | A list of MIME types the APIs can produce.
99 -- | A list of MIME types the APIs can produce.
61− -- 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.
62− , _produces :: MimeList
101+ , _swaggerProduces :: MimeList
64 -- | The available paths and operations for the API.
103 -- | The available paths and operations for the API.
65− , _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
67 -- | An object to hold data types produced and consumed by operations.
108 -- | An object to hold data types produced and consumed by operations.
68− , _definitions :: HashMap Text Schema
109+ , _swaggerDefinitions :: Definitions Schema
70 -- | An object to hold parameters that can be used across operations.
111 -- | An object to hold parameters that can be used across operations.
71 -- This property does not define global parameters for all operations.
112 -- This property does not define global parameters for all operations.
72− , _parameters :: HashMap Text Param
113+ , _swaggerParameters :: Definitions Param
74 -- | An object to hold responses that can be used across operations.
115 -- | An object to hold responses that can be used across operations.
75 -- This property does not define global responses for all operations.
116 -- This property does not define global responses for all operations.
76− , _responses :: HashMap Text Response
117+ , _swaggerResponses :: Definitions Response
78 -- | Security scheme definitions that can be used across the specification.
119 -- | Security scheme definitions that can be used across the specification.
79− , _securityDefinitions :: HashMap Text SecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
81 -- | 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.
82 -- 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
83 -- (that is, there is a logical OR between the security requirements).
124 -- (that is, there is a logical OR between the security requirements).
84 -- Individual operations can override this definition.
125 -- Individual operations can override this definition.
85− , _security :: [SecurityRequirement]
126+ , _swaggerSecurity :: [SecurityRequirement]
87 -- | A list of tags used by the specification with additional metadata.
128 -- | A list of tags used by the specification with additional metadata.
88 -- 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.
89 -- 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.
90 -- 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.
91 -- Each tag name in the list MUST be unique.
132 -- Each tag name in the list MUST be unique.
92− , _tags :: [Tag]
133+ , _swaggerTags :: InsOrdHashSet Tag
94 -- | Additional external documentation.
135 -- | Additional external documentation.
95− , _externalDocs :: Maybe ExternalDocs
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
96 } deriving (Eq, Show, Generic, Data, Typeable)
137 } deriving (Eq, Show, Generic, Data, Typeable)
98-- | The object provides metadata about the API.
139-- | The object provides metadata about the API.
@@ -141,12 +182,18 @@ data License = License
141 , _licenseUrl :: Maybe URL
182 , _licenseUrl :: Maybe URL
142 } deriving (Eq, Show, Generic, Data, Typeable)
183 } deriving (Eq, Show, Generic, Data, Typeable)
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
144-- | 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.
145data Host = Host
189data Host = Host
146 { _hostName :: HostName -- ^ Host name.
190 { _hostName :: HostName -- ^ Host name.
147 , _hostPort :: Maybe PortNumber -- ^ Optional port.
191 , _hostPort :: Maybe PortNumber -- ^ Optional port.
148 } deriving (Eq, Show, Generic, Typeable)
192 } deriving (Eq, Show, Generic, Typeable)
194+instance IsString Host where
195+ fromString s = Host s Nothing
150hostConstr :: Constr
197hostConstr :: Constr
151hostConstr = mkConstr hostDataType "Host" [] Prefix
198hostConstr = mkConstr hostDataType "Host" [] Prefix
@@ -168,13 +215,6 @@ data Scheme
169 deriving (Eq, Show, Generic, Data, Typeable)
216 deriving (Eq, Show, Generic, Data, Typeable)
171−-- | The available paths and operations for the API.
173− { -- | Holds the relative paths to the individual endpoints.
174− -- The path is appended to the @'basePath'@ in order to construct the full URL.
175− _pathsMap :: HashMap FilePath PathItem
176− } deriving (Eq, Show, Generic, Data, Typeable)
178-- | Describes the operations available on a single path.
218-- | Describes the operations available on a single path.
179-- A @'PathItem'@ may be empty, due to ACL constraints.
219-- A @'PathItem'@ may be empty, due to ACL constraints.
180-- The path itself is still exposed to the documentation viewer
220-- The path itself is still exposed to the documentation viewer
@@ -212,7 +252,7 @@ data PathItem = PathItem
212data Operation = Operation
252data Operation = Operation
213 { -- | A list of tags for API documentation control.
253 { -- | A list of tags for API documentation control.
214 -- 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.
215− _operationTags :: [Text]
255+ _operationTags :: InsOrdHashSet TagName
217 -- | A short summary of what the operation does.
257 -- | A short summary of what the operation does.
218 -- 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.
@@ -269,7 +309,7 @@ data Operation = Operation
269 } deriving (Eq, Show, Generic, Data, Typeable)
309 } deriving (Eq, Show, Generic, Data, Typeable)
271newtype MimeList = MimeList { getMimeList :: [MediaType] }
311newtype MimeList = MimeList { getMimeList :: [MediaType] }
272− deriving (Eq, Show, Monoid, Typeable)
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
274mimeListConstr :: Constr
314mimeListConstr :: Constr
275mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
315mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -320,12 +360,92 @@ data ParamOtherSchema = ParamOtherSchema
320 -- Default value is @False@.
360 -- Default value is @False@.
321 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
323− -- | Determines the format of the array if @'ParamArray'@ is used.
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
324− -- Default value is csv.
364+ } deriving (Eq, Show, Generic, Typeable, Data)
325− , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
365+
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
327− , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema Items
418+instance Data (SwaggerItems 'SwaggerKindSchema) where
328− } deriving (Eq, Show, Generic, Data, Typeable)
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
330data SwaggerType t where
450data SwaggerType t where
331 SwaggerString :: SwaggerType t
451 SwaggerString :: SwaggerType t
@@ -333,81 +453,47 @@ data SwaggerType t where
333 SwaggerInteger :: SwaggerType t
453 SwaggerInteger :: SwaggerType t
334 SwaggerBoolean :: SwaggerType t
454 SwaggerBoolean :: SwaggerType t
335 SwaggerArray :: SwaggerType t
455 SwaggerArray :: SwaggerType t
336− SwaggerFile :: SwaggerType ParamOtherSchema
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
337− SwaggerNull :: SwaggerType Schema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
338− SwaggerObject :: SwaggerType Schema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
340deriving instance Eq (SwaggerType t)
461deriving instance Eq (SwaggerType t)
341deriving instance Show (SwaggerType t)
462deriving instance Show (SwaggerType t)
342−deriving instance Typeable (SwaggerType t)
344−swaggerStringConstr :: DataType -> Constr
464+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
345−swaggerStringConstr dt = mkConstr dt "SwaggerString" [] Prefix
465+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
347−swaggerNumberConstr :: DataType -> Constr
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
348−swaggerNumberConstr dt = mkConstr dt "SwaggerNumber" [] Prefix
468+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
350−swaggerIntegerConstr :: DataType -> Constr
470+swaggerCommonTypes :: [SwaggerType k]
351−swaggerIntegerConstr dt = mkConstr dt "SwaggerInteger" [] Prefix
471+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
353−swaggerBooleanConstr :: DataType -> Constr
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
354−swaggerBooleanConstr dt = mkConstr dt "SwaggerBoolean" [] Prefix
474+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
356−swaggerArrayConstr :: DataType -> Constr
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
357−swaggerArrayConstr dt = mkConstr dt "SwaggerArray" [] Prefix
477+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
359−swaggerFileConstr :: DataType -> Constr
479+swaggerTypeConstrs :: [Constr]
360−swaggerFileConstr dt = mkConstr dt "SwaggerFile" [] Prefix
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
362−swaggerNullConstr :: DataType -> Constr
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
363−swaggerNullConstr dt = mkConstr dt "SwaggerNull" [] Prefix
484+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485+ toConstr = swaggerTypeConstr
486+ dataTypeOf = swaggerTypeDataType
365−swaggerObjectConstr :: DataType -> Constr
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
366−swaggerObjectConstr dt = mkConstr dt "SwaggerObject" [] Prefix
489+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490+ toConstr = swaggerTypeConstr
491+ dataTypeOf = swaggerTypeDataType
368−swaggerTypeDataType :: [DataType -> Constr] -> DataType
369−swaggerTypeDataType extra = dt
371− dt = mkDataType "Data.Swagger.SwaggerType" $ map ($ dt) $
372− [ swaggerStringConstr, swaggerNumberConstr, swaggerIntegerConstr, swaggerBooleanConstr , swaggerArrayConstr ]
375−swaggerTypeToConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
376−swaggerTypeToConstr t = case t of
377− SwaggerString -> swaggerStringConstr dt
378− SwaggerNumber -> swaggerNumberConstr dt
379− SwaggerInteger -> swaggerIntegerConstr dt
380− SwaggerBoolean -> swaggerBooleanConstr dt
381− SwaggerArray -> swaggerArrayConstr dt
382− SwaggerFile -> swaggerFileConstr dt
383− SwaggerNull -> swaggerNullConstr dt
384− SwaggerObject -> swaggerObjectConstr dt
388−instance Data (SwaggerType Items) where
493+instance Data (SwaggerType 'SwaggerKindSchema) where
389− gunfold = gunfoldEnum "SwaggerType Items" $ zip [1..]
494+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
390− [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
495+ toConstr = swaggerTypeConstr
391− toConstr = swaggerTypeToConstr
392− dataTypeOf _ = swaggerTypeDataType []
394−instance Data (SwaggerType Header) where
395− gunfold = gunfoldEnum "SwaggerType Header" $ zip [1..]
396− [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
397− toConstr = swaggerTypeToConstr
398− dataTypeOf _ = swaggerTypeDataType []
400−instance Data (SwaggerType ParamOtherSchema) where
401− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" $ zip [1..]
402− [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray, SwaggerFile]
403− toConstr = swaggerTypeToConstr
404− dataTypeOf _ = swaggerTypeDataType [swaggerFileConstr]
406−instance Data (SwaggerType Schema) where
407− gunfold = gunfoldEnum "SwaggerType Schema" $ zip [1, 2, 3, 4, 5, 7, 8]
408− [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
409− toConstr = swaggerTypeToConstr
410− dataTypeOf _ = swaggerTypeDataType [swaggerNullConstr, swaggerObjectConstr]
496+ dataTypeOf = swaggerTypeDataType
412data ParamLocation
498data ParamLocation
413 = -- | Parameters that are appended to the URL.
499 = -- | Parameters that are appended to the URL.
@@ -444,40 +530,28 @@ data CollectionFormat t where
444 -- Corresponds to multiple parameter instances
530 -- Corresponds to multiple parameter instances
445 -- 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@.
446 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
532 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
447− CollectionMulti :: CollectionFormat Param
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
449deriving instance Eq (CollectionFormat t)
536deriving instance Eq (CollectionFormat t)
450deriving instance Show (CollectionFormat t)
537deriving instance Show (CollectionFormat t)
451−deriving instance Typeable (CollectionFormat t)
453−collectionCsvConstr :: Constr
454−collectionCsvConstr = mkConstr collectionFormatDataType "CollectionCSV" [] Prefix
456−collectionSsvConstr :: Constr
457−collectionSsvConstr = mkConstr collectionFormatDataType "CollectionSSV" [] Prefix
459−collectionTsvConstr :: Constr
539+collectionFormatConstr :: CollectionFormat t -> Constr
460−collectionTsvConstr = mkConstr collectionFormatDataType "CollectionTSV" [] Prefix
462−collectionPipesConstr :: Constr
463−collectionPipesConstr = mkConstr collectionFormatDataType "CollectionPipes" [] Prefix
540+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
465collectionFormatDataType :: DataType
542collectionFormatDataType :: DataType
466−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat"
543+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
467− [ collectionCsvConstr, collectionSsvConstr, collectionTsvConstr, collectionPipesConstr ]
544+ map collectionFormatConstr collectionCommonFormats
469−instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
470− gunfold = gunfoldEnum "CollectionFormat" $ zip [1..]
471− [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
473− toConstr CollectionCSV = collectionCsvConstr
546+collectionCommonFormats :: [CollectionFormat t]
474− toConstr CollectionSSV = collectionSsvConstr
547+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
475− toConstr CollectionTSV = collectionTsvConstr
476− toConstr CollectionPipes = collectionPipesConstr
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551+ toConstr = collectionFormatConstr
478 dataTypeOf _ = collectionFormatDataType
552 dataTypeOf _ = collectionFormatDataType
480−deriving instance {-# OVERLAPPING #-} Data (CollectionFormat Param)
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
482type ParamName = Text
556type ParamName = Text
@@ -486,9 +560,9 @@ data Schema = Schema
486 , _schemaDescription :: Maybe Text
560 , _schemaDescription :: Maybe Text
487 , _schemaRequired :: [ParamName]
561 , _schemaRequired :: [ParamName]
489− , _schemaAllOf :: Maybe [Schema]
563+ , _schemaAllOf :: Maybe [Referenced Schema]
490− , _schemaProperties :: HashMap Text (Referenced Schema)
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
491− , _schemaAdditionalProperties :: Maybe Schema
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
493 , _schemaDiscriminator :: Maybe Text
567 , _schemaDiscriminator :: Maybe Text
494 , _schemaReadOnly :: Maybe Bool
568 , _schemaReadOnly :: Maybe Bool
@@ -499,15 +573,20 @@ data Schema = Schema
499 , _schemaMaxProperties :: Maybe Integer
573 , _schemaMaxProperties :: Maybe Integer
500 , _schemaMinProperties :: Maybe Integer
574 , _schemaMinProperties :: Maybe Integer
502− , _schemaParamSchema :: ParamSchema Schema SchemaItems
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
503 } deriving (Eq, Show, Generic, Data, Typeable)
577 } deriving (Eq, Show, Generic, Data, Typeable)
505−data SchemaItems
579+-- | A @'Schema'@ with an optional name.
506− = SchemaItemsObject (Referenced Schema)
580+-- This name can be used in references.
507− | SchemaItemsArray [Referenced Schema]
581+data NamedSchema = NamedSchema
582+ { _namedSchemaName :: Maybe Text
583+ , _namedSchemaSchema :: Schema
508− deriving (Eq, Show, Generic, Data, Typeable)
584+ } deriving (Eq, Show, Generic, Data, Typeable)
586+-- | Regex pattern for @string@ type.
510−data ParamSchema t items = ParamSchema
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
511 { -- | 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,
512 -- 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@
513 -- if not supplied by the client in the request.
592 -- if not supplied by the client in the request.
@@ -515,16 +594,16 @@ data ParamSchema t items = ParamSchema
515 -- 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.
516 _paramSchemaDefault :: Maybe Value
595 _paramSchemaDefault :: Maybe Value
518− , _paramSchemaType :: SwaggerType t
597+ , _paramSchemaType :: Maybe (SwaggerType t)
519 , _paramSchemaFormat :: Maybe Format
598 , _paramSchemaFormat :: Maybe Format
520− , _paramSchemaItems :: Maybe items
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
521 , _paramSchemaMaximum :: Maybe Scientific
600 , _paramSchemaMaximum :: Maybe Scientific
522 , _paramSchemaExclusiveMaximum :: Maybe Bool
601 , _paramSchemaExclusiveMaximum :: Maybe Bool
523 , _paramSchemaMinimum :: Maybe Scientific
602 , _paramSchemaMinimum :: Maybe Scientific
524 , _paramSchemaExclusiveMinimum :: Maybe Bool
603 , _paramSchemaExclusiveMinimum :: Maybe Bool
525 , _paramSchemaMaxLength :: Maybe Integer
604 , _paramSchemaMaxLength :: Maybe Integer
526 , _paramSchemaMinLength :: Maybe Integer
605 , _paramSchemaMinLength :: Maybe Integer
527− , _paramSchemaPattern :: Maybe Text
606+ , _paramSchemaPattern :: Maybe Pattern
528 , _paramSchemaMaxItems :: Maybe Integer
607 , _paramSchemaMaxItems :: Maybe Integer
529 , _paramSchemaMinItems :: Maybe Integer
608 , _paramSchemaMinItems :: Maybe Integer
530 , _paramSchemaUniqueItems :: Maybe Bool
609 , _paramSchemaUniqueItems :: Maybe Bool
@@ -532,11 +611,11 @@ data ParamSchema t items = ParamSchema
532 , _paramSchemaMultipleOf :: Maybe Scientific
611 , _paramSchemaMultipleOf :: Maybe Scientific
533 } deriving (Eq, Show, Generic, Typeable)
612 } deriving (Eq, Show, Generic, Typeable)
535−deriving instance (Data t, Data (SwaggerType t), Data i) => Data (ParamSchema t i)
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
537data Xml = Xml
616data Xml = Xml
538 { -- | 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.
539− -- 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.
540 -- When defined alongside type being array (outside the items),
619 -- When defined alongside type being array (outside the items),
541 -- 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.
542 -- If wrapped is false, it will be ignored.
621 -- If wrapped is false, it will be ignored.
@@ -562,14 +641,6 @@ data Xml = Xml
562 , _xmlWrapped :: Maybe Bool
641 , _xmlWrapped :: Maybe Bool
563 } deriving (Eq, Show, Generic, Data, Typeable)
642 } deriving (Eq, Show, Generic, Data, Typeable)
566− { -- | Determines the format of the array if type array is used.
567− -- Default value is @'ItemsCollectionCSV'@.
568− _itemsCollectionFormat :: Maybe (CollectionFormat Items)
570− , _itemsParamSchema :: ParamSchema Items Items
571− } deriving (Eq, Show, Generic, Data, Typeable)
573-- | A container for the expected responses of an operation.
644-- | A container for the expected responses of an operation.
574-- The container maps a HTTP response code to the expected response.
645-- The container maps a HTTP response code to the expected response.
575-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
@@ -582,7 +653,7 @@ data Responses = Responses
583 -- | 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).
584 -- Describes the expected response for those HTTP status codes.
655 -- Describes the expected response for those HTTP status codes.
585− , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
586 } deriving (Eq, Show, Generic, Data, Typeable)
657 } deriving (Eq, Show, Generic, Data, Typeable)
588type HttpStatusCode = Int
659type HttpStatusCode = Int
@@ -601,23 +672,22 @@ data Response = Response
601 , _responseSchema :: Maybe (Referenced Schema)
672 , _responseSchema :: Maybe (Referenced Schema)
603 -- | A list of headers that are sent with the response.
674 -- | A list of headers that are sent with the response.
604− , _responseHeaders :: HashMap HeaderName Header
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
606 -- | An example of the response message.
677 -- | An example of the response message.
607 , _responseExamples :: Maybe Example
678 , _responseExamples :: Maybe Example
608 } deriving (Eq, Show, Generic, Data, Typeable)
679 } deriving (Eq, Show, Generic, Data, Typeable)
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
610type HeaderName = Text
684type HeaderName = Text
612data Header = Header
686data Header = Header
613 { -- | A short description of the header.
687 { -- | A short description of the header.
614 _headerDescription :: Maybe Text
688 _headerDescription :: Maybe Text
616− -- | Determines the format of the array if type array is used.
617− -- Default value is @'ItemsCollectionCSV'@.
618− , _headerCollectionFormat :: Maybe (CollectionFormat Items)
620− , _headerParamSchema :: ParamSchema Header Items
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
621 } deriving (Eq, Show, Generic, Data, Typeable)
691 } deriving (Eq, Show, Generic, Data, Typeable)
623data Example = Example { getExample :: Map MediaType Value }
693data Example = Example { getExample :: Map MediaType Value }
@@ -668,7 +738,7 @@ data OAuth2Params = OAuth2Params
668 _oauth2Flow :: OAuth2Flow
738 _oauth2Flow :: OAuth2Flow
670 -- | The available scopes for the OAuth2 security scheme.
740 -- | The available scopes for the OAuth2 security scheme.
671− , _oauth2Scopes :: HashMap Text Text
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
672 } deriving (Eq, Show, Generic, Data, Typeable)
742 } deriving (Eq, Show, Generic, Data, Typeable)
674data SecuritySchemeType
744data SecuritySchemeType
@@ -685,18 +755,37 @@ data SecurityScheme = SecurityScheme
685 , _securitySchemeDescription :: Maybe Text
755 , _securitySchemeDescription :: Maybe Text
686 } deriving (Eq, Show, Generic, Data, Typeable)
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)
688-- | Lists the required security schemes to execute this operation.
774-- | Lists the required security schemes to execute this operation.
689-- 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
690-- (that is, there is a logical AND between the schemes).
776-- (that is, there is a logical AND between the schemes).
691newtype SecurityRequirement = SecurityRequirement
777newtype SecurityRequirement = SecurityRequirement
692− { getSecurityRequirement :: HashMap Text [Text]
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
693− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
695-- | 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@.
696-- 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.
697data Tag = Tag
786data Tag = Tag
698 { -- | The name of the tag.
787 { -- | The name of the tag.
699− _tagName :: Text
788+ _tagName :: TagName
701 -- | A short description for the tag.
790 -- | A short description for the tag.
702 -- GFM syntax can be used for rich text representation.
791 -- GFM syntax can be used for rich text representation.
@@ -704,7 +793,12 @@ data Tag = Tag
705 -- | Additional external documentation for this tag.
794 -- | Additional external documentation for this tag.
706 , _tagExternalDocs :: Maybe ExternalDocs
795 , _tagExternalDocs :: Maybe ExternalDocs
707− } deriving (Eq, Show, Generic, Data, Typeable)
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
709-- | Allows referencing an external resource for extended documentation.
803-- | Allows referencing an external resource for extended documentation.
710data ExternalDocs = ExternalDocs
804data ExternalDocs = ExternalDocs
@@ -714,7 +808,9 @@ data ExternalDocs = ExternalDocs
715 -- | The URL for the target documentation.
809 -- | The URL for the target documentation.
716 , _externalDocsUrl :: URL
810 , _externalDocsUrl :: URL
717− } deriving (Eq, Show, Generic, Data, Typeable)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
813+instance Hashable ExternalDocs
719-- | A simple object to allow referencing other definitions in the specification.
815-- | A simple object to allow referencing other definitions in the specification.
720-- 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.
@@ -724,77 +820,133 @@ newtype Reference = Reference { getReference :: Text }
724data Referenced a
820data Referenced a
725 = Ref Reference
821 = Ref Reference
726 | Inline a
822 | Inline a
727− deriving (Eq, Show, Data, Typeable)
823+ deriving (Eq, Show, Functor, Data, Typeable)
825+instance IsString a => IsString (Referenced a) where
826+ fromString = Inline . fromString
729−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
731-- =======================================================================
835-- =======================================================================
732-- Monoid instances
836-- Monoid instances
733-- =======================================================================
837-- =======================================================================
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
735instance Monoid Swagger where
841instance Monoid Swagger where
736 mempty = genericMempty
842 mempty = genericMempty
737− mappend = genericMappend
843+ mappend = (<>)
845+instance Semigroup Info where
846+ (<>) = genericMappend
739instance Monoid Info where
847instance Monoid Info where
740 mempty = genericMempty
848 mempty = genericMempty
741− mappend = genericMappend
849+ mappend = (<>)
851+instance Semigroup Contact where
852+ (<>) = genericMappend
743−instance Monoid Paths where
853+instance Monoid Contact where
744 mempty = genericMempty
854 mempty = genericMempty
745− mappend = genericMappend
855+ mappend = (<>)
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
747instance Monoid PathItem where
859instance Monoid PathItem where
748 mempty = genericMempty
860 mempty = genericMempty
749− mappend = genericMappend
861+ mappend = (<>)
863+instance Semigroup Schema where
864+ (<>) = genericMappend
751instance Monoid Schema where
865instance Monoid Schema where
752 mempty = genericMempty
866 mempty = genericMempty
753− mappend = genericMappend
867+ mappend = (<>)
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
755−instance Monoid (ParamSchema t i) where
871+instance Monoid (ParamSchema t) where
756 mempty = genericMempty
872 mempty = genericMempty
757− mappend = genericMappend
873+ mappend = (<>)
875+instance Semigroup Param where
876+ (<>) = genericMappend
759instance Monoid Param where
877instance Monoid Param where
760 mempty = genericMempty
878 mempty = genericMempty
761− mappend = genericMappend
879+ mappend = (<>)
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
763instance Monoid ParamOtherSchema where
883instance Monoid ParamOtherSchema where
764 mempty = genericMempty
884 mempty = genericMempty
765− 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
767instance Monoid Responses where
895instance Monoid Responses where
768 mempty = genericMempty
896 mempty = genericMempty
769− mappend = genericMappend
897+ mappend = (<>)
899+instance Semigroup Response where
900+ (<>) = genericMappend
771instance Monoid Response where
901instance Monoid Response where
772 mempty = genericMempty
902 mempty = genericMempty
773− mappend = genericMappend
903+ mappend = (<>)
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
775instance Monoid ExternalDocs where
907instance Monoid ExternalDocs where
776 mempty = genericMempty
908 mempty = genericMempty
777− mappend = genericMappend
909+ mappend = (<>)
911+instance Semigroup Operation where
912+ (<>) = genericMappend
779instance Monoid Operation where
913instance Monoid Operation where
780 mempty = genericMempty
914 mempty = genericMempty
917+instance Semigroup Example where
781− 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
783-- =======================================================================
934-- =======================================================================
784-- SwaggerMonoid helper instances
935-- SwaggerMonoid helper instances
785-- =======================================================================
936-- =======================================================================
787instance SwaggerMonoid Info
938instance SwaggerMonoid Info
788−instance SwaggerMonoid Paths
789instance SwaggerMonoid PathItem
939instance SwaggerMonoid PathItem
790instance SwaggerMonoid Schema
940instance SwaggerMonoid Schema
791−instance SwaggerMonoid (ParamSchema t i)
941+instance SwaggerMonoid (ParamSchema t)
792instance SwaggerMonoid Param
942instance SwaggerMonoid Param
793instance SwaggerMonoid ParamOtherSchema
943instance SwaggerMonoid ParamOtherSchema
794instance SwaggerMonoid Responses
944instance SwaggerMonoid Responses
795instance SwaggerMonoid Response
945instance SwaggerMonoid Response
796instance SwaggerMonoid ExternalDocs
946instance SwaggerMonoid ExternalDocs
797instance SwaggerMonoid Operation
947instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
799instance SwaggerMonoid MimeList
951instance SwaggerMonoid MimeList
800deriving instance SwaggerMonoid URL
952deriving instance SwaggerMonoid URL
@@ -807,64 +959,85 @@ instance SwaggerMonoid ParamLocation where
807 swaggerMempty = ParamQuery
959 swaggerMempty = ParamQuery
808 swaggerMappend _ y = y
960 swaggerMappend _ y = y
810−instance SwaggerMonoid (HashMap Text Schema) where
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
811− swaggerMempty = HashMap.empty
963+ swaggerMempty = InsOrdHashMap.empty
812− swaggerMappend = HashMap.unionWith mappend
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
814−instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
815− swaggerMempty = HashMap.empty
816− swaggerMappend = HashMap.unionWith swaggerMappend
818instance Monoid a => SwaggerMonoid (Referenced a) where
966instance Monoid a => SwaggerMonoid (Referenced a) where
819 swaggerMempty = Inline mempty
967 swaggerMempty = Inline mempty
820− swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
821 swaggerMappend _ y = y
969 swaggerMappend _ y = y
823−instance SwaggerMonoid (HashMap Text Param) where
971+instance SwaggerMonoid ParamAnySchema where
824− swaggerMempty = HashMap.empty
972+ swaggerMempty = ParamOther swaggerMempty
825− 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
827−instance SwaggerMonoid (HashMap Text Response) where
977+-- =======================================================================
828− swaggerMempty = HashMap.empty
978+-- Simple Generic-based ToJSON instances
829− swaggerMappend = flip HashMap.union
979+-- =======================================================================
831−instance SwaggerMonoid (HashMap Text SecurityScheme) where
981+instance ToJSON ParamLocation where
832− swaggerMempty = HashMap.empty
982+ toJSON = genericToJSON (jsonPrefix "Param")
833− swaggerMappend = flip HashMap.union
835−instance SwaggerMonoid (HashMap FilePath PathItem) where
984+instance ToJSON Info where
836− swaggerMempty = HashMap.empty
985+ toJSON = genericToJSON (jsonPrefix "Info")
837− swaggerMappend = HashMap.unionWith mappend
839−instance SwaggerMonoid (HashMap HeaderName Header) where
987+instance ToJSON Contact where
840− swaggerMempty = HashMap.empty
988+ toJSON = genericToJSON (jsonPrefix "Contact")
841− swaggerMappend = flip HashMap.union
843−instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
990+instance ToJSON License where
844− swaggerMempty = HashMap.empty
991+ toJSON = genericToJSON (jsonPrefix "License")
845− swaggerMappend = flip HashMap.union
847−instance SwaggerMonoid ParamAnySchema where
993+instance ToJSON ApiKeyLocation where
848− swaggerMempty = ParamOther swaggerMempty
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
849− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
995+
850− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
996+instance ToJSON ApiKeyParams where
851− 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")
853-- =======================================================================
1011-- =======================================================================
854−-- TH derived ToJSON and FromJSON instances
1012+-- Simple Generic-based FromJSON instances
855-- =======================================================================
1013-- =======================================================================
857−deriveJSON (jsonPrefix "Param") ''ParamLocation
1015+instance FromJSON ParamLocation where
858−deriveJSON' ''Info
1016+ parseJSON = genericParseJSON (jsonPrefix "Param")
859−deriveJSON' ''Contact
1017+
860−deriveJSON' ''License
1018+instance FromJSON Info where
861−deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
1019+ parseJSON = genericParseJSON (jsonPrefix "Info")
862−deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
863−deriveJSONDefault ''Scheme
865−deriveJSON' ''ExternalDocs
867−deriveToJSON' ''Xml
1021+instance FromJSON Contact where
1022+ parseJSON = genericParseJSON (jsonPrefix "Contact")
1024+instance FromJSON License where
1025+ parseJSON = genericParseJSON (jsonPrefix "License")
1027+instance FromJSON ApiKeyLocation where
1028+ parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1030+instance FromJSON ApiKeyParams where
1031+ parseJSON = genericParseJSON (jsonPrefix "apiKey")
1033+instance FromJSON Scheme where
1034+ parseJSON = genericParseJSON (jsonPrefix "")
1036+instance FromJSON Tag where
1037+ parseJSON = genericParseJSON (jsonPrefix "Tag")
1039+instance FromJSON ExternalDocs where
1040+ parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
869-- =======================================================================
1042-- =======================================================================
870-- Manual ToJSON instances
1043-- Manual ToJSON instances
@@ -886,7 +1059,8 @@ instance ToJSON OAuth2Flow where
886 , "tokenUrl" .= tokenUrl ]
1059 , "tokenUrl" .= tokenUrl ]
888instance ToJSON OAuth2Params where
1061instance ToJSON OAuth2Params where
889− toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1062+ toJSON = sopSwaggerGenericToJSON
891instance ToJSON SecuritySchemeType where
1065instance ToJSON SecuritySchemeType where
892 toJSON SecuritySchemeBasic
1066 toJSON SecuritySchemeBasic
@@ -899,22 +1073,38 @@ instance ToJSON SecuritySchemeType where
899 <+> object [ "type" .= ("oauth2" :: Text) ]
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
901instance ToJSON Swagger where
1075instance ToJSON Swagger where
902− toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
1076+ toJSON = sopSwaggerGenericToJSON
903− where
1077+ DEFINE_TOENCODING
904− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
905− addVersion _ = error "impossible"
907instance ToJSON SecurityScheme where
1079instance ToJSON SecurityScheme where
908− toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1080+ toJSON = sopSwaggerGenericToJSON
910instance ToJSON Schema where
1083instance ToJSON Schema where
911− toJSON = omitEmpties . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1084+ toJSON = sopSwaggerGenericToJSON
913instance ToJSON Header where
1087instance ToJSON Header where
914− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
1088+ toJSON = sopSwaggerGenericToJSON
915−
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}"
916−instance ToJSON Items where
1097+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
917− 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 ]
919instance ToJSON Host where
1109instance ToJSON Host where
920 toJSON (Host host mport) = toJSON $
1110 toJSON (Host host mport) = toJSON $
@@ -922,42 +1112,43 @@ instance ToJSON Host where
922 Nothing -> host
1112 Nothing -> host
923 Just port -> host ++ ":" ++ show port
1113 Just port -> host ++ ":" ++ show port
925−instance ToJSON Paths where
926− toJSON (Paths m) = toJSON m
928instance ToJSON MimeList where
1115instance ToJSON MimeList where
929 toJSON (MimeList xs) = toJSON (map show xs)
1116 toJSON (MimeList xs) = toJSON (map show xs)
931instance ToJSON Param where
1118instance ToJSON Param where
932− toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1119+ toJSON = sopSwaggerGenericToJSON
934instance ToJSON ParamAnySchema where
1122instance ToJSON ParamAnySchema where
935 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
936 toJSON (ParamOther s) = toJSON s
1124 toJSON (ParamOther s) = toJSON s
938instance ToJSON ParamOtherSchema where
1126instance ToJSON ParamOtherSchema where
939− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1127+ toJSON = sopSwaggerGenericToJSON
940−
1128+ DEFINE_TOENCODING
941−instance ToJSON SchemaItems where
942− toJSON (SchemaItemsObject x) = toJSON x
943− toJSON (SchemaItemsArray xs) = toJSON xs
945instance ToJSON Responses where
1130instance ToJSON Responses where
946− toJSON (Responses def rs) = omitEmpties $
1131+ toJSON = sopSwaggerGenericToJSON
947− toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1132+ DEFINE_TOENCODING
949instance ToJSON Response where
1134instance ToJSON Response where
950− toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1135+ toJSON = sopSwaggerGenericToJSON
952instance ToJSON Operation where
1138instance ToJSON Operation where
953− toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1139+ toJSON = sopSwaggerGenericToJSON
955instance ToJSON PathItem where
1142instance ToJSON PathItem where
956− toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1143+ toJSON = sopSwaggerGenericToJSON
958instance ToJSON Example where
1146instance ToJSON Example where
959 toJSON = toJSON . Map.mapKeys show . getExample
1147 toJSON = toJSON . Map.mapKeys show . getExample
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
961instance ToJSON Reference where
1152instance ToJSON Reference where
962 toJSON (Reference ref) = object [ "$ref" .= ref ]
1153 toJSON (Reference ref) = object [ "$ref" .= ref ]
@@ -986,8 +1177,14 @@ instance ToJSON (CollectionFormat t) where
986 toJSON CollectionPipes = "pipes"
1177 toJSON CollectionPipes = "pipes"
987 toJSON CollectionMulti = "multi"
1178 toJSON CollectionMulti = "multi"
989−instance ToJSON i => ToJSON (ParamSchema t i) where
1180+instance ToJSON (ParamSchema k) where
990− 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
992-- =======================================================================
1189-- =======================================================================
993-- Manual FromJSON instances
1190-- Manual FromJSON instances
@@ -1007,7 +1204,7 @@ instance FromJSON OAuth2Flow where
1007 parseJSON _ = empty
1204 parseJSON _ = empty
1009instance FromJSON OAuth2Params where
1206instance FromJSON OAuth2Params where
1010− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1207+ parseJSON = sopSwaggerGenericParseJSON
1012instance FromJSON SecuritySchemeType where
1209instance FromJSON SecuritySchemeType where
1013 parseJSON js@(Object o) = do
1210 parseJSON js@(Object o) = do
@@ -1020,53 +1217,65 @@ instance FromJSON SecuritySchemeType where
1020 parseJSON _ = empty
1217 parseJSON _ = empty
1022instance FromJSON Swagger where
1219instance FromJSON Swagger where
1023− parseJSON js@(Object o) = do
1220+ parseJSON = sopSwaggerGenericParseJSON
1024− (version :: Text) <- o .: "swagger"
1025− when (version /= "2.0") empty
1026− (genericParseJSON (jsonPrefix "")
1027− `withDefaults` [ "consumes" .= (mempty :: MimeList)
1028− , "produces" .= (mempty :: MimeList)
1029− , "security" .= ([] :: [SecurityRequirement])
1030− , "tags" .= ([] :: [Tag])
1031− , "definitions" .= (mempty :: HashMap Text Schema)
1032− , "parameters" .= (mempty :: HashMap Text Param)
1033− , "responses" .= (mempty :: HashMap Text Response)
1034− , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
1036− parseJSON _ = empty
1038instance FromJSON SecurityScheme where
1222instance FromJSON SecurityScheme where
1039− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1223+ parseJSON = sopSwaggerGenericParseJSON
1041instance FromJSON Schema where
1225instance FromJSON Schema where
1042− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1226+ parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1043− `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1227+ where nullaryCleanup :: Schema -> Schema
1044− , "required" .= ([] :: [ParamName]) ]
1228+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230+ then s { _schemaExample = Nothing
1231+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1046instance FromJSON Header where
1234instance FromJSON Header where
1047− 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)
1049−instance FromJSON Items where
1242+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1050− 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
1052instance FromJSON Host where
1265instance FromJSON Host where
1053− parseJSON (String s) =
1266+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1054− case fromInteger <$> readMaybe portStr of
1267+ [host] -> return $ Host host Nothing
1055− Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1268+ [host, port] -> case readMaybe port of
1056− mport -> pure $ Host host mport
1269+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1057− where
1270+ Just p -> return $ Host host (Just (fromInteger p))
1058− (hostText, portText) = Text.breakOn ":" s
1271+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1059− [host, portStr] = map Text.unpack [hostText, portText]
1060 parseJSON _ = empty
1272 parseJSON _ = empty
1062−instance FromJSON Paths where
1063− parseJSON js = Paths <$> parseJSON js
1065instance FromJSON MimeList where
1274instance FromJSON MimeList where
1066 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1068instance FromJSON Param where
1277instance FromJSON Param where
1069− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1278+ parseJSON = sopSwaggerGenericParseJSON
1071instance FromJSON ParamAnySchema where
1280instance FromJSON ParamAnySchema where
1072 parseJSON js@(Object o) = do
1281 parseJSON js@(Object o) = do
@@ -1079,17 +1288,12 @@ instance FromJSON ParamAnySchema where
1079 parseJSON _ = empty
1288 parseJSON _ = empty
1081instance FromJSON ParamOtherSchema where
1290instance FromJSON ParamOtherSchema where
1082− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1291+ parseJSON = sopSwaggerGenericParseJSON
1084−instance FromJSON SchemaItems where
1085− parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
1086− parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
1087− parseJSON _ = empty
1089instance FromJSON Responses where
1293instance FromJSON Responses where
1090 parseJSON (Object o) = Responses
1294 parseJSON (Object o) = Responses
1091 <$> o .:? "default"
1295 <$> o .:? "default"
1092− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
1093 parseJSON _ = empty
1297 parseJSON _ = empty
1095instance FromJSON Example where
1299instance FromJSON Example where
@@ -1098,16 +1302,16 @@ instance FromJSON Example where
1098 pure $ Example (Map.mapKeys fromString m)
1302 pure $ Example (Map.mapKeys fromString m)
1100instance FromJSON Response where
1304instance FromJSON Response where
1101− parseJSON = genericParseJSON (jsonPrefix "response")
1305+ parseJSON = sopSwaggerGenericParseJSON
1102− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1104instance FromJSON Operation where
1307instance FromJSON Operation where
1105− parseJSON = genericParseJSON (jsonPrefix "operation")
1308+ parseJSON = sopSwaggerGenericParseJSON
1106− `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1108instance FromJSON PathItem where
1310instance FromJSON PathItem where
1109− parseJSON = genericParseJSON (jsonPrefix "pathItem")
1311+ parseJSON = sopSwaggerGenericParseJSON
1110− `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1312+
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
1112instance FromJSON Reference where
1316instance FromJSON Reference where
1113 parseJSON (Object o) = Reference <$> o .: "$ref"
1317 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1124,6 +1328,7 @@ referencedParseJSON prefix js@(Object o) = do
1124 case Text.stripPrefix prefix s of
1328 case Text.stripPrefix prefix s of
1125 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1329 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1126 Just suffix -> pure (Reference suffix)
1330 Just suffix -> pure (Reference suffix)
1331+referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
1128instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1333instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1129instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
1334instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1132,23 +1337,91 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
1132instance FromJSON Xml where
1337instance FromJSON Xml where
1133 parseJSON = genericParseJSON (jsonPrefix "xml")
1338 parseJSON = genericParseJSON (jsonPrefix "xml")
1135−instance FromJSON (SwaggerType Schema) where
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1136 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1341 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1138−instance FromJSON (SwaggerType ParamOtherSchema) where
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1139 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1344 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1141−instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1142 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1347 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1144−instance FromJSON (CollectionFormat Param) where
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1145− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1147−instance FromJSON (CollectionFormat Items) where
1148 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1350 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1150−-- NOTE: The constraint @FromJSON (SwaggerType t)@ is necessary here!
1352+-- NOTE: There aren't collections of 'Schema'
1151−-- Without the constraint the general instance will be used
1353+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1152−-- 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]
1153−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
1154− 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