@@ -1,7 +1,4 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
31{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
52{-# LANGUAGE DeriveGeneric #-}
63{-# LANGUAGE DeriveTraversable #-}
74{-# LANGUAGE FlexibleContexts #-}
@@ -13,127 +10,89 @@
1310{-# LANGUAGE ScopedTypeVariables #-}
1411{-# LANGUAGE StandaloneDeriving #-}
1512{-# LANGUAGE TemplateHaskell #-}
16−{-# LANGUAGE TypeFamilies #-}
17−{-# LANGUAGE UndecidableInstances #-}
18−#if __GLASGOW_HASKELL__ <710
19−{-# LANGUAGE PolyKinds #-}
20−#endif
21−#include "overlapping-compat.h"
2213module Data.Swagger.Internal where
2314
24−import Prelude ()
25−import Prelude.Compat
26−
27−import Control.Lens ((&), (.~), (?~))
2815import Control.Applicative
16+import Control.Monad
2917import Data.Aeson
18+import Data.Aeson.TH (deriveJSON)
3019import qualified Data.Aeson.Types as JSON
3120import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32−import Data.Hashable (Hashable)
21+import Data.HashMap.Strict (HashMap)
3322import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
3523import Data.Map (Map)
3624import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
38−import Data.Semigroup.Compat (Semigroup (..))
25+import Data.Monoid
3926import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
27+import Data.String (fromString)
4128import Data.Text (Text)
4229import qualified Data.Text as Text
4330import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
31+import Network (HostName, PortNumber)
4532import Network.HTTP.Media (MediaType)
4633import Text.Read (readMaybe)
4734
48−import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49−import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50−
51−import Generics.SOP.TH (deriveGeneric)
52−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53− ,sopSwaggerGenericToJSONWithOpts
54− ,sopSwaggerGenericParseJSON
55− ,HasSwaggerAesonOptions(..)
56− ,AesonDefaultValue(..)
57− ,mkSwaggerAesonOptions
58− ,saoAdditionalPairs
59− ,saoSubObject)
6035import Data.Swagger.Internal.Utils
6136
62−#if MIN_VERSION_aeson(0,10,0)
63−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64−#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
65−#else
66−#define DEFINE_TOENCODING
67−#endif
68−
69−-- $setup
70−-- >>> :seti -XDataKinds
71−-- >>> import Data.Aeson
72−
73−-- | A list of definitions that can be used in references.
74−type Definitions = InsOrdHashMap Text
75−
7637-- | This is the root document object for the API specification.
7738data Swagger = Swagger
7839 { -- | Provides metadata about the API.
7940 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
41+ _info :: Info
8142
8243 -- | The host (name or ip) serving the API. It MAY include a port.
8344 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
45+ , _host :: Maybe Host
8546
8647 -- | The base path on which the API is served, which is relative to the host.
8748 -- If it is not included, the API is served directly under the host.
8849 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
50+ , _basePath :: Maybe FilePath
9051
9152 -- | The transfer protocol of the API.
9253 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
93− , _swaggerSchemes :: Maybe [Scheme]
54+ , _schemes :: Maybe [Scheme]
9455
9556 -- | A list of MIME types the APIs can consume.
9657 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
58+ , _consumes :: MimeList
9859
9960 -- | A list of MIME types the APIs can produce.
100− -- This is global to all APIs but can be overridden on specific API calls.
101− , _swaggerProduces :: MimeList
61+ -- This is global to all APIs but can be overridden on specific API calls.
62+ , _produces :: MimeList
10263
10364 -- | The available paths and operations for the API.
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
65+ , _paths :: Paths
10766
10867 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
68+ , _definitions :: HashMap Text Schema
11069
11170 -- | An object to hold parameters that can be used across operations.
11271 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
72+ , _parameters :: HashMap Text Param
11473
11574 -- | An object to hold responses that can be used across operations.
11675 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
76+ , _responses :: HashMap Text Response
11877
11978 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
79+ , _securityDefinitions :: HashMap Text SecurityScheme
12180
12281 -- | A declaration of which security schemes are applied for the API as a whole.
12382 -- The list of values describes alternative security schemes that can be used
12483 -- (that is, there is a logical OR between the security requirements).
12584 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
85+ , _security :: [SecurityRequirement]
12786
12887 -- | A list of tags used by the specification with additional metadata.
12988 -- The order of the tags can be used to reflect on their order by the parsing tools.
13089 -- Not all tags that are used by the Operation Object must be declared.
13190 -- The tags that are not declared may be organized randomly or based on the tools' logic.
13291 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
92+ , _tags :: [Tag]
13493
13594 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
95+ , _externalDocs :: Maybe ExternalDocs
13796 } deriving (Eq, Show, Generic, Data, Typeable)
13897
13998-- | The object provides metadata about the API.
@@ -182,18 +141,12 @@ data License = License
182141 , _licenseUrl :: Maybe URL
183142 } deriving (Eq, Show, Generic, Data, Typeable)
184143
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
187−
188144-- | The host (name or ip) serving the API. It MAY include a port.
189145data Host = Host
190146 { _hostName :: HostName -- ^ Host name.
191147 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192148 } deriving (Eq, Show, Generic, Typeable)
193149
194−instance IsString Host where
195− fromString s = Host s Nothing
196−
197150hostConstr :: Constr
198151hostConstr = mkConstr hostDataType "Host" [] Prefix
199152
@@ -215,6 +168,13 @@ data Scheme
215168 | Wss
216169 deriving (Eq, Show, Generic, Data, Typeable)
217170
171+-- | The available paths and operations for the API.
172+data Paths = Paths
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)
177+
218178-- | Describes the operations available on a single path.
219179-- A @'PathItem'@ may be empty, due to ACL constraints.
220180-- The path itself is still exposed to the documentation viewer
@@ -252,7 +212,7 @@ data PathItem = PathItem
252212data Operation = Operation
253213 { -- | A list of tags for API documentation control.
254214 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
215+ _operationTags :: [Text]
256216
257217 -- | A short summary of what the operation does.
258218 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -309,7 +269,7 @@ data Operation = Operation
309269 } deriving (Eq, Show, Generic, Data, Typeable)
310270
311271newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
272+ deriving (Eq, Show, Monoid, Typeable)
313273
314274mimeListConstr :: Constr
315275mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -360,92 +320,12 @@ data ParamOtherSchema = ParamOtherSchema
360320 -- Default value is @False@.
361321 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362322
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
364− } deriving (Eq, Show, Generic, Typeable, Data)
365−
366−-- | Items for @'SwaggerArray'@ schemas.
367−--
368−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
369−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
370−-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
371−-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
372−--
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
374−--
375−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
376−data SwaggerItems t where
377− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
378− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
379− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
380− deriving (Typeable)
381−
382−deriving instance Eq (SwaggerItems t)
383−deriving instance Show (SwaggerItems t)
384−--deriving instance Typeable (SwaggerItems t)
385−
386−swaggerItemsPrimitiveConstr :: Constr
387−swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388−
389−swaggerItemsObjectConstr :: Constr
390−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391−
392−swaggerItemsArrayConstr :: Constr
393−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394−
395−swaggerItemsDataType :: DataType
396−swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397−
398−-- Note: unfortunately we have to write these Data instances by hand,
399−-- to get better contexts / avoid duplicate name when using standalone deriving
400−
401−instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
402− -- TODO: define gfoldl
403− gunfold k z c = case constrIndex c of
404− 1 -> k (k (z SwaggerItemsPrimitive))
405− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406− toConstr _ = swaggerItemsPrimitiveConstr
407− dataTypeOf _ = swaggerItemsDataType
408−
409−-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
410−instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411− -- TODO: define gfoldl
412− gunfold k z c = case constrIndex c of
413− 1 -> k (k (z SwaggerItemsPrimitive))
414− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415− toConstr _ = swaggerItemsPrimitiveConstr
416− dataTypeOf _ = swaggerItemsDataType
323+ -- | Determines the format of the array if @'ParamArray'@ is used.
324+ -- Default value is csv.
325+ , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
417326
418−instance Data (SwaggerItems 'SwaggerKindSchema) where
419− gfoldl _ _ (SwaggerItemsPrimitive _ _) = error $ " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
420− gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
421− gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
422−
423− gunfold k z c = case constrIndex c of
424− 2 -> k (z SwaggerItemsObject)
425− 3 -> k (z SwaggerItemsArray)
426− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
427−
428− toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429− toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430− toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
431−
432− dataTypeOf _ = swaggerItemsDataType
433−
434−-- | Type used as a kind to avoid overlapping instances.
435−data SwaggerKind t
436− = SwaggerKindNormal t
437− | SwaggerKindParamOtherSchema
438− | SwaggerKindSchema
439− deriving (Typeable)
440−
441−deriving instance Typeable 'SwaggerKindNormal
442−deriving instance Typeable 'SwaggerKindParamOtherSchema
443−deriving instance Typeable 'SwaggerKindSchema
444−
445−type family SwaggerKindType (k :: SwaggerKind *) :: *
446−type instance SwaggerKindType ('SwaggerKindNormal t) = t
447−type instance SwaggerKindType 'SwaggerKindSchema = Schema
448−type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
327+ , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema Items
328+ } deriving (Eq, Show, Generic, Data, Typeable)
449329
450330data SwaggerType t where
451331 SwaggerString :: SwaggerType t
@@ -453,47 +333,81 @@ data SwaggerType t where
453333 SwaggerInteger :: SwaggerType t
454334 SwaggerBoolean :: SwaggerType t
455335 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
459− deriving (Typeable)
336+ SwaggerFile :: SwaggerType ParamOtherSchema
337+ SwaggerNull :: SwaggerType Schema
338+ SwaggerObject :: SwaggerType Schema
460339
461340deriving instance Eq (SwaggerType t)
462341deriving instance Show (SwaggerType t)
342+deriving instance Typeable (SwaggerType t)
463343
464−swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465−swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
344+swaggerStringConstr :: DataType -> Constr
345+swaggerStringConstr dt = mkConstr dt "SwaggerString" [] Prefix
466346
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468−swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
347+swaggerNumberConstr :: DataType -> Constr
348+swaggerNumberConstr dt = mkConstr dt "SwaggerNumber" [] Prefix
469349
470−swaggerCommonTypes :: [SwaggerType k]
471−swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
350+swaggerIntegerConstr :: DataType -> Constr
351+swaggerIntegerConstr dt = mkConstr dt "SwaggerInteger" [] Prefix
472352
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474−swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
353+swaggerBooleanConstr :: DataType -> Constr
354+swaggerBooleanConstr dt = mkConstr dt "SwaggerBoolean" [] Prefix
475355
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477−swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
356+swaggerArrayConstr :: DataType -> Constr
357+swaggerArrayConstr dt = mkConstr dt "SwaggerArray" [] Prefix
478358
479−swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481− ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
359+swaggerFileConstr :: DataType -> Constr
360+swaggerFileConstr dt = mkConstr dt "SwaggerFile" [] Prefix
482361
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484− gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485− toConstr = swaggerTypeConstr
486− dataTypeOf = swaggerTypeDataType
362+swaggerNullConstr :: DataType -> Constr
363+swaggerNullConstr dt = mkConstr dt "SwaggerNull" [] Prefix
487364
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490− toConstr = swaggerTypeConstr
491− dataTypeOf = swaggerTypeDataType
365+swaggerObjectConstr :: DataType -> Constr
366+swaggerObjectConstr dt = mkConstr dt "SwaggerObject" [] Prefix
492367
493−instance Data (SwaggerType 'SwaggerKindSchema) where
494− gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495− toConstr = swaggerTypeConstr
496− dataTypeOf = swaggerTypeDataType
368+swaggerTypeDataType :: [DataType -> Constr] -> DataType
369+swaggerTypeDataType extra = dt
370+ where
371+ dt = mkDataType "Data.Swagger.SwaggerType" $ map ($ dt) $
372+ [ swaggerStringConstr, swaggerNumberConstr, swaggerIntegerConstr, swaggerBooleanConstr , swaggerArrayConstr ]
373+ ++ extra
374+
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
385+ where
386+ dt = dataTypeOf t
387+
388+instance Data (SwaggerType Items) where
389+ gunfold = gunfoldEnum "SwaggerType Items" $ zip [1..]
390+ [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
391+ toConstr = swaggerTypeToConstr
392+ dataTypeOf _ = swaggerTypeDataType []
393+
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 []
399+
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]
405+
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]
497411
498412data ParamLocation
499413 = -- | Parameters that are appended to the URL.
@@ -530,28 +444,40 @@ data CollectionFormat t where
530444 -- Corresponds to multiple parameter instances
531445 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532446 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
447+ CollectionMulti :: CollectionFormat Param
535448
536449deriving instance Eq (CollectionFormat t)
537450deriving instance Show (CollectionFormat t)
451+deriving instance Typeable (CollectionFormat t)
452+
453+collectionCsvConstr :: Constr
454+collectionCsvConstr = mkConstr collectionFormatDataType "CollectionCSV" [] Prefix
455+
456+collectionSsvConstr :: Constr
457+collectionSsvConstr = mkConstr collectionFormatDataType "CollectionSSV" [] Prefix
538458
539−collectionFormatConstr :: CollectionFormat t -> Constr
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
459+collectionTsvConstr :: Constr
460+collectionTsvConstr = mkConstr collectionFormatDataType "CollectionTSV" [] Prefix
461+
462+collectionPipesConstr :: Constr
463+collectionPipesConstr = mkConstr collectionFormatDataType "CollectionPipes" [] Prefix
541464
542465collectionFormatDataType :: DataType
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
544− map collectionFormatConstr collectionCommonFormats
466+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat"
467+ [ collectionCsvConstr, collectionSsvConstr, collectionTsvConstr, collectionPipesConstr ]
468+
469+instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
470+ gunfold = gunfoldEnum "CollectionFormat" $ zip [1..]
471+ [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
545472
546−collectionCommonFormats :: [CollectionFormat t]
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
473+ toConstr CollectionCSV = collectionCsvConstr
474+ toConstr CollectionSSV = collectionSsvConstr
475+ toConstr CollectionTSV = collectionTsvConstr
476+ toConstr CollectionPipes = collectionPipesConstr
548477
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551− toConstr = collectionFormatConstr
552478 dataTypeOf _ = collectionFormatDataType
553479
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
480+deriving instance {-# OVERLAPPING #-} Data (CollectionFormat Param)
555481
556482type ParamName = Text
557483
@@ -560,9 +486,9 @@ data Schema = Schema
560486 , _schemaDescription :: Maybe Text
561487 , _schemaRequired :: [ParamName]
562488
563− , _schemaAllOf :: Maybe [Referenced Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
489+ , _schemaAllOf :: Maybe [Schema]
490+ , _schemaProperties :: HashMap Text (Referenced Schema)
491+ , _schemaAdditionalProperties :: Maybe Schema
566492
567493 , _schemaDiscriminator :: Maybe Text
568494 , _schemaReadOnly :: Maybe Bool
@@ -573,20 +499,15 @@ data Schema = Schema
573499 , _schemaMaxProperties :: Maybe Integer
574500 , _schemaMinProperties :: Maybe Integer
575501
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
577− } deriving (Eq, Show, Generic, Data, Typeable)
578−
579−-- | A @'Schema'@ with an optional name.
580−-- This name can be used in references.
581−data NamedSchema = NamedSchema
582− { _namedSchemaName :: Maybe Text
583− , _namedSchemaSchema :: Schema
502+ , _schemaParamSchema :: ParamSchema Schema SchemaItems
584503 } deriving (Eq, Show, Generic, Data, Typeable)
585504
586−-- | Regex pattern for @string@ type.
587−type Pattern = Text
505+data SchemaItems
506+ = SchemaItemsObject (Referenced Schema)
507+ | SchemaItemsArray [Referenced Schema]
508+ deriving (Eq, Show, Generic, Data, Typeable)
588509
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
510+data ParamSchema t items = ParamSchema
590511 { -- | Declares the value of the parameter that the server will use if none is provided,
591512 -- for example a @"count"@ to control the number of results per page might default to @100@
592513 -- if not supplied by the client in the request.
@@ -594,16 +515,16 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
594515 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595516 _paramSchemaDefault :: Maybe Value
596517
597− , _paramSchemaType :: Maybe (SwaggerType t)
518+ , _paramSchemaType :: SwaggerType t
598519 , _paramSchemaFormat :: Maybe Format
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
520+ , _paramSchemaItems :: Maybe items
600521 , _paramSchemaMaximum :: Maybe Scientific
601522 , _paramSchemaExclusiveMaximum :: Maybe Bool
602523 , _paramSchemaMinimum :: Maybe Scientific
603524 , _paramSchemaExclusiveMinimum :: Maybe Bool
604525 , _paramSchemaMaxLength :: Maybe Integer
605526 , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
527+ , _paramSchemaPattern :: Maybe Text
607528 , _paramSchemaMaxItems :: Maybe Integer
608529 , _paramSchemaMinItems :: Maybe Integer
609530 , _paramSchemaUniqueItems :: Maybe Bool
@@ -611,11 +532,11 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
611532 , _paramSchemaMultipleOf :: Maybe Scientific
612533 } deriving (Eq, Show, Generic, Typeable)
613534
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
535+deriving instance (Data t, Data (SwaggerType t), Data i) => Data (ParamSchema t i)
615536
616537data Xml = Xml
617538 { -- | Replaces the name of the element/attribute used for the described schema property.
618− -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
539+ -- When defined within the @'Items'@ (items), it will affect the name of the individual XML elements within the list.
619540 -- When defined alongside type being array (outside the items),
620541 -- it will affect the wrapping element and only if wrapped is true.
621542 -- If wrapped is false, it will be ignored.
@@ -641,6 +562,14 @@ data Xml = Xml
641562 , _xmlWrapped :: Maybe Bool
642563 } deriving (Eq, Show, Generic, Data, Typeable)
643564
565+data Items = Items
566+ { -- | Determines the format of the array if type array is used.
567+ -- Default value is @'ItemsCollectionCSV'@.
568+ _itemsCollectionFormat :: Maybe (CollectionFormat Items)
569+
570+ , _itemsParamSchema :: ParamSchema Items Items
571+ } deriving (Eq, Show, Generic, Data, Typeable)
572+
644573-- | A container for the expected responses of an operation.
645574-- The container maps a HTTP response code to the expected response.
646575-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
@@ -653,7 +582,7 @@ data Responses = Responses
653582
654583 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655584 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
585+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657586 } deriving (Eq, Show, Generic, Data, Typeable)
658587
659588type HttpStatusCode = Int
@@ -672,22 +601,23 @@ data Response = Response
672601 , _responseSchema :: Maybe (Referenced Schema)
673602
674603 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
604+ , _responseHeaders :: HashMap HeaderName Header
676605
677606 -- | An example of the response message.
678607 , _responseExamples :: Maybe Example
679608 } deriving (Eq, Show, Generic, Data, Typeable)
680609
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
683−
684610type HeaderName = Text
685611
686612data Header = Header
687613 { -- | A short description of the header.
688614 _headerDescription :: Maybe Text
689615
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
616+ -- | Determines the format of the array if type array is used.
617+ -- Default value is @'ItemsCollectionCSV'@.
618+ , _headerCollectionFormat :: Maybe (CollectionFormat Items)
619+
620+ , _headerParamSchema :: ParamSchema Header Items
691621 } deriving (Eq, Show, Generic, Data, Typeable)
692622
693623data Example = Example { getExample :: Map MediaType Value }
@@ -738,7 +668,7 @@ data OAuth2Params = OAuth2Params
738668 _oauth2Flow :: OAuth2Flow
739669
740670 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
671+ , _oauth2Scopes :: HashMap Text Text
742672 } deriving (Eq, Show, Generic, Data, Typeable)
743673
744674data SecuritySchemeType
@@ -755,37 +685,18 @@ data SecurityScheme = SecurityScheme
755685 , _securitySchemeDescription :: Maybe Text
756686 } deriving (Eq, Show, Generic, Data, Typeable)
757687
758−
759−-- | merge scopes of two OAuth2 security schemes when their flows are identical.
760−-- In other case returns first security scheme
761−mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
762−mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
763− s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
764− = if flow1 == flow2 then
765− SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
766− else
767− s1
768−mergeSecurityScheme s1 _ = s1
769−
770−newtype SecurityDefinitions
771− = SecurityDefinitions (Definitions SecurityScheme)
772− deriving (Eq, Show, Generic, Data, Typeable)
773−
774688-- | Lists the required security schemes to execute this operation.
775689-- The object can have multiple security schemes declared in it which are all required
776690-- (that is, there is a logical AND between the schemes).
777691newtype SecurityRequirement = SecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
779− } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
780−
781−-- | Tag name.
782−type TagName = Text
692+ { getSecurityRequirement :: HashMap Text [Text]
693+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
783694
784695-- | Allows adding meta data to a single tag that is used by @Operation@.
785696-- It is not mandatory to have a @Tag@ per tag used there.
786697data Tag = Tag
787698 { -- | The name of the tag.
788− _tagName :: TagName
699+ _tagName :: Text
789700
790701 -- | A short description for the tag.
791702 -- GFM syntax can be used for rich text representation.
@@ -793,12 +704,7 @@ data Tag = Tag
793704
794705 -- | Additional external documentation for this tag.
795706 , _tagExternalDocs :: Maybe ExternalDocs
796− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
797−
798−instance Hashable Tag
799−
800−instance IsString Tag where
801− fromString s = Tag (fromString s) Nothing Nothing
707+ } deriving (Eq, Show, Generic, Data, Typeable)
802708
803709-- | Allows referencing an external resource for extended documentation.
804710data ExternalDocs = ExternalDocs
@@ -808,9 +714,7 @@ data ExternalDocs = ExternalDocs
808714
809715 -- | The URL for the target documentation.
810716 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812−
813−instance Hashable ExternalDocs
717+ } deriving (Eq, Show, Generic, Data, Typeable)
814718
815719-- | A simple object to allow referencing other definitions in the specification.
816720-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -820,133 +724,77 @@ newtype Reference = Reference { getReference :: Text }
820724data Referenced a
821725 = Ref Reference
822726 | Inline a
823− deriving (Eq, Show, Functor, Data, Typeable)
824−
825−instance IsString a => IsString (Referenced a) where
826− fromString = Inline . fromString
827−
828−newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
829−
830−data AdditionalProperties
831− = AdditionalPropertiesAllowed Bool
832− | AdditionalPropertiesSchema (Referenced Schema)
833727 deriving (Eq, Show, Data, Typeable)
834728
729+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
730+
835731-- =======================================================================
836732-- Monoid instances
837733-- =======================================================================
838734
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841735instance Monoid Swagger where
842736 mempty = genericMempty
843− mappend = (<>)
737+ mappend = genericMappend
844738
845−instance Semigroup Info where
846− (<>) = genericMappend
847739instance Monoid Info where
848740 mempty = genericMempty
849− mappend = (<>)
741+ mappend = genericMappend
850742
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
743+instance Monoid Paths where
854744 mempty = genericMempty
855− mappend = (<>)
745+ mappend = genericMappend
856746
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859747instance Monoid PathItem where
860748 mempty = genericMempty
861− mappend = (<>)
749+ mappend = genericMappend
862750
863−instance Semigroup Schema where
864− (<>) = genericMappend
865751instance Monoid Schema where
866752 mempty = genericMempty
867− mappend = (<>)
753+ mappend = genericMappend
868754
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
755+instance Monoid (ParamSchema t i) where
872756 mempty = genericMempty
873− mappend = (<>)
757+ mappend = genericMappend
874758
875−instance Semigroup Param where
876− (<>) = genericMappend
877759instance Monoid Param where
878760 mempty = genericMempty
879− mappend = (<>)
761+ mappend = genericMappend
880762
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883763instance Monoid ParamOtherSchema where
884764 mempty = genericMempty
885− mappend = (<>)
765+ mappend = genericMappend
886766
887−instance Semigroup Header where
888− (<>) = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
891− mappend = (<>)
892−
893−instance Semigroup Responses where
894− (<>) = genericMappend
895767instance Monoid Responses where
896768 mempty = genericMempty
897− mappend = (<>)
769+ mappend = genericMappend
898770
899−instance Semigroup Response where
900− (<>) = genericMappend
901771instance Monoid Response where
902772 mempty = genericMempty
903− mappend = (<>)
773+ mappend = genericMappend
904774
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907775instance Monoid ExternalDocs where
908776 mempty = genericMempty
909− mappend = (<>)
777+ mappend = genericMappend
910778
911−instance Semigroup Operation where
912− (<>) = genericMappend
913779instance Monoid Operation where
914780 mempty = genericMempty
915− mappend = (<>)
916−
917−instance Semigroup Example where
918− (<>) = genericMappend
919−instance Monoid Example where
920− mempty = genericMempty
921− mappend = (<>)
922−
923−instance Semigroup SecurityScheme where
924− (<>) = mergeSecurityScheme
925−
926−instance Semigroup SecurityDefinitions where
927− (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928− SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
929−
930−instance Monoid SecurityDefinitions where
931− mempty = SecurityDefinitions $ InsOrdHashMap.empty
932− mappend = (<>)
781+ mappend = genericMappend
933782
934783-- =======================================================================
935784-- SwaggerMonoid helper instances
936785-- =======================================================================
937786
938787instance SwaggerMonoid Info
788+instance SwaggerMonoid Paths
939789instance SwaggerMonoid PathItem
940790instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
791+instance SwaggerMonoid (ParamSchema t i)
942792instance SwaggerMonoid Param
943793instance SwaggerMonoid ParamOtherSchema
944794instance SwaggerMonoid Responses
945795instance SwaggerMonoid Response
946796instance SwaggerMonoid ExternalDocs
947797instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950798
951799instance SwaggerMonoid MimeList
952800deriving instance SwaggerMonoid URL
@@ -959,85 +807,64 @@ instance SwaggerMonoid ParamLocation where
959807 swaggerMempty = ParamQuery
960808 swaggerMappend _ y = y
961809
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
810+instance SwaggerMonoid (HashMap Text Schema) where
811+ swaggerMempty = HashMap.empty
812+ swaggerMappend = HashMap.unionWith mappend
813+
814+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
815+ swaggerMempty = HashMap.empty
816+ swaggerMappend = HashMap.unionWith swaggerMappend
965817
966818instance Monoid a => SwaggerMonoid (Referenced a) where
967819 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
820+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
969821 swaggerMappend _ y = y
970822
971−instance SwaggerMonoid ParamAnySchema where
972− swaggerMempty = ParamOther swaggerMempty
973− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975− swaggerMappend _ y = y
823+instance SwaggerMonoid (HashMap Text Param) where
824+ swaggerMempty = HashMap.empty
825+ swaggerMappend = HashMap.unionWith mappend
976826
977−-- =======================================================================
978−-- Simple Generic-based ToJSON instances
979−-- =======================================================================
980−
981−instance ToJSON ParamLocation where
982− toJSON = genericToJSON (jsonPrefix "Param")
983−
984−instance ToJSON Info where
985− toJSON = genericToJSON (jsonPrefix "Info")
986−
987−instance ToJSON Contact where
988− toJSON = genericToJSON (jsonPrefix "Contact")
989−
990−instance ToJSON License where
991− toJSON = genericToJSON (jsonPrefix "License")
992−
993−instance ToJSON ApiKeyLocation where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
827+instance SwaggerMonoid (HashMap Text Response) where
828+ swaggerMempty = HashMap.empty
829+ swaggerMappend = flip HashMap.union
995830
996−instance ToJSON ApiKeyParams where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
831+instance SwaggerMonoid (HashMap Text SecurityScheme) where
832+ swaggerMempty = HashMap.empty
833+ swaggerMappend = flip HashMap.union
998834
999−instance ToJSON Scheme where
1000− toJSON = genericToJSON (jsonPrefix "")
835+instance SwaggerMonoid (HashMap FilePath PathItem) where
836+ swaggerMempty = HashMap.empty
837+ swaggerMappend = HashMap.unionWith mappend
1001838
1002−instance ToJSON Tag where
1003− toJSON = genericToJSON (jsonPrefix "Tag")
839+instance SwaggerMonoid (HashMap HeaderName Header) where
840+ swaggerMempty = HashMap.empty
841+ swaggerMappend = flip HashMap.union
1004842
1005−instance ToJSON ExternalDocs where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
843+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
844+ swaggerMempty = HashMap.empty
845+ swaggerMappend = flip HashMap.union
1007846
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
847+instance SwaggerMonoid ParamAnySchema where
848+ swaggerMempty = ParamOther swaggerMempty
849+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
850+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
851+ swaggerMappend _ y = y
1010852
1011853-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
854+-- TH derived ToJSON and FromJSON instances
1013855-- =======================================================================
1014856
1015−instance FromJSON ParamLocation where
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
1017−
1018−instance FromJSON Info where
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
857+deriveJSON (jsonPrefix "Param") ''ParamLocation
858+deriveJSON' ''Info
859+deriveJSON' ''Contact
860+deriveJSON' ''License
861+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
862+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
863+deriveJSONDefault ''Scheme
864+deriveJSON' ''Tag
865+deriveJSON' ''ExternalDocs
1020866
1021−instance FromJSON Contact where
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
1023−
1024−instance FromJSON License where
1025− parseJSON = genericParseJSON (jsonPrefix "License")
1026−
1027−instance FromJSON ApiKeyLocation where
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1029−
1030−instance FromJSON ApiKeyParams where
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
1032−
1033−instance FromJSON Scheme where
1034− parseJSON = genericParseJSON (jsonPrefix "")
1035−
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1038−
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
867+deriveToJSON' ''Xml
1041868
1042869-- =======================================================================
1043870-- Manual ToJSON instances
@@ -1059,8 +886,7 @@ instance ToJSON OAuth2Flow where
1059886 , "tokenUrl" .= tokenUrl ]
1060887
1061888instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
1063− DEFINE_TOENCODING
889+ toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1064890
1065891instance ToJSON SecuritySchemeType where
1066892 toJSON SecuritySchemeBasic
@@ -1073,38 +899,22 @@ instance ToJSON SecuritySchemeType where
1073899 <+> object [ "type" .= ("oauth2" :: Text) ]
1074900
1075901instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
1077− DEFINE_TOENCODING
902+ toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
903+ where
904+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
905+ addVersion _ = error "impossible"
1078906
1079907instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
1081− DEFINE_TOENCODING
908+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1082909
1083910instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1085− DEFINE_TOENCODING
911+ toJSON = omitEmpties . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1086912
1087913instance ToJSON Header where
1088− toJSON = sopSwaggerGenericToJSON
1089− DEFINE_TOENCODING
1090−
1091−-- | As for nullary schema for 0-arity type constructors, see
1092−-- <https://github.com/GetShopTV/swagger2/issues/167>.
1093−--
1094−-- >>> encode (SwaggerItemsArray [])
1095−-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1096−--
1097−instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
1098− toJSON (SwaggerItemsPrimitive fmt schema) = object
1099− [ "collectionFormat" .= fmt
1100− , "items" .= schema ]
1101− toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1102− toJSON (SwaggerItemsArray []) = object
1103− [ "items" .= object []
1104− , "maxItems" .= (0 :: Int)
1105− , "example" .= Array mempty
1106− ]
1107− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
914+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
915+
916+instance ToJSON Items where
917+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
1108918
1109919instance ToJSON Host where
1110920 toJSON (Host host mport) = toJSON $
@@ -1112,43 +922,42 @@ instance ToJSON Host where
1112922 Nothing -> host
1113923 Just port -> host ++ ":" ++ show port
1114924
925+instance ToJSON Paths where
926+ toJSON (Paths m) = toJSON m
927+
1115928instance ToJSON MimeList where
1116929 toJSON (MimeList xs) = toJSON (map show xs)
1117930
1118931instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1120− DEFINE_TOENCODING
932+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1121933
1122934instance ToJSON ParamAnySchema where
1123935 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124936 toJSON (ParamOther s) = toJSON s
1125937
1126938instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
1128− DEFINE_TOENCODING
939+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
940+
941+instance ToJSON SchemaItems where
942+ toJSON (SchemaItemsObject x) = toJSON x
943+ toJSON (SchemaItemsArray xs) = toJSON xs
1129944
1130945instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1132− DEFINE_TOENCODING
946+ toJSON (Responses def rs) = omitEmpties $
947+ toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1133948
1134949instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1136− DEFINE_TOENCODING
950+ toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1137951
1138952instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1140− DEFINE_TOENCODING
953+ toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1141954
1142955instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1144− DEFINE_TOENCODING
956+ toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1145957
1146958instance ToJSON Example where
1147959 toJSON = toJSON . Map.mapKeys show . getExample
1148960
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1151−
1152961instance ToJSON Reference where
1153962 toJSON (Reference ref) = object [ "$ref" .= ref ]
1154963
@@ -1177,14 +986,8 @@ instance ToJSON (CollectionFormat t) where
1177986 toJSON CollectionPipes = "pipes"
1178987 toJSON CollectionMulti = "multi"
1179988
1180−instance ToJSON (ParamSchema k) where
1181− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1182− toJSON = sopSwaggerGenericToJSONWithOpts $
1183− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1184−
1185−instance ToJSON AdditionalProperties where
1186− toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187− toJSON (AdditionalPropertiesSchema s) = toJSON s
989+instance ToJSON i => ToJSON (ParamSchema t i) where
990+ toJSON = genericToJSON (jsonPrefix "paramSchema")
1188991
1189992-- =======================================================================
1190993-- Manual FromJSON instances
@@ -1204,7 +1007,7 @@ instance FromJSON OAuth2Flow where
12041007 parseJSON _ = empty
12051008
12061009instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
1010+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
12081011
12091012instance FromJSON SecuritySchemeType where
12101013 parseJSON js@(Object o) = do
@@ -1217,65 +1020,53 @@ instance FromJSON SecuritySchemeType where
12171020 parseJSON _ = empty
12181021
12191022instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
1023+ parseJSON js@(Object o) = do
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)
1035+ ] ) js
1036+ parseJSON _ = empty
12211037
12221038instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
1039+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
12241040
12251041instance FromJSON Schema where
1226− parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1227− where nullaryCleanup :: Schema -> Schema
1228− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230− then s { _schemaExample = Nothing
1231− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1232− else s
1042+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1043+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1044+ , "required" .= ([] :: [ParamName]) ]
12331045
12341046instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
1236−
1237−instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1238− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1239− <$> o .:? "collectionFormat"
1240− <*> (o .: "items" >>= parseJSON)
1241−
1242−instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1243− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244− <$> o .:? "collectionFormat"
1245− <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1246−
1247−-- |
1248−--
1249−-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250−-- Just (SwaggerItemsArray [])
1251−--
1252−-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253−-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1254−--
1255−-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256−-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1257−--
1258−instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1259− parseJSON js@(Object obj)
1260− | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1261− | otherwise = SwaggerItemsObject <$> parseJSON js
1262− parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1263− parseJSON _ = empty
1047+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
1048+
1049+instance FromJSON Items where
1050+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
12641051
12651052instance FromJSON Host where
1266− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1267− [host] -> return $ Host host Nothing
1268− [host, port] -> case readMaybe port of
1269− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1270− Just p -> return $ Host host (Just (fromInteger p))
1271− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1053+ parseJSON (String s) =
1054+ case fromInteger <$> readMaybe portStr of
1055+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1056+ mport -> pure $ Host host mport
1057+ where
1058+ (hostText, portText) = Text.breakOn ":" s
1059+ [host, portStr] = map Text.unpack [hostText, portText]
12721060 parseJSON _ = empty
12731061
1062+instance FromJSON Paths where
1063+ parseJSON js = Paths <$> parseJSON js
1064+
12741065instance FromJSON MimeList where
12751066 parseJSON js = (MimeList . map fromString) <$> parseJSON js
12761067
12771068instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
1069+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
12791070
12801071instance FromJSON ParamAnySchema where
12811072 parseJSON js@(Object o) = do
@@ -1288,12 +1079,17 @@ instance FromJSON ParamAnySchema where
12881079 parseJSON _ = empty
12891080
12901081instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
1082+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1083+
1084+instance FromJSON SchemaItems where
1085+ parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
1086+ parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
1087+ parseJSON _ = empty
12921088
12931089instance FromJSON Responses where
12941090 parseJSON (Object o) = Responses
12951091 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1092+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
12971093 parseJSON _ = empty
12981094
12991095instance FromJSON Example where
@@ -1302,16 +1098,16 @@ instance FromJSON Example where
13021098 pure $ Example (Map.mapKeys fromString m)
13031099
13041100instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1101+ parseJSON = genericParseJSON (jsonPrefix "response")
1102+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
13061103
13071104instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1105+ parseJSON = genericParseJSON (jsonPrefix "operation")
1106+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
13091107
13101108instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1312−
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1109+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1110+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
13151111
13161112instance FromJSON Reference where
13171113 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1328,7 +1124,6 @@ referencedParseJSON prefix js@(Object o) = do
13281124 case Text.stripPrefix prefix s of
13291125 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
13301126 Just suffix -> pure (Reference suffix)
1331−referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
13321127
13331128instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
13341129instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1337,91 +1132,23 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
13371132instance FromJSON Xml where
13381133 parseJSON = genericParseJSON (jsonPrefix "xml")
13391134
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1135+instance FromJSON (SwaggerType Schema) where
13411136 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
13421137
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1138+instance FromJSON (SwaggerType ParamOtherSchema) where
13441139 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
13451140
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1141+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
13471142 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
13481143
1349−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1350− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1351−
1352−-- NOTE: There aren't collections of 'Schema'
1353−--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1354−-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1355−
1356−instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1144+instance FromJSON (CollectionFormat Param) where
13571145 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
13581146
1359−instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1360− parseJSON = sopSwaggerGenericParseJSON
1361−instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1362− parseJSON = sopSwaggerGenericParseJSON
1363−instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1364− parseJSON = sopSwaggerGenericParseJSON
1365−
1366−instance FromJSON AdditionalProperties where
1367− parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368− parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1369−
1370−-------------------------------------------------------------------------------
1371−-- TH splices
1372−-------------------------------------------------------------------------------
1373−
1374−deriveGeneric ''Header
1375−deriveGeneric ''OAuth2Params
1376−deriveGeneric ''Operation
1377−deriveGeneric ''Param
1378−deriveGeneric ''ParamOtherSchema
1379−deriveGeneric ''PathItem
1380−deriveGeneric ''Response
1381−deriveGeneric ''Responses
1382−deriveGeneric ''SecurityScheme
1383−deriveGeneric ''Schema
1384−deriveGeneric ''ParamSchema
1385−deriveGeneric ''Swagger
1386−
1387−instance HasSwaggerAesonOptions Header where
1388− swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1389−instance HasSwaggerAesonOptions OAuth2Params where
1390− swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
1391−instance HasSwaggerAesonOptions Operation where
1392− swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
1393−instance HasSwaggerAesonOptions Param where
1394− swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1395−instance HasSwaggerAesonOptions ParamOtherSchema where
1396− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1397−instance HasSwaggerAesonOptions PathItem where
1398− swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
1399−instance HasSwaggerAesonOptions Response where
1400− swaggerAesonOptions _ = mkSwaggerAesonOptions "response"
1401−instance HasSwaggerAesonOptions Responses where
1402− swaggerAesonOptions _ = mkSwaggerAesonOptions "responses" & saoSubObject ?~ "responses"
1403−instance HasSwaggerAesonOptions SecurityScheme where
1404− swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1405−instance HasSwaggerAesonOptions Schema where
1406− swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1407−instance HasSwaggerAesonOptions Swagger where
1408− swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("swagger", "2.0")]
1409−
1410−instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1411− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1412−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1413− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1414−-- NOTE: Schema doesn't have 'items' sub object!
1415−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1416− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1417−
1418−instance AesonDefaultValue (ParamSchema s)
1419−instance AesonDefaultValue OAuth2Flow
1420−instance AesonDefaultValue Responses
1421−instance AesonDefaultValue ParamAnySchema
1422−instance AesonDefaultValue SecuritySchemeType
1423−instance AesonDefaultValue (SwaggerType a)
1424−instance AesonDefaultValue MimeList where defaultValue = Just mempty
1425−instance AesonDefaultValue Info
1426−instance AesonDefaultValue ParamLocation
1427−instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty
1147+instance FromJSON (CollectionFormat Items) where
1148+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1149+
1150+-- NOTE: The constraint @FromJSON (SwaggerType t)@ is necessary here!
1151+-- Without the constraint the general instance will be used
1152+-- that only accepts common types (i.e. NOT object, null or file).
1153+instance (FromJSON (SwaggerType t), FromJSON i) => FromJSON (ParamSchema t i) where
1154+ parseJSON = genericParseJSON (jsonPrefix "ParamSchema")