@@ -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 #-}
@@ -12,128 +9,92 @@
129{-# LANGUAGE RecordWildCards #-}
1310{-# LANGUAGE ScopedTypeVariables #-}
1411{-# LANGUAGE StandaloneDeriving #-}
15−{-# LANGUAGE TemplateHaskell #-}
16−{-# LANGUAGE TypeFamilies #-}
1712{-# 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
3018import qualified Data.Aeson.Types as JSON
3119import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32−import Data.Hashable (Hashable)
20+import Data.HashMap.Strict (HashMap)
3321import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
3522import Data.Map (Map)
3623import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
38−import Data.Semigroup.Compat (Semigroup (..))
24+import Data.Monoid
3925import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
26+import Data.String (fromString)
4127import Data.Text (Text)
4228import qualified Data.Text as Text
4329import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
30+import Network (HostName, PortNumber)
4531import Network.HTTP.Media (MediaType)
4632import Text.Read (readMaybe)
4733
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)
6034import Data.Swagger.Internal.Utils
6135
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−
7336-- | A list of definitions that can be used in references.
74−type Definitions = InsOrdHashMap Text
37+type Definitions = HashMap Text
7538
7639-- | This is the root document object for the API specification.
7740data Swagger = Swagger
7841 { -- | Provides metadata about the API.
7942 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
43+ _info :: Info
8144
8245 -- | The host (name or ip) serving the API. It MAY include a port.
8346 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
47+ , _host :: Maybe Host
8548
8649 -- | The base path on which the API is served, which is relative to the host.
8750 -- If it is not included, the API is served directly under the host.
8851 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
52+ , _basePath :: Maybe FilePath
9053
9154 -- | The transfer protocol of the API.
9255 -- 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]
56+ , _schemes :: Maybe [Scheme]
9457
9558 -- | A list of MIME types the APIs can consume.
9659 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
60+ , _consumes :: MimeList
9861
9962 -- | A list of MIME types the APIs can produce.
10063 -- This is global to all APIs but can be overridden on specific API calls.
101− , _swaggerProduces :: MimeList
64+ , _produces :: MimeList
10265
10366 -- | 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
67+ , _paths :: Paths
10768
10869 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
70+ , _definitions :: Definitions Schema
11071
11172 -- | An object to hold parameters that can be used across operations.
11273 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
74+ , _parameters :: Definitions Param
11475
11576 -- | An object to hold responses that can be used across operations.
11677 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
78+ , _responses :: Definitions Response
11879
11980 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
81+ , _securityDefinitions :: Definitions SecurityScheme
12182
12283 -- | A declaration of which security schemes are applied for the API as a whole.
12384 -- The list of values describes alternative security schemes that can be used
12485 -- (that is, there is a logical OR between the security requirements).
12586 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
87+ , _security :: [SecurityRequirement]
12788
12889 -- | A list of tags used by the specification with additional metadata.
12990 -- The order of the tags can be used to reflect on their order by the parsing tools.
13091 -- Not all tags that are used by the Operation Object must be declared.
13192 -- The tags that are not declared may be organized randomly or based on the tools' logic.
13293 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
94+ , _tags :: [Tag]
13495
13596 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
97+ , _externalDocs :: Maybe ExternalDocs
13798 } deriving (Eq, Show, Generic, Data, Typeable)
13899
139100-- | The object provides metadata about the API.
@@ -182,18 +143,12 @@ data License = License
182143 , _licenseUrl :: Maybe URL
183144 } deriving (Eq, Show, Generic, Data, Typeable)
184145
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
187−
188146-- | The host (name or ip) serving the API. It MAY include a port.
189147data Host = Host
190148 { _hostName :: HostName -- ^ Host name.
191149 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192150 } deriving (Eq, Show, Generic, Typeable)
193151
194−instance IsString Host where
195− fromString s = Host s Nothing
196−
197152hostConstr :: Constr
198153hostConstr = mkConstr hostDataType "Host" [] Prefix
199154
@@ -215,6 +170,13 @@ data Scheme
215170 | Wss
216171 deriving (Eq, Show, Generic, Data, Typeable)
217172
173+-- | The available paths and operations for the API.
174+data Paths = Paths
175+ { -- | Holds the relative paths to the individual endpoints.
176+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
177+ _pathsMap :: HashMap FilePath PathItem
178+ } deriving (Eq, Show, Generic, Data, Typeable)
179+
218180-- | Describes the operations available on a single path.
219181-- A @'PathItem'@ may be empty, due to ACL constraints.
220182-- The path itself is still exposed to the documentation viewer
@@ -252,7 +214,7 @@ data PathItem = PathItem
252214data Operation = Operation
253215 { -- | A list of tags for API documentation control.
254216 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
217+ _operationTags :: [TagName]
256218
257219 -- | A short summary of what the operation does.
258220 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -309,7 +271,7 @@ data Operation = Operation
309271 } deriving (Eq, Show, Generic, Data, Typeable)
310272
311273newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
274+ deriving (Eq, Show, Monoid, Typeable)
313275
314276mimeListConstr :: Constr
315277mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -360,8 +322,8 @@ data ParamOtherSchema = ParamOtherSchema
360322 -- Default value is @False@.
361323 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362324
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
364− } deriving (Eq, Show, Generic, Typeable, Data)
325+ , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema
326+ } deriving (Eq, Show, Generic, Data, Typeable)
365327
366328-- | Items for @'SwaggerArray'@ schemas.
367329--
@@ -374,78 +336,28 @@ data ParamOtherSchema = ParamOtherSchema
374336--
375337-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
376338data 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)
339+ SwaggerItemsPrimitive :: Maybe (CollectionFormat t) -> ParamSchema t -> SwaggerItems t
340+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems Schema
341+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems Schema
381342
382343deriving instance Eq (SwaggerItems t)
383344deriving instance Show (SwaggerItems t)
384−--deriving instance Typeable (SwaggerItems t)
345+deriving instance Typeable (SwaggerItems t)
385346
386347swaggerItemsPrimitiveConstr :: Constr
387348swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388349
389−swaggerItemsObjectConstr :: Constr
390−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391−
392−swaggerItemsArrayConstr :: Constr
393−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394−
395350swaggerItemsDataType :: DataType
396351swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397352
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
353+instance {-# OVERLAPPABLE #-} Data t => Data (SwaggerItems t) where
403354 gunfold k z c = case constrIndex c of
404355 1 -> k (k (z SwaggerItemsPrimitive))
405356 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406357 toConstr _ = swaggerItemsPrimitiveConstr
407358 dataTypeOf _ = swaggerItemsDataType
408359
409−-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
410−instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411− -- TODO: define gfoldl
412− gunfold k z c = case constrIndex c of
413− 1 -> k (k (z SwaggerItemsPrimitive))
414− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415− toConstr _ = swaggerItemsPrimitiveConstr
416− dataTypeOf _ = swaggerItemsDataType
417−
418−instance Data (SwaggerItems 'SwaggerKindSchema) where
419− gfoldl _ _ (SwaggerItemsPrimitive _ _) = error $ " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
420− gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
421− gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
422−
423− gunfold k z c = case constrIndex c of
424− 2 -> k (z SwaggerItemsObject)
425− 3 -> k (z SwaggerItemsArray)
426− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
427−
428− toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429− toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430− toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
431−
432− dataTypeOf _ = swaggerItemsDataType
433−
434−-- | Type used as a kind to avoid overlapping instances.
435−data SwaggerKind t
436− = SwaggerKindNormal t
437− | SwaggerKindParamOtherSchema
438− | SwaggerKindSchema
439− deriving (Typeable)
440−
441−deriving instance Typeable 'SwaggerKindNormal
442−deriving instance Typeable 'SwaggerKindParamOtherSchema
443−deriving instance Typeable 'SwaggerKindSchema
444−
445−type family SwaggerKindType (k :: SwaggerKind *) :: *
446−type instance SwaggerKindType ('SwaggerKindNormal t) = t
447−type instance SwaggerKindType 'SwaggerKindSchema = Schema
448−type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
360+deriving instance Data (SwaggerItems Schema)
449361
450362data SwaggerType t where
451363 SwaggerString :: SwaggerType t
@@ -453,44 +365,44 @@ data SwaggerType t where
453365 SwaggerInteger :: SwaggerType t
454366 SwaggerBoolean :: SwaggerType t
455367 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
459− deriving (Typeable)
368+ SwaggerFile :: SwaggerType ParamOtherSchema
369+ SwaggerNull :: SwaggerType Schema
370+ SwaggerObject :: SwaggerType Schema
460371
461372deriving instance Eq (SwaggerType t)
462373deriving instance Show (SwaggerType t)
374+deriving instance Typeable (SwaggerType t)
463375
464376swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465377swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466378
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
379+swaggerTypeDataType :: Data (SwaggerType t) => SwaggerType t -> DataType
468380swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
469381
470−swaggerCommonTypes :: [SwaggerType k]
382+swaggerCommonTypes :: [SwaggerType t]
471383swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472384
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
385+swaggerParamTypes :: [SwaggerType ParamOtherSchema]
474386swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475387
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
388+swaggerSchemaTypes :: [SwaggerType Schema]
477389swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
478390
479391swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
392+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType Schema])
481393 ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
482394
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
395+instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerType t) where
484396 gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485397 toConstr = swaggerTypeConstr
486398 dataTypeOf = swaggerTypeDataType
487399
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
400+instance {-# OVERLAPPING #-} Data (SwaggerType ParamOtherSchema) where
489401 gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490402 toConstr = swaggerTypeConstr
491403 dataTypeOf = swaggerTypeDataType
492404
493−instance Data (SwaggerType 'SwaggerKindSchema) where
405+instance {-# OVERLAPPING #-} Data (SwaggerType Schema) where
494406 gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495407 toConstr = swaggerTypeConstr
496408 dataTypeOf = swaggerTypeDataType
@@ -530,11 +442,11 @@ data CollectionFormat t where
530442 -- Corresponds to multiple parameter instances
531443 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532444 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
445+ CollectionMulti :: CollectionFormat ParamOtherSchema
535446
536447deriving instance Eq (CollectionFormat t)
537448deriving instance Show (CollectionFormat t)
449+deriving instance Typeable (CollectionFormat t)
538450
539451collectionFormatConstr :: CollectionFormat t -> Constr
540452collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
@@ -546,12 +458,12 @@ collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
546458collectionCommonFormats :: [CollectionFormat t]
547459collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548460
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
461+instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
550462 gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551463 toConstr = collectionFormatConstr
552464 dataTypeOf _ = collectionFormatDataType
553465
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
466+deriving instance {-# OVERLAPPING #-} Data (CollectionFormat ParamOtherSchema)
555467
556468type ParamName = Text
557469
@@ -560,9 +472,9 @@ data Schema = Schema
560472 , _schemaDescription :: Maybe Text
561473 , _schemaRequired :: [ParamName]
562474
563− , _schemaAllOf :: Maybe [Referenced Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
475+ , _schemaAllOf :: Maybe [Schema]
476+ , _schemaProperties :: HashMap Text (Referenced Schema)
477+ , _schemaAdditionalProperties :: Maybe Schema
566478
567479 , _schemaDiscriminator :: Maybe Text
568480 , _schemaReadOnly :: Maybe Bool
@@ -573,7 +485,7 @@ data Schema = Schema
573485 , _schemaMaxProperties :: Maybe Integer
574486 , _schemaMinProperties :: Maybe Integer
575487
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
488+ , _schemaParamSchema :: ParamSchema Schema
577489 } deriving (Eq, Show, Generic, Data, Typeable)
578490
579491-- | A @'Schema'@ with an optional name.
@@ -583,10 +495,7 @@ data NamedSchema = NamedSchema
583495 , _namedSchemaSchema :: Schema
584496 } deriving (Eq, Show, Generic, Data, Typeable)
585497
586−-- | Regex pattern for @string@ type.
587−type Pattern = Text
588−
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
498+data ParamSchema t = ParamSchema
590499 { -- | Declares the value of the parameter that the server will use if none is provided,
591500 -- for example a @"count"@ to control the number of results per page might default to @100@
592501 -- if not supplied by the client in the request.
@@ -594,7 +503,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
594503 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595504 _paramSchemaDefault :: Maybe Value
596505
597− , _paramSchemaType :: Maybe (SwaggerType t)
506+ , _paramSchemaType :: SwaggerType t
598507 , _paramSchemaFormat :: Maybe Format
599508 , _paramSchemaItems :: Maybe (SwaggerItems t)
600509 , _paramSchemaMaximum :: Maybe Scientific
@@ -603,7 +512,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
603512 , _paramSchemaExclusiveMinimum :: Maybe Bool
604513 , _paramSchemaMaxLength :: Maybe Integer
605514 , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
515+ , _paramSchemaPattern :: Maybe Text
607516 , _paramSchemaMaxItems :: Maybe Integer
608517 , _paramSchemaMinItems :: Maybe Integer
609518 , _paramSchemaUniqueItems :: Maybe Bool
@@ -611,7 +520,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
611520 , _paramSchemaMultipleOf :: Maybe Scientific
612521 } deriving (Eq, Show, Generic, Typeable)
613522
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
523+deriving instance (Data t, Data (SwaggerType t), Data (SwaggerItems t)) => Data (ParamSchema t)
615524
616525data Xml = Xml
617526 { -- | Replaces the name of the element/attribute used for the described schema property.
@@ -653,7 +562,7 @@ data Responses = Responses
653562
654563 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655564 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
565+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657566 } deriving (Eq, Show, Generic, Data, Typeable)
658567
659568type HttpStatusCode = Int
@@ -672,22 +581,19 @@ data Response = Response
672581 , _responseSchema :: Maybe (Referenced Schema)
673582
674583 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
584+ , _responseHeaders :: HashMap HeaderName Header
676585
677586 -- | An example of the response message.
678587 , _responseExamples :: Maybe Example
679588 } deriving (Eq, Show, Generic, Data, Typeable)
680589
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
683−
684590type HeaderName = Text
685591
686592data Header = Header
687593 { -- | A short description of the header.
688594 _headerDescription :: Maybe Text
689595
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
596+ , _headerParamSchema :: ParamSchema Header
691597 } deriving (Eq, Show, Generic, Data, Typeable)
692598
693599data Example = Example { getExample :: Map MediaType Value }
@@ -738,7 +644,7 @@ data OAuth2Params = OAuth2Params
738644 _oauth2Flow :: OAuth2Flow
739645
740646 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
647+ , _oauth2Scopes :: HashMap Text Text
742648 } deriving (Eq, Show, Generic, Data, Typeable)
743649
744650data SecuritySchemeType
@@ -755,28 +661,12 @@ data SecurityScheme = SecurityScheme
755661 , _securitySchemeDescription :: Maybe Text
756662 } deriving (Eq, Show, Generic, Data, Typeable)
757663
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−
774664-- | Lists the required security schemes to execute this operation.
775665-- The object can have multiple security schemes declared in it which are all required
776666-- (that is, there is a logical AND between the schemes).
777667newtype SecurityRequirement = SecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
779− } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
668+ { getSecurityRequirement :: HashMap Text [Text]
669+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
780670
781671-- | Tag name.
782672type TagName = Text
@@ -793,12 +683,7 @@ data Tag = Tag
793683
794684 -- | Additional external documentation for this tag.
795685 , _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
686+ } deriving (Eq, Show, Generic, Data, Typeable)
802687
803688-- | Allows referencing an external resource for extended documentation.
804689data ExternalDocs = ExternalDocs
@@ -808,9 +693,7 @@ data ExternalDocs = ExternalDocs
808693
809694 -- | The URL for the target documentation.
810695 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812−
813−instance Hashable ExternalDocs
696+ } deriving (Eq, Show, Generic, Data, Typeable)
814697
815698-- | A simple object to allow referencing other definitions in the specification.
816699-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -820,122 +703,76 @@ newtype Reference = Reference { getReference :: Text }
820703data Referenced a
821704 = Ref Reference
822705 | 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)
833706 deriving (Eq, Show, Data, Typeable)
834707
708+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
709+
835710-- =======================================================================
836711-- Monoid instances
837712-- =======================================================================
838713
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841714instance Monoid Swagger where
842715 mempty = genericMempty
843− mappend = (<>)
716+ mappend = genericMappend
844717
845−instance Semigroup Info where
846− (<>) = genericMappend
847718instance Monoid Info where
848719 mempty = genericMempty
849− mappend = (<>)
720+ mappend = genericMappend
850721
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
722+instance Monoid Paths where
854723 mempty = genericMempty
855− mappend = (<>)
724+ mappend = genericMappend
856725
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859726instance Monoid PathItem where
860727 mempty = genericMempty
861− mappend = (<>)
728+ mappend = genericMappend
862729
863−instance Semigroup Schema where
864− (<>) = genericMappend
865730instance Monoid Schema where
866731 mempty = genericMempty
867− mappend = (<>)
732+ mappend = genericMappend
868733
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871734instance Monoid (ParamSchema t) where
872735 mempty = genericMempty
873− mappend = (<>)
736+ mappend = genericMappend
874737
875−instance Semigroup Param where
876− (<>) = genericMappend
877738instance Monoid Param where
878739 mempty = genericMempty
879− mappend = (<>)
740+ mappend = genericMappend
880741
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883742instance Monoid ParamOtherSchema where
884743 mempty = genericMempty
885− mappend = (<>)
744+ mappend = genericMappend
886745
887−instance Semigroup Header where
888− (<>) = genericMappend
889746instance Monoid Header where
890747 mempty = genericMempty
891− mappend = (<>)
748+ mappend = genericMappend
892749
893−instance Semigroup Responses where
894− (<>) = genericMappend
895750instance Monoid Responses where
896751 mempty = genericMempty
897− mappend = (<>)
752+ mappend = genericMappend
898753
899−instance Semigroup Response where
900− (<>) = genericMappend
901754instance Monoid Response where
902755 mempty = genericMempty
903− mappend = (<>)
756+ mappend = genericMappend
904757
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907758instance Monoid ExternalDocs where
908759 mempty = genericMempty
909− mappend = (<>)
760+ mappend = genericMappend
910761
911−instance Semigroup Operation where
912− (<>) = genericMappend
913762instance Monoid Operation where
914763 mempty = genericMempty
915− mappend = (<>)
764+ mappend = genericMappend
916765
917−instance Semigroup Example where
918− (<>) = genericMappend
919766instance Monoid Example where
920767 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 = (<>)
768+ mappend = genericMappend
933769
934770-- =======================================================================
935771-- SwaggerMonoid helper instances
936772-- =======================================================================
937773
938774instance SwaggerMonoid Info
775+instance SwaggerMonoid Paths
939776instance SwaggerMonoid PathItem
940777instance SwaggerMonoid Schema
941778instance SwaggerMonoid (ParamSchema t)
@@ -945,8 +782,6 @@ instance SwaggerMonoid Responses
945782instance SwaggerMonoid Response
946783instance SwaggerMonoid ExternalDocs
947784instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950785
951786instance SwaggerMonoid MimeList
952787deriving instance SwaggerMonoid URL
@@ -959,13 +794,13 @@ instance SwaggerMonoid ParamLocation where
959794 swaggerMempty = ParamQuery
960795 swaggerMappend _ y = y
961796
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
797+instance SwaggerMonoid (HashMap FilePath PathItem) where
798+ swaggerMempty = HashMap.empty
799+ swaggerMappend = HashMap.unionWith mappend
965800
966801instance Monoid a => SwaggerMonoid (Referenced a) where
967802 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
803+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
969804 swaggerMappend _ y = y
970805
971806instance SwaggerMonoid ParamAnySchema where
@@ -1059,8 +894,7 @@ instance ToJSON OAuth2Flow where
1059894 , "tokenUrl" .= tokenUrl ]
1060895
1061896instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
1063− DEFINE_TOENCODING
897+ toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1064898
1065899instance ToJSON SecuritySchemeType where
1066900 toJSON SecuritySchemeBasic
@@ -1073,37 +907,28 @@ instance ToJSON SecuritySchemeType where
1073907 <+> object [ "type" .= ("oauth2" :: Text) ]
1074908
1075909instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
1077− DEFINE_TOENCODING
910+ toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
911+ where
912+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
913+ addVersion _ = error "impossible"
1078914
1079915instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
1081− DEFINE_TOENCODING
916+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1082917
1083918instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1085− DEFINE_TOENCODING
919+ toJSON = omitEmptiesExcept f . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
920+ where
921+ f "items" (Array _) = True
922+ f _ _ = False
1086923
1087924instance ToJSON Header where
1088− toJSON = sopSwaggerGenericToJSON
1089− DEFINE_TOENCODING
925+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
1090926
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
927+instance ToJSON (SwaggerItems t) where
1098928 toJSON (SwaggerItemsPrimitive fmt schema) = object
1099929 [ "collectionFormat" .= fmt
1100930 , "items" .= schema ]
1101931 toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1102− toJSON (SwaggerItemsArray []) = object
1103− [ "items" .= object []
1104− , "maxItems" .= (0 :: Int)
1105− , "example" .= Array mempty
1106− ]
1107932 toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1108933
1109934instance ToJSON Host where
@@ -1112,43 +937,38 @@ instance ToJSON Host where
1112937 Nothing -> host
1113938 Just port -> host ++ ":" ++ show port
1114939
940+instance ToJSON Paths where
941+ toJSON (Paths m) = toJSON m
942+
1115943instance ToJSON MimeList where
1116944 toJSON (MimeList xs) = toJSON (map show xs)
1117945
1118946instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1120− DEFINE_TOENCODING
947+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1121948
1122949instance ToJSON ParamAnySchema where
1123950 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124951 toJSON (ParamOther s) = toJSON s
1125952
1126953instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
1128− DEFINE_TOENCODING
954+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1129955
1130956instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1132− DEFINE_TOENCODING
957+ toJSON (Responses def rs) = omitEmpties $
958+ toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1133959
1134960instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1136− DEFINE_TOENCODING
961+ toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1137962
1138963instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1140− DEFINE_TOENCODING
964+ toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1141965
1142966instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1144− DEFINE_TOENCODING
967+ toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1145968
1146969instance ToJSON Example where
1147970 toJSON = toJSON . Map.mapKeys show . getExample
1148971
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1151−
1152972instance ToJSON Reference where
1153973 toJSON (Reference ref) = object [ "$ref" .= ref ]
1154974
@@ -1177,14 +997,11 @@ instance ToJSON (CollectionFormat t) where
1177997 toJSON CollectionPipes = "pipes"
1178998 toJSON CollectionMulti = "multi"
1179999
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
1000+instance ToJSON (ParamSchema t) where
1001+ toJSON = omitEmptiesExcept f . genericToJSONWithSub "items" (jsonPrefix "paramSchema")
1002+ where
1003+ f "items" (Array _) = True
1004+ f _ _ = False
11881005
11891006-- =======================================================================
11901007-- Manual FromJSON instances
@@ -1204,7 +1021,7 @@ instance FromJSON OAuth2Flow where
12041021 parseJSON _ = empty
12051022
12061023instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
1024+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
12081025
12091026instance FromJSON SecuritySchemeType where
12101027 parseJSON js@(Object o) = do
@@ -1217,65 +1034,60 @@ instance FromJSON SecuritySchemeType where
12171034 parseJSON _ = empty
12181035
12191036instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
1037+ parseJSON js@(Object o) = do
1038+ (version :: Text) <- o .: "swagger"
1039+ when (version /= "2.0") empty
1040+ (genericParseJSON (jsonPrefix "")
1041+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
1042+ , "produces" .= (mempty :: MimeList)
1043+ , "security" .= ([] :: [SecurityRequirement])
1044+ , "tags" .= ([] :: [Tag])
1045+ , "definitions" .= (mempty :: Definitions Schema)
1046+ , "parameters" .= (mempty :: Definitions Param)
1047+ , "responses" .= (mempty :: Definitions Response)
1048+ , "securityDefinitions" .= (mempty :: Definitions SecurityScheme)
1049+ ] ) js
1050+ parseJSON _ = empty
12211051
12221052instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
1053+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
12241054
12251055instance 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
1056+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1057+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1058+ , "required" .= ([] :: [ParamName]) ]
12331059
12341060instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
1061+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
12361062
1237−instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1238− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1063+instance {-# OVERLAPPABLE #-} (FromJSON (CollectionFormat t), FromJSON (ParamSchema t)) => FromJSON (SwaggerItems t) where
1064+ parseJSON (Object o) = SwaggerItemsPrimitive
12391065 <$> o .:? "collectionFormat"
12401066 <*> (o .: "items" >>= parseJSON)
12411067
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
1068+instance {-# OVERLAPPING #-} FromJSON (SwaggerItems Schema) where
1069+ parseJSON js@(Object _) = SwaggerItemsObject <$> parseJSON js
12621070 parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
12631071 parseJSON _ = empty
12641072
12651073instance 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 ++ "'"
1074+ parseJSON (String s) =
1075+ case fromInteger <$> readMaybe portStr of
1076+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1077+ mport -> pure $ Host host mport
1078+ where
1079+ (hostText, portText) = Text.breakOn ":" s
1080+ [host, portStr] = map Text.unpack [hostText, portText]
12721081 parseJSON _ = empty
12731082
1083+instance FromJSON Paths where
1084+ parseJSON js = Paths <$> parseJSON js
1085+
12741086instance FromJSON MimeList where
12751087 parseJSON js = (MimeList . map fromString) <$> parseJSON js
12761088
12771089instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
1090+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
12791091
12801092instance FromJSON ParamAnySchema where
12811093 parseJSON js@(Object o) = do
@@ -1288,12 +1100,12 @@ instance FromJSON ParamAnySchema where
12881100 parseJSON _ = empty
12891101
12901102instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
1103+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
12921104
12931105instance FromJSON Responses where
12941106 parseJSON (Object o) = Responses
12951107 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1108+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
12971109 parseJSON _ = empty
12981110
12991111instance FromJSON Example where
@@ -1302,16 +1114,16 @@ instance FromJSON Example where
13021114 pure $ Example (Map.mapKeys fromString m)
13031115
13041116instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1117+ parseJSON = genericParseJSON (jsonPrefix "response")
1118+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
13061119
13071120instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1121+ parseJSON = genericParseJSON (jsonPrefix "operation")
1122+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
13091123
13101124instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1312−
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1125+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1126+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
13151127
13161128instance FromJSON Reference where
13171129 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1328,7 +1140,6 @@ referencedParseJSON prefix js@(Object o) = do
13281140 case Text.stripPrefix prefix s of
13291141 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
13301142 Just suffix -> pure (Reference suffix)
1331−referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
13321143
13331144instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
13341145instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1337,91 +1148,26 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
13371148instance FromJSON Xml where
13381149 parseJSON = genericParseJSON (jsonPrefix "xml")
13391150
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1151+instance FromJSON (SwaggerType Schema) where
13411152 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
13421153
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1154+instance FromJSON (SwaggerType ParamOtherSchema) where
13441155 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
13451156
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1157+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
13471158 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
13481159
1349−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1160+instance {-# OVERLAPPABLE #-} FromJSON (CollectionFormat t) where
13501161 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
13511162
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
1163+instance FromJSON (CollectionFormat ParamOtherSchema) where
13571164 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
13581165
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
1166+-- NOTE: The constraints @FromJSON (SwaggerType t)@ and
1167+-- @FromJSON (SwaggerItems t)@ are necessary here!
1168+-- Without the constraint the general instance will be used
1169+-- that only accepts common types (i.e. NOT object, null or file)
1170+-- and primitive array items.
1171+instance (FromJSON (SwaggerType t), FromJSON (SwaggerItems t)) => FromJSON (ParamSchema t) where
1172+ parseJSON = genericParseJSONWithSub "items" (jsonPrefix "ParamSchema")
1173+