@@ -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,90 @@
1310{-# LANGUAGE ScopedTypeVariables #-}
1411{-# LANGUAGE StandaloneDeriving #-}
1512{-# LANGUAGE TemplateHaskell #-}
16−{-# LANGUAGE TypeFamilies #-}
1713{-# LANGUAGE UndecidableInstances #-}
18−#if __GLASGOW_HASKELL__ <710
19−{-# LANGUAGE PolyKinds #-}
20−#endif
21−#include "overlapping-compat.h"
2214module Data.Swagger.Internal where
2315
24−import Prelude ()
25−import Prelude.Compat
26−
27−import Control.Lens ((&), (.~), (?~))
2816import Control.Applicative
17+import Control.Monad
2918import Data.Aeson
19+import Data.Aeson.TH (deriveJSON)
3020import qualified Data.Aeson.Types as JSON
3121import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32−import Data.Hashable (Hashable)
22+import Data.HashMap.Strict (HashMap)
3323import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
3524import Data.Map (Map)
3625import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
38−import Data.Semigroup.Compat (Semigroup (..))
26+import Data.Monoid
3927import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
28+import Data.String (fromString)
4129import Data.Text (Text)
4230import qualified Data.Text as Text
4331import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
32+import Network (HostName, PortNumber)
4533import Network.HTTP.Media (MediaType)
4634import Text.Read (readMaybe)
4735
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)
6036import Data.Swagger.Internal.Utils
6137
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−
7638-- | This is the root document object for the API specification.
7739data Swagger = Swagger
7840 { -- | Provides metadata about the API.
7941 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
42+ _info :: Info
8143
8244 -- | The host (name or ip) serving the API. It MAY include a port.
8345 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
46+ , _host :: Maybe Host
8547
8648 -- | The base path on which the API is served, which is relative to the host.
8749 -- If it is not included, the API is served directly under the host.
8850 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
51+ , _basePath :: Maybe FilePath
9052
9153 -- | The transfer protocol of the API.
9254 -- 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]
55+ , _schemes :: Maybe [Scheme]
9456
9557 -- | A list of MIME types the APIs can consume.
9658 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
59+ , _consumes :: MimeList
9860
9961 -- | 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
62+ -- This is global to all APIs but can be overridden on specific API calls.
63+ , _produces :: MimeList
10264
10365 -- | 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
66+ , _paths :: Paths
10767
10868 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
69+ , _definitions :: HashMap Text Schema
11070
11171 -- | An object to hold parameters that can be used across operations.
11272 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
73+ , _parameters :: HashMap Text Param
11474
11575 -- | An object to hold responses that can be used across operations.
11676 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
77+ , _responses :: HashMap Text Response
11878
11979 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
80+ , _securityDefinitions :: HashMap Text SecurityScheme
12181
12282 -- | A declaration of which security schemes are applied for the API as a whole.
12383 -- The list of values describes alternative security schemes that can be used
12484 -- (that is, there is a logical OR between the security requirements).
12585 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
86+ , _security :: [SecurityRequirement]
12787
12888 -- | A list of tags used by the specification with additional metadata.
12989 -- The order of the tags can be used to reflect on their order by the parsing tools.
13090 -- Not all tags that are used by the Operation Object must be declared.
13191 -- The tags that are not declared may be organized randomly or based on the tools' logic.
13292 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
93+ , _tags :: [Tag]
13494
13595 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
96+ , _externalDocs :: Maybe ExternalDocs
13797 } deriving (Eq, Show, Generic, Data, Typeable)
13898
13999-- | The object provides metadata about the API.
@@ -182,18 +142,12 @@ data License = License
182142 , _licenseUrl :: Maybe URL
183143 } deriving (Eq, Show, Generic, Data, Typeable)
184144
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
187−
188145-- | The host (name or ip) serving the API. It MAY include a port.
189146data Host = Host
190147 { _hostName :: HostName -- ^ Host name.
191148 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192149 } deriving (Eq, Show, Generic, Typeable)
193150
194−instance IsString Host where
195− fromString s = Host s Nothing
196−
197151hostConstr :: Constr
198152hostConstr = mkConstr hostDataType "Host" [] Prefix
199153
@@ -215,6 +169,13 @@ data Scheme
215169 | Wss
216170 deriving (Eq, Show, Generic, Data, Typeable)
217171
172+-- | The available paths and operations for the API.
173+data Paths = Paths
174+ { -- | Holds the relative paths to the individual endpoints.
175+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
176+ _pathsMap :: HashMap FilePath PathItem
177+ } deriving (Eq, Show, Generic, Data, Typeable)
178+
218179-- | Describes the operations available on a single path.
219180-- A @'PathItem'@ may be empty, due to ACL constraints.
220181-- The path itself is still exposed to the documentation viewer
@@ -252,7 +213,7 @@ data PathItem = PathItem
252213data Operation = Operation
253214 { -- | A list of tags for API documentation control.
254215 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
216+ _operationTags :: [Text]
256217
257218 -- | A short summary of what the operation does.
258219 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -309,7 +270,7 @@ data Operation = Operation
309270 } deriving (Eq, Show, Generic, Data, Typeable)
310271
311272newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
273+ deriving (Eq, Show, Monoid, Typeable)
313274
314275mimeListConstr :: Constr
315276mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -360,92 +321,36 @@ data ParamOtherSchema = ParamOtherSchema
360321 -- Default value is @False@.
361322 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362323
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.
324+ -- | Determines the format of the array if @'ParamArray'@ is used.
325+ -- Default value is csv.
326+ , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
327+
328+ , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema
329+ } deriving (Eq, Show, Generic, Data, Typeable)
330+
376331data 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)
332+ SwaggerItemsPrimitive :: Items -> SwaggerItems t
333+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems Schema
334+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems Schema
381335
382336deriving instance Eq (SwaggerItems t)
383337deriving instance Show (SwaggerItems t)
384−--deriving instance Typeable (SwaggerItems t)
338+deriving instance Typeable (SwaggerItems t)
385339
386340swaggerItemsPrimitiveConstr :: Constr
387341swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388342
389−swaggerItemsObjectConstr :: Constr
390−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391−
392−swaggerItemsArrayConstr :: Constr
393−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394−
395343swaggerItemsDataType :: DataType
396344swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397345
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
346+instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerItems t) where
403347 gunfold k z c = case constrIndex c of
404− 1 -> k (k (z SwaggerItemsPrimitive))
348+ 1 -> k (z SwaggerItemsPrimitive)
405349 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406350 toConstr _ = swaggerItemsPrimitiveConstr
407351 dataTypeOf _ = swaggerItemsDataType
408352
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
353+deriving instance Data (SwaggerItems Schema)
449354
450355data SwaggerType t where
451356 SwaggerString :: SwaggerType t
@@ -453,44 +358,44 @@ data SwaggerType t where
453358 SwaggerInteger :: SwaggerType t
454359 SwaggerBoolean :: SwaggerType t
455360 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
459− deriving (Typeable)
361+ SwaggerFile :: SwaggerType ParamOtherSchema
362+ SwaggerNull :: SwaggerType Schema
363+ SwaggerObject :: SwaggerType Schema
460364
461365deriving instance Eq (SwaggerType t)
462366deriving instance Show (SwaggerType t)
367+deriving instance Typeable (SwaggerType t)
463368
464369swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465370swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466371
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
372+swaggerTypeDataType :: Data (SwaggerType t) => SwaggerType t -> DataType
468373swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
469374
470−swaggerCommonTypes :: [SwaggerType k]
375+swaggerCommonTypes :: [SwaggerType t]
471376swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472377
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
378+swaggerParamTypes :: [SwaggerType ParamOtherSchema]
474379swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475380
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
381+swaggerSchemaTypes :: [SwaggerType Schema]
477382swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
478383
479384swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
385+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType Schema])
481386 ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
482387
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
388+instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerType t) where
484389 gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485390 toConstr = swaggerTypeConstr
486391 dataTypeOf = swaggerTypeDataType
487392
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
393+instance {-# OVERLAPPING #-} Data (SwaggerType ParamOtherSchema) where
489394 gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490395 toConstr = swaggerTypeConstr
491396 dataTypeOf = swaggerTypeDataType
492397
493−instance Data (SwaggerType 'SwaggerKindSchema) where
398+instance {-# OVERLAPPING #-} Data (SwaggerType Schema) where
494399 gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495400 toConstr = swaggerTypeConstr
496401 dataTypeOf = swaggerTypeDataType
@@ -530,11 +435,11 @@ data CollectionFormat t where
530435 -- Corresponds to multiple parameter instances
531436 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532437 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
438+ CollectionMulti :: CollectionFormat Param
535439
536440deriving instance Eq (CollectionFormat t)
537441deriving instance Show (CollectionFormat t)
442+deriving instance Typeable (CollectionFormat t)
538443
539444collectionFormatConstr :: CollectionFormat t -> Constr
540445collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
@@ -546,12 +451,12 @@ collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
546451collectionCommonFormats :: [CollectionFormat t]
547452collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548453
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
454+instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
550455 gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551456 toConstr = collectionFormatConstr
552457 dataTypeOf _ = collectionFormatDataType
553458
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
459+deriving instance {-# OVERLAPPING #-} Data (CollectionFormat Param)
555460
556461type ParamName = Text
557462
@@ -560,9 +465,9 @@ data Schema = Schema
560465 , _schemaDescription :: Maybe Text
561466 , _schemaRequired :: [ParamName]
562467
563− , _schemaAllOf :: Maybe [Referenced Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
468+ , _schemaAllOf :: Maybe [Schema]
469+ , _schemaProperties :: HashMap Text (Referenced Schema)
470+ , _schemaAdditionalProperties :: Maybe Schema
566471
567472 , _schemaDiscriminator :: Maybe Text
568473 , _schemaReadOnly :: Maybe Bool
@@ -573,20 +478,10 @@ data Schema = Schema
573478 , _schemaMaxProperties :: Maybe Integer
574479 , _schemaMinProperties :: Maybe Integer
575480
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
481+ , _schemaParamSchema :: ParamSchema Schema
577482 } deriving (Eq, Show, Generic, Data, Typeable)
578483
579−-- | A @'Schema'@ with an optional name.
580−-- This name can be used in references.
581−data NamedSchema = NamedSchema
582− { _namedSchemaName :: Maybe Text
583− , _namedSchemaSchema :: Schema
584− } deriving (Eq, Show, Generic, Data, Typeable)
585−
586−-- | Regex pattern for @string@ type.
587−type Pattern = Text
588−
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
484+data ParamSchema t = ParamSchema
590485 { -- | Declares the value of the parameter that the server will use if none is provided,
591486 -- for example a @"count"@ to control the number of results per page might default to @100@
592487 -- if not supplied by the client in the request.
@@ -594,7 +489,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
594489 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595490 _paramSchemaDefault :: Maybe Value
596491
597− , _paramSchemaType :: Maybe (SwaggerType t)
492+ , _paramSchemaType :: SwaggerType t
598493 , _paramSchemaFormat :: Maybe Format
599494 , _paramSchemaItems :: Maybe (SwaggerItems t)
600495 , _paramSchemaMaximum :: Maybe Scientific
@@ -603,7 +498,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
603498 , _paramSchemaExclusiveMinimum :: Maybe Bool
604499 , _paramSchemaMaxLength :: Maybe Integer
605500 , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
501+ , _paramSchemaPattern :: Maybe Text
607502 , _paramSchemaMaxItems :: Maybe Integer
608503 , _paramSchemaMinItems :: Maybe Integer
609504 , _paramSchemaUniqueItems :: Maybe Bool
@@ -611,11 +506,11 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
611506 , _paramSchemaMultipleOf :: Maybe Scientific
612507 } deriving (Eq, Show, Generic, Typeable)
613508
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
509+deriving instance (Data t, Data (SwaggerType t), Data (SwaggerItems t)) => Data (ParamSchema t)
615510
616511data Xml = Xml
617512 { -- | 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.
513+ -- When defined within the @'Items'@ (items), it will affect the name of the individual XML elements within the list.
619514 -- When defined alongside type being array (outside the items),
620515 -- it will affect the wrapping element and only if wrapped is true.
621516 -- If wrapped is false, it will be ignored.
@@ -641,6 +536,14 @@ data Xml = Xml
641536 , _xmlWrapped :: Maybe Bool
642537 } deriving (Eq, Show, Generic, Data, Typeable)
643538
539+data Items = Items
540+ { -- | Determines the format of the array if type array is used.
541+ -- Default value is @'ItemsCollectionCSV'@.
542+ _itemsCollectionFormat :: Maybe (CollectionFormat Items)
543+
544+ , _itemsParamSchema :: ParamSchema Items
545+ } deriving (Eq, Show, Generic, Data, Typeable)
546+
644547-- | A container for the expected responses of an operation.
645548-- The container maps a HTTP response code to the expected response.
646549-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
@@ -653,7 +556,7 @@ data Responses = Responses
653556
654557 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655558 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
559+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657560 } deriving (Eq, Show, Generic, Data, Typeable)
658561
659562type HttpStatusCode = Int
@@ -672,22 +575,23 @@ data Response = Response
672575 , _responseSchema :: Maybe (Referenced Schema)
673576
674577 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
578+ , _responseHeaders :: HashMap HeaderName Header
676579
677580 -- | An example of the response message.
678581 , _responseExamples :: Maybe Example
679582 } deriving (Eq, Show, Generic, Data, Typeable)
680583
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
683−
684584type HeaderName = Text
685585
686586data Header = Header
687587 { -- | A short description of the header.
688588 _headerDescription :: Maybe Text
689589
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
590+ -- | Determines the format of the array if type array is used.
591+ -- Default value is @'ItemsCollectionCSV'@.
592+ , _headerCollectionFormat :: Maybe (CollectionFormat Items)
593+
594+ , _headerParamSchema :: ParamSchema Header
691595 } deriving (Eq, Show, Generic, Data, Typeable)
692596
693597data Example = Example { getExample :: Map MediaType Value }
@@ -738,7 +642,7 @@ data OAuth2Params = OAuth2Params
738642 _oauth2Flow :: OAuth2Flow
739643
740644 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
645+ , _oauth2Scopes :: HashMap Text Text
742646 } deriving (Eq, Show, Generic, Data, Typeable)
743647
744648data SecuritySchemeType
@@ -755,37 +659,18 @@ data SecurityScheme = SecurityScheme
755659 , _securitySchemeDescription :: Maybe Text
756660 } deriving (Eq, Show, Generic, Data, Typeable)
757661
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−
774662-- | Lists the required security schemes to execute this operation.
775663-- The object can have multiple security schemes declared in it which are all required
776664-- (that is, there is a logical AND between the schemes).
777665newtype 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
666+ { getSecurityRequirement :: HashMap Text [Text]
667+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
783668
784669-- | Allows adding meta data to a single tag that is used by @Operation@.
785670-- It is not mandatory to have a @Tag@ per tag used there.
786671data Tag = Tag
787672 { -- | The name of the tag.
788− _tagName :: TagName
673+ _tagName :: Text
789674
790675 -- | A short description for the tag.
791676 -- GFM syntax can be used for rich text representation.
@@ -793,12 +678,7 @@ data Tag = Tag
793678
794679 -- | Additional external documentation for this tag.
795680 , _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
681+ } deriving (Eq, Show, Generic, Data, Typeable)
802682
803683-- | Allows referencing an external resource for extended documentation.
804684data ExternalDocs = ExternalDocs
@@ -808,9 +688,7 @@ data ExternalDocs = ExternalDocs
808688
809689 -- | The URL for the target documentation.
810690 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812−
813−instance Hashable ExternalDocs
691+ } deriving (Eq, Show, Generic, Data, Typeable)
814692
815693-- | A simple object to allow referencing other definitions in the specification.
816694-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -820,122 +698,68 @@ newtype Reference = Reference { getReference :: Text }
820698data Referenced a
821699 = Ref Reference
822700 | 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)
833701 deriving (Eq, Show, Data, Typeable)
834702
703+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
704+
835705-- =======================================================================
836706-- Monoid instances
837707-- =======================================================================
838708
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841709instance Monoid Swagger where
842710 mempty = genericMempty
843− mappend = (<>)
711+ mappend = genericMappend
844712
845−instance Semigroup Info where
846− (<>) = genericMappend
847713instance Monoid Info where
848714 mempty = genericMempty
849− mappend = (<>)
715+ mappend = genericMappend
850716
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
717+instance Monoid Paths where
854718 mempty = genericMempty
855− mappend = (<>)
719+ mappend = genericMappend
856720
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859721instance Monoid PathItem where
860722 mempty = genericMempty
861− mappend = (<>)
723+ mappend = genericMappend
862724
863−instance Semigroup Schema where
864− (<>) = genericMappend
865725instance Monoid Schema where
866726 mempty = genericMempty
867− mappend = (<>)
727+ mappend = genericMappend
868728
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871729instance Monoid (ParamSchema t) where
872730 mempty = genericMempty
873− mappend = (<>)
731+ mappend = genericMappend
874732
875−instance Semigroup Param where
876− (<>) = genericMappend
877733instance Monoid Param where
878734 mempty = genericMempty
879− mappend = (<>)
735+ mappend = genericMappend
880736
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883737instance Monoid ParamOtherSchema where
884738 mempty = genericMempty
885− mappend = (<>)
886−
887−instance Semigroup Header where
888− (<>) = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
891− mappend = (<>)
739+ mappend = genericMappend
892740
893−instance Semigroup Responses where
894− (<>) = genericMappend
895741instance Monoid Responses where
896742 mempty = genericMempty
897− mappend = (<>)
743+ mappend = genericMappend
898744
899−instance Semigroup Response where
900− (<>) = genericMappend
901745instance Monoid Response where
902746 mempty = genericMempty
903− mappend = (<>)
747+ mappend = genericMappend
904748
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907749instance Monoid ExternalDocs where
908750 mempty = genericMempty
909− mappend = (<>)
751+ mappend = genericMappend
910752
911−instance Semigroup Operation where
912− (<>) = genericMappend
913753instance Monoid Operation where
914754 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 = (<>)
755+ mappend = genericMappend
933756
934757-- =======================================================================
935758-- SwaggerMonoid helper instances
936759-- =======================================================================
937760
938761instance SwaggerMonoid Info
762+instance SwaggerMonoid Paths
939763instance SwaggerMonoid PathItem
940764instance SwaggerMonoid Schema
941765instance SwaggerMonoid (ParamSchema t)
@@ -945,8 +769,6 @@ instance SwaggerMonoid Responses
945769instance SwaggerMonoid Response
946770instance SwaggerMonoid ExternalDocs
947771instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950772
951773instance SwaggerMonoid MimeList
952774deriving instance SwaggerMonoid URL
@@ -959,85 +781,64 @@ instance SwaggerMonoid ParamLocation where
959781 swaggerMempty = ParamQuery
960782 swaggerMappend _ y = y
961783
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
784+instance SwaggerMonoid (HashMap Text Schema) where
785+ swaggerMempty = HashMap.empty
786+ swaggerMappend = HashMap.unionWith mappend
787+
788+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
789+ swaggerMempty = HashMap.empty
790+ swaggerMappend = HashMap.unionWith swaggerMappend
965791
966792instance Monoid a => SwaggerMonoid (Referenced a) where
967793 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
794+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
969795 swaggerMappend _ y = y
970796
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
976−
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")
797+instance SwaggerMonoid (HashMap Text Param) where
798+ swaggerMempty = HashMap.empty
799+ swaggerMappend = HashMap.unionWith mappend
986800
987−instance ToJSON Contact where
988− toJSON = genericToJSON (jsonPrefix "Contact")
801+instance SwaggerMonoid (HashMap Text Response) where
802+ swaggerMempty = HashMap.empty
803+ swaggerMappend = flip HashMap.union
989804
990−instance ToJSON License where
991− toJSON = genericToJSON (jsonPrefix "License")
805+instance SwaggerMonoid (HashMap Text SecurityScheme) where
806+ swaggerMempty = HashMap.empty
807+ swaggerMappend = flip HashMap.union
992808
993−instance ToJSON ApiKeyLocation where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
809+instance SwaggerMonoid (HashMap FilePath PathItem) where
810+ swaggerMempty = HashMap.empty
811+ swaggerMappend = HashMap.unionWith mappend
995812
996−instance ToJSON ApiKeyParams where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
813+instance SwaggerMonoid (HashMap HeaderName Header) where
814+ swaggerMempty = HashMap.empty
815+ swaggerMappend = flip HashMap.union
998816
999−instance ToJSON Scheme where
1000− toJSON = genericToJSON (jsonPrefix "")
817+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
818+ swaggerMempty = HashMap.empty
819+ swaggerMappend = flip HashMap.union
1001820
1002−instance ToJSON Tag where
1003− toJSON = genericToJSON (jsonPrefix "Tag")
1004−
1005−instance ToJSON ExternalDocs where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1007−
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
821+instance SwaggerMonoid ParamAnySchema where
822+ swaggerMempty = ParamOther swaggerMempty
823+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
824+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
825+ swaggerMappend _ y = y
1010826
1011827-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
828+-- TH derived ToJSON and FromJSON instances
1013829-- =======================================================================
1014830
1015−instance FromJSON ParamLocation where
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
1017−
1018−instance FromJSON Info where
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
1020−
1021−instance FromJSON Contact where
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
1023−
1024−instance FromJSON License where
1025− parseJSON = genericParseJSON (jsonPrefix "License")
1026−
1027−instance FromJSON ApiKeyLocation where
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1029−
1030−instance FromJSON ApiKeyParams where
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
1032−
1033−instance FromJSON Scheme where
1034− parseJSON = genericParseJSON (jsonPrefix "")
831+deriveJSON (jsonPrefix "Param") ''ParamLocation
832+deriveJSON' ''Info
833+deriveJSON' ''Contact
834+deriveJSON' ''License
835+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
836+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
837+deriveJSONDefault ''Scheme
838+deriveJSON' ''Tag
839+deriveJSON' ''ExternalDocs
1035840
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1038−
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
841+deriveToJSON' ''Xml
1041842
1042843-- =======================================================================
1043844-- Manual ToJSON instances
@@ -1059,8 +860,7 @@ instance ToJSON OAuth2Flow where
1059860 , "tokenUrl" .= tokenUrl ]
1060861
1061862instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
1063− DEFINE_TOENCODING
863+ toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1064864
1065865instance ToJSON SecuritySchemeType where
1066866 toJSON SecuritySchemeBasic
@@ -1073,38 +873,27 @@ instance ToJSON SecuritySchemeType where
1073873 <+> object [ "type" .= ("oauth2" :: Text) ]
1074874
1075875instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
1077− DEFINE_TOENCODING
876+ toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
877+ where
878+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
879+ addVersion _ = error "impossible"
1078880
1079881instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
1081− DEFINE_TOENCODING
882+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1082883
1083884instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1085− DEFINE_TOENCODING
885+ toJSON = omitEmpties . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1086886
1087887instance 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 ]
888+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
889+
890+instance ToJSON Items where
891+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
892+
893+instance ToJSON (SwaggerItems t) where
894+ toJSON (SwaggerItemsPrimitive x) = toJSON x
895+ toJSON (SwaggerItemsObject x) = toJSON x
896+ toJSON (SwaggerItemsArray x) = toJSON x
1108897
1109898instance ToJSON Host where
1110899 toJSON (Host host mport) = toJSON $
@@ -1112,43 +901,38 @@ instance ToJSON Host where
1112901 Nothing -> host
1113902 Just port -> host ++ ":" ++ show port
1114903
904+instance ToJSON Paths where
905+ toJSON (Paths m) = toJSON m
906+
1115907instance ToJSON MimeList where
1116908 toJSON (MimeList xs) = toJSON (map show xs)
1117909
1118910instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1120− DEFINE_TOENCODING
911+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1121912
1122913instance ToJSON ParamAnySchema where
1123914 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124915 toJSON (ParamOther s) = toJSON s
1125916
1126917instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
1128− DEFINE_TOENCODING
918+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1129919
1130920instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1132− DEFINE_TOENCODING
921+ toJSON (Responses def rs) = omitEmpties $
922+ toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1133923
1134924instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1136− DEFINE_TOENCODING
925+ toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1137926
1138927instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1140− DEFINE_TOENCODING
928+ toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1141929
1142930instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1144− DEFINE_TOENCODING
931+ toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1145932
1146933instance ToJSON Example where
1147934 toJSON = toJSON . Map.mapKeys show . getExample
1148935
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1151−
1152936instance ToJSON Reference where
1153937 toJSON (Reference ref) = object [ "$ref" .= ref ]
1154938
@@ -1177,14 +961,8 @@ instance ToJSON (CollectionFormat t) where
1177961 toJSON CollectionPipes = "pipes"
1178962 toJSON CollectionMulti = "multi"
1179963
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
964+instance ToJSON (ParamSchema t) where
965+ toJSON = genericToJSON (jsonPrefix "paramSchema")
1188966
1189967-- =======================================================================
1190968-- Manual FromJSON instances
@@ -1204,7 +982,7 @@ instance FromJSON OAuth2Flow where
1204982 parseJSON _ = empty
1205983
1206984instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
985+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1208986
1209987instance FromJSON SecuritySchemeType where
1210988 parseJSON js@(Object o) = do
@@ -1217,65 +995,61 @@ instance FromJSON SecuritySchemeType where
1217995 parseJSON _ = empty
1218996
1219997instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
998+ parseJSON js@(Object o) = do
999+ (version :: Text) <- o .: "swagger"
1000+ when (version /= "2.0") empty
1001+ (genericParseJSON (jsonPrefix "")
1002+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
1003+ , "produces" .= (mempty :: MimeList)
1004+ , "security" .= ([] :: [SecurityRequirement])
1005+ , "tags" .= ([] :: [Tag])
1006+ , "definitions" .= (mempty :: HashMap Text Schema)
1007+ , "parameters" .= (mempty :: HashMap Text Param)
1008+ , "responses" .= (mempty :: HashMap Text Response)
1009+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
1010+ ] ) js
1011+ parseJSON _ = empty
12211012
12221013instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
1014+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
12241015
12251016instance 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
1017+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1018+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1019+ , "required" .= ([] :: [ParamName]) ]
12331020
12341021instance 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
1022+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
1023+
1024+instance FromJSON Items where
1025+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
1026+
1027+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerItems t) where
1028+ parseJSON js = SwaggerItemsPrimitive <$> parseJSON js
1029+
1030+instance {-# OVERLAPPING #-} FromJSON (SwaggerItems Schema) where
1031+ parseJSON js@(Object _) = SwaggerItemsObject <$> parseJSON js
12621032 parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
12631033 parseJSON _ = empty
12641034
12651035instance 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 ++ "'"
1036+ parseJSON (String s) =
1037+ case fromInteger <$> readMaybe portStr of
1038+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1039+ mport -> pure $ Host host mport
1040+ where
1041+ (hostText, portText) = Text.breakOn ":" s
1042+ [host, portStr] = map Text.unpack [hostText, portText]
12721043 parseJSON _ = empty
12731044
1045+instance FromJSON Paths where
1046+ parseJSON js = Paths <$> parseJSON js
1047+
12741048instance FromJSON MimeList where
12751049 parseJSON js = (MimeList . map fromString) <$> parseJSON js
12761050
12771051instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
1052+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
12791053
12801054instance FromJSON ParamAnySchema where
12811055 parseJSON js@(Object o) = do
@@ -1288,12 +1062,12 @@ instance FromJSON ParamAnySchema where
12881062 parseJSON _ = empty
12891063
12901064instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
1065+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
12921066
12931067instance FromJSON Responses where
12941068 parseJSON (Object o) = Responses
12951069 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1070+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
12971071 parseJSON _ = empty
12981072
12991073instance FromJSON Example where
@@ -1302,16 +1076,16 @@ instance FromJSON Example where
13021076 pure $ Example (Map.mapKeys fromString m)
13031077
13041078instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1079+ parseJSON = genericParseJSON (jsonPrefix "response")
1080+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
13061081
13071082instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1083+ parseJSON = genericParseJSON (jsonPrefix "operation")
1084+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
13091085
13101086instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1312−
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1087+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1088+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
13151089
13161090instance FromJSON Reference where
13171091 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1328,7 +1102,6 @@ referencedParseJSON prefix js@(Object o) = do
13281102 case Text.stripPrefix prefix s of
13291103 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
13301104 Just suffix -> pure (Reference suffix)
1331−referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
13321105
13331106instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
13341107instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1337,91 +1110,25 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
13371110instance FromJSON Xml where
13381111 parseJSON = genericParseJSON (jsonPrefix "xml")
13391112
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1113+instance FromJSON (SwaggerType Schema) where
13411114 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
13421115
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1116+instance FromJSON (SwaggerType ParamOtherSchema) where
13441117 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
13451118
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1119+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
13471120 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
13481121
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
1122+instance FromJSON (CollectionFormat Param) where
13571123 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
13581124
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
1125+instance FromJSON (CollectionFormat Items) where
1126+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1127+
1128+-- NOTE: The constraints @FromJSON (SwaggerType t)@ and
1129+-- @FromJSON (SwaggerItems t)@ are necessary here!
1130+-- Without the constraint the general instance will be used
1131+-- that only accepts common types (i.e. NOT object, null or file)
1132+-- and primitive array items.
1133+instance (FromJSON (SwaggerType t), FromJSON (SwaggerItems t)) => FromJSON (ParamSchema t) where
1134+ parseJSON = genericParseJSON (jsonPrefix "ParamSchema")