@@ -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,89 @@
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−
73−-- | A list of definitions that can be used in references.
74−type Definitions = InsOrdHashMap Text
75−
7636-- | This is the root document object for the API specification.
7737data Swagger = Swagger
7838 { -- | Provides metadata about the API.
7939 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
40+ _info :: Info
8141
8242 -- | The host (name or ip) serving the API. It MAY include a port.
8343 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
44+ , _host :: Maybe Host
8545
8646 -- | The base path on which the API is served, which is relative to the host.
8747 -- If it is not included, the API is served directly under the host.
8848 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
49+ , _basePath :: Maybe FilePath
9050
9151 -- | The transfer protocol of the API.
9252 -- 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]
53+ , _schemes :: Maybe [Scheme]
9454
9555 -- | A list of MIME types the APIs can consume.
9656 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
57+ , _consumes :: MimeList
9858
9959 -- | 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
60+ -- This is global to all APIs but can be overridden on specific API calls.
61+ , _produces :: MimeList
10262
10363 -- | 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
64+ , _paths :: Paths
10765
10866 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
67+ , _definitions :: HashMap Text Schema
11068
11169 -- | An object to hold parameters that can be used across operations.
11270 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
71+ , _parameters :: HashMap Text Param
11472
11573 -- | An object to hold responses that can be used across operations.
11674 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
75+ , _responses :: HashMap Text Response
11876
11977 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
78+ , _securityDefinitions :: HashMap Text SecurityScheme
12179
12280 -- | A declaration of which security schemes are applied for the API as a whole.
12381 -- The list of values describes alternative security schemes that can be used
12482 -- (that is, there is a logical OR between the security requirements).
12583 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
84+ , _security :: [SecurityRequirement]
12785
12886 -- | A list of tags used by the specification with additional metadata.
12987 -- The order of the tags can be used to reflect on their order by the parsing tools.
13088 -- Not all tags that are used by the Operation Object must be declared.
13189 -- The tags that are not declared may be organized randomly or based on the tools' logic.
13290 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
91+ , _tags :: [Tag]
13492
13593 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
94+ , _externalDocs :: Maybe ExternalDocs
13795 } deriving (Eq, Show, Generic, Data, Typeable)
13896
13997-- | The object provides metadata about the API.
@@ -182,18 +140,12 @@ data License = License
182140 , _licenseUrl :: Maybe URL
183141 } deriving (Eq, Show, Generic, Data, Typeable)
184142
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
187−
188143-- | The host (name or ip) serving the API. It MAY include a port.
189144data Host = Host
190145 { _hostName :: HostName -- ^ Host name.
191146 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192147 } deriving (Eq, Show, Generic, Typeable)
193148
194−instance IsString Host where
195− fromString s = Host s Nothing
196−
197149hostConstr :: Constr
198150hostConstr = mkConstr hostDataType "Host" [] Prefix
199151
@@ -215,6 +167,13 @@ data Scheme
215167 | Wss
216168 deriving (Eq, Show, Generic, Data, Typeable)
217169
170+-- | The available paths and operations for the API.
171+data Paths = Paths
172+ { -- | Holds the relative paths to the individual endpoints.
173+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
174+ _pathsMap :: HashMap FilePath PathItem
175+ } deriving (Eq, Show, Generic, Data, Typeable)
176+
218177-- | Describes the operations available on a single path.
219178-- A @'PathItem'@ may be empty, due to ACL constraints.
220179-- The path itself is still exposed to the documentation viewer
@@ -252,7 +211,7 @@ data PathItem = PathItem
252211data Operation = Operation
253212 { -- | A list of tags for API documentation control.
254213 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
214+ _operationTags :: [Text]
256215
257216 -- | A short summary of what the operation does.
258217 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -309,7 +268,7 @@ data Operation = Operation
309268 } deriving (Eq, Show, Generic, Data, Typeable)
310269
311270newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
271+ deriving (Eq, Show, Monoid, Typeable)
313272
314273mimeListConstr :: Constr
315274mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -360,92 +319,36 @@ data ParamOtherSchema = ParamOtherSchema
360319 -- Default value is @False@.
361320 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362321
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.
322+ -- | Determines the format of the array if @'ParamArray'@ is used.
323+ -- Default value is csv.
324+ , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
325+
326+ , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema
327+ } deriving (Eq, Show, Generic, Data, Typeable)
328+
376329data 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)
330+ SwaggerItemsPrimitive :: Items -> SwaggerItems t
331+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems Schema
332+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems Schema
381333
382334deriving instance Eq (SwaggerItems t)
383335deriving instance Show (SwaggerItems t)
384−--deriving instance Typeable (SwaggerItems t)
336+deriving instance Typeable (SwaggerItems t)
385337
386338swaggerItemsPrimitiveConstr :: Constr
387339swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388340
389−swaggerItemsObjectConstr :: Constr
390−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391−
392−swaggerItemsArrayConstr :: Constr
393−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394−
395341swaggerItemsDataType :: DataType
396342swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397343
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
344+instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerItems t) where
403345 gunfold k z c = case constrIndex c of
404− 1 -> k (k (z SwaggerItemsPrimitive))
346+ 1 -> k (z SwaggerItemsPrimitive)
405347 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406348 toConstr _ = swaggerItemsPrimitiveConstr
407349 dataTypeOf _ = swaggerItemsDataType
408350
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
351+deriving instance Data (SwaggerItems Schema)
449352
450353data SwaggerType t where
451354 SwaggerString :: SwaggerType t
@@ -453,44 +356,44 @@ data SwaggerType t where
453356 SwaggerInteger :: SwaggerType t
454357 SwaggerBoolean :: SwaggerType t
455358 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
459− deriving (Typeable)
359+ SwaggerFile :: SwaggerType ParamOtherSchema
360+ SwaggerNull :: SwaggerType Schema
361+ SwaggerObject :: SwaggerType Schema
460362
461363deriving instance Eq (SwaggerType t)
462364deriving instance Show (SwaggerType t)
365+deriving instance Typeable (SwaggerType t)
463366
464367swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465368swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466369
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
370+swaggerTypeDataType :: Data (SwaggerType t) => SwaggerType t -> DataType
468371swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
469372
470−swaggerCommonTypes :: [SwaggerType k]
373+swaggerCommonTypes :: [SwaggerType t]
471374swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472375
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
376+swaggerParamTypes :: [SwaggerType ParamOtherSchema]
474377swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475378
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
379+swaggerSchemaTypes :: [SwaggerType Schema]
477380swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
478381
479382swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
383+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType Schema])
481384 ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
482385
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
386+instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerType t) where
484387 gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485388 toConstr = swaggerTypeConstr
486389 dataTypeOf = swaggerTypeDataType
487390
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
391+instance {-# OVERLAPPING #-} Data (SwaggerType ParamOtherSchema) where
489392 gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490393 toConstr = swaggerTypeConstr
491394 dataTypeOf = swaggerTypeDataType
492395
493−instance Data (SwaggerType 'SwaggerKindSchema) where
396+instance {-# OVERLAPPING #-} Data (SwaggerType Schema) where
494397 gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495398 toConstr = swaggerTypeConstr
496399 dataTypeOf = swaggerTypeDataType
@@ -530,11 +433,11 @@ data CollectionFormat t where
530433 -- Corresponds to multiple parameter instances
531434 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532435 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
436+ CollectionMulti :: CollectionFormat Param
535437
536438deriving instance Eq (CollectionFormat t)
537439deriving instance Show (CollectionFormat t)
440+deriving instance Typeable (CollectionFormat t)
538441
539442collectionFormatConstr :: CollectionFormat t -> Constr
540443collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
@@ -546,12 +449,12 @@ collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
546449collectionCommonFormats :: [CollectionFormat t]
547450collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548451
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
452+instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
550453 gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551454 toConstr = collectionFormatConstr
552455 dataTypeOf _ = collectionFormatDataType
553456
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
457+deriving instance {-# OVERLAPPING #-} Data (CollectionFormat Param)
555458
556459type ParamName = Text
557460
@@ -560,9 +463,9 @@ data Schema = Schema
560463 , _schemaDescription :: Maybe Text
561464 , _schemaRequired :: [ParamName]
562465
563− , _schemaAllOf :: Maybe [Referenced Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
466+ , _schemaAllOf :: Maybe [Schema]
467+ , _schemaProperties :: HashMap Text (Referenced Schema)
468+ , _schemaAdditionalProperties :: Maybe Schema
566469
567470 , _schemaDiscriminator :: Maybe Text
568471 , _schemaReadOnly :: Maybe Bool
@@ -573,20 +476,10 @@ data Schema = Schema
573476 , _schemaMaxProperties :: Maybe Integer
574477 , _schemaMinProperties :: Maybe Integer
575478
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
577− } deriving (Eq, Show, Generic, Data, Typeable)
578−
579−-- | A @'Schema'@ with an optional name.
580−-- This name can be used in references.
581−data NamedSchema = NamedSchema
582− { _namedSchemaName :: Maybe Text
583− , _namedSchemaSchema :: Schema
479+ , _schemaParamSchema :: ParamSchema Schema
584480 } deriving (Eq, Show, Generic, Data, Typeable)
585481
586−-- | Regex pattern for @string@ type.
587−type Pattern = Text
588−
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
482+data ParamSchema t = ParamSchema
590483 { -- | Declares the value of the parameter that the server will use if none is provided,
591484 -- for example a @"count"@ to control the number of results per page might default to @100@
592485 -- if not supplied by the client in the request.
@@ -594,7 +487,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
594487 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595488 _paramSchemaDefault :: Maybe Value
596489
597− , _paramSchemaType :: Maybe (SwaggerType t)
490+ , _paramSchemaType :: SwaggerType t
598491 , _paramSchemaFormat :: Maybe Format
599492 , _paramSchemaItems :: Maybe (SwaggerItems t)
600493 , _paramSchemaMaximum :: Maybe Scientific
@@ -603,7 +496,7 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
603496 , _paramSchemaExclusiveMinimum :: Maybe Bool
604497 , _paramSchemaMaxLength :: Maybe Integer
605498 , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
499+ , _paramSchemaPattern :: Maybe Text
607500 , _paramSchemaMaxItems :: Maybe Integer
608501 , _paramSchemaMinItems :: Maybe Integer
609502 , _paramSchemaUniqueItems :: Maybe Bool
@@ -611,11 +504,11 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
611504 , _paramSchemaMultipleOf :: Maybe Scientific
612505 } deriving (Eq, Show, Generic, Typeable)
613506
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
507+deriving instance (Data t, Data (SwaggerType t), Data (SwaggerItems t)) => Data (ParamSchema t)
615508
616509data Xml = Xml
617510 { -- | 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.
511+ -- When defined within the @'Items'@ (items), it will affect the name of the individual XML elements within the list.
619512 -- When defined alongside type being array (outside the items),
620513 -- it will affect the wrapping element and only if wrapped is true.
621514 -- If wrapped is false, it will be ignored.
@@ -641,6 +534,14 @@ data Xml = Xml
641534 , _xmlWrapped :: Maybe Bool
642535 } deriving (Eq, Show, Generic, Data, Typeable)
643536
537+data Items = Items
538+ { -- | Determines the format of the array if type array is used.
539+ -- Default value is @'ItemsCollectionCSV'@.
540+ _itemsCollectionFormat :: Maybe (CollectionFormat Items)
541+
542+ , _itemsParamSchema :: ParamSchema Items
543+ } deriving (Eq, Show, Generic, Data, Typeable)
544+
644545-- | A container for the expected responses of an operation.
645546-- The container maps a HTTP response code to the expected response.
646547-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
@@ -653,7 +554,7 @@ data Responses = Responses
653554
654555 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655556 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
557+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657558 } deriving (Eq, Show, Generic, Data, Typeable)
658559
659560type HttpStatusCode = Int
@@ -672,22 +573,23 @@ data Response = Response
672573 , _responseSchema :: Maybe (Referenced Schema)
673574
674575 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
576+ , _responseHeaders :: HashMap HeaderName Header
676577
677578 -- | An example of the response message.
678579 , _responseExamples :: Maybe Example
679580 } deriving (Eq, Show, Generic, Data, Typeable)
680581
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
683−
684582type HeaderName = Text
685583
686584data Header = Header
687585 { -- | A short description of the header.
688586 _headerDescription :: Maybe Text
689587
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
588+ -- | Determines the format of the array if type array is used.
589+ -- Default value is @'ItemsCollectionCSV'@.
590+ , _headerCollectionFormat :: Maybe (CollectionFormat Items)
591+
592+ , _headerParamSchema :: ParamSchema Header
691593 } deriving (Eq, Show, Generic, Data, Typeable)
692594
693595data Example = Example { getExample :: Map MediaType Value }
@@ -738,7 +640,7 @@ data OAuth2Params = OAuth2Params
738640 _oauth2Flow :: OAuth2Flow
739641
740642 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
643+ , _oauth2Scopes :: HashMap Text Text
742644 } deriving (Eq, Show, Generic, Data, Typeable)
743645
744646data SecuritySchemeType
@@ -755,37 +657,18 @@ data SecurityScheme = SecurityScheme
755657 , _securitySchemeDescription :: Maybe Text
756658 } deriving (Eq, Show, Generic, Data, Typeable)
757659
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−
774660-- | Lists the required security schemes to execute this operation.
775661-- The object can have multiple security schemes declared in it which are all required
776662-- (that is, there is a logical AND between the schemes).
777663newtype 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
664+ { getSecurityRequirement :: HashMap Text [Text]
665+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
783666
784667-- | Allows adding meta data to a single tag that is used by @Operation@.
785668-- It is not mandatory to have a @Tag@ per tag used there.
786669data Tag = Tag
787670 { -- | The name of the tag.
788− _tagName :: TagName
671+ _tagName :: Text
789672
790673 -- | A short description for the tag.
791674 -- GFM syntax can be used for rich text representation.
@@ -793,12 +676,7 @@ data Tag = Tag
793676
794677 -- | Additional external documentation for this tag.
795678 , _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
679+ } deriving (Eq, Show, Generic, Data, Typeable)
802680
803681-- | Allows referencing an external resource for extended documentation.
804682data ExternalDocs = ExternalDocs
@@ -808,9 +686,7 @@ data ExternalDocs = ExternalDocs
808686
809687 -- | The URL for the target documentation.
810688 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812−
813−instance Hashable ExternalDocs
689+ } deriving (Eq, Show, Generic, Data, Typeable)
814690
815691-- | A simple object to allow referencing other definitions in the specification.
816692-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -820,122 +696,68 @@ newtype Reference = Reference { getReference :: Text }
820696data Referenced a
821697 = Ref Reference
822698 | 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)
833699 deriving (Eq, Show, Data, Typeable)
834700
701+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
702+
835703-- =======================================================================
836704-- Monoid instances
837705-- =======================================================================
838706
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841707instance Monoid Swagger where
842708 mempty = genericMempty
843− mappend = (<>)
709+ mappend = genericMappend
844710
845−instance Semigroup Info where
846− (<>) = genericMappend
847711instance Monoid Info where
848712 mempty = genericMempty
849− mappend = (<>)
713+ mappend = genericMappend
850714
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
715+instance Monoid Paths where
854716 mempty = genericMempty
855− mappend = (<>)
717+ mappend = genericMappend
856718
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859719instance Monoid PathItem where
860720 mempty = genericMempty
861− mappend = (<>)
721+ mappend = genericMappend
862722
863−instance Semigroup Schema where
864− (<>) = genericMappend
865723instance Monoid Schema where
866724 mempty = genericMempty
867− mappend = (<>)
725+ mappend = genericMappend
868726
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871727instance Monoid (ParamSchema t) where
872728 mempty = genericMempty
873− mappend = (<>)
729+ mappend = genericMappend
874730
875−instance Semigroup Param where
876− (<>) = genericMappend
877731instance Monoid Param where
878732 mempty = genericMempty
879− mappend = (<>)
733+ mappend = genericMappend
880734
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883735instance Monoid ParamOtherSchema where
884736 mempty = genericMempty
885− mappend = (<>)
737+ mappend = genericMappend
886738
887−instance Semigroup Header where
888− (<>) = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
891− mappend = (<>)
892−
893−instance Semigroup Responses where
894− (<>) = genericMappend
895739instance Monoid Responses where
896740 mempty = genericMempty
897− mappend = (<>)
741+ mappend = genericMappend
898742
899−instance Semigroup Response where
900− (<>) = genericMappend
901743instance Monoid Response where
902744 mempty = genericMempty
903− mappend = (<>)
745+ mappend = genericMappend
904746
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907747instance Monoid ExternalDocs where
908748 mempty = genericMempty
909− mappend = (<>)
749+ mappend = genericMappend
910750
911−instance Semigroup Operation where
912− (<>) = genericMappend
913751instance Monoid Operation where
914752 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 = (<>)
753+ mappend = genericMappend
933754
934755-- =======================================================================
935756-- SwaggerMonoid helper instances
936757-- =======================================================================
937758
938759instance SwaggerMonoid Info
760+instance SwaggerMonoid Paths
939761instance SwaggerMonoid PathItem
940762instance SwaggerMonoid Schema
941763instance SwaggerMonoid (ParamSchema t)
@@ -945,8 +767,6 @@ instance SwaggerMonoid Responses
945767instance SwaggerMonoid Response
946768instance SwaggerMonoid ExternalDocs
947769instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950770
951771instance SwaggerMonoid MimeList
952772deriving instance SwaggerMonoid URL
@@ -959,15 +779,43 @@ instance SwaggerMonoid ParamLocation where
959779 swaggerMempty = ParamQuery
960780 swaggerMappend _ y = y
961781
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
782+instance SwaggerMonoid (HashMap Text Schema) where
783+ swaggerMempty = HashMap.empty
784+ swaggerMappend = HashMap.unionWith mappend
785+
786+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
787+ swaggerMempty = HashMap.empty
788+ swaggerMappend = HashMap.unionWith swaggerMappend
965789
966790instance Monoid a => SwaggerMonoid (Referenced a) where
967791 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
792+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
969793 swaggerMappend _ y = y
970794
795+instance SwaggerMonoid (HashMap Text Param) where
796+ swaggerMempty = HashMap.empty
797+ swaggerMappend = HashMap.unionWith mappend
798+
799+instance SwaggerMonoid (HashMap Text Response) where
800+ swaggerMempty = HashMap.empty
801+ swaggerMappend = flip HashMap.union
802+
803+instance SwaggerMonoid (HashMap Text SecurityScheme) where
804+ swaggerMempty = HashMap.empty
805+ swaggerMappend = flip HashMap.union
806+
807+instance SwaggerMonoid (HashMap FilePath PathItem) where
808+ swaggerMempty = HashMap.empty
809+ swaggerMappend = HashMap.unionWith mappend
810+
811+instance SwaggerMonoid (HashMap HeaderName Header) where
812+ swaggerMempty = HashMap.empty
813+ swaggerMappend = flip HashMap.union
814+
815+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
816+ swaggerMempty = HashMap.empty
817+ swaggerMappend = flip HashMap.union
818+
971819instance SwaggerMonoid ParamAnySchema where
972820 swaggerMempty = ParamOther swaggerMempty
973821 swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
@@ -1059,8 +907,7 @@ instance ToJSON OAuth2Flow where
1059907 , "tokenUrl" .= tokenUrl ]
1060908
1061909instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
1063− DEFINE_TOENCODING
910+ toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1064911
1065912instance ToJSON SecuritySchemeType where
1066913 toJSON SecuritySchemeBasic
@@ -1073,38 +920,27 @@ instance ToJSON SecuritySchemeType where
1073920 <+> object [ "type" .= ("oauth2" :: Text) ]
1074921
1075922instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
1077− DEFINE_TOENCODING
923+ toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
924+ where
925+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
926+ addVersion _ = error "impossible"
1078927
1079928instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
1081− DEFINE_TOENCODING
929+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1082930
1083931instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1085− DEFINE_TOENCODING
932+ toJSON = omitEmpties . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1086933
1087934instance 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 ]
935+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
936+
937+instance ToJSON Items where
938+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
939+
940+instance ToJSON (SwaggerItems t) where
941+ toJSON (SwaggerItemsPrimitive x) = toJSON x
942+ toJSON (SwaggerItemsObject x) = toJSON x
943+ toJSON (SwaggerItemsArray x) = toJSON x
1108944
1109945instance ToJSON Host where
1110946 toJSON (Host host mport) = toJSON $
@@ -1112,43 +948,38 @@ instance ToJSON Host where
1112948 Nothing -> host
1113949 Just port -> host ++ ":" ++ show port
1114950
951+instance ToJSON Paths where
952+ toJSON (Paths m) = toJSON m
953+
1115954instance ToJSON MimeList where
1116955 toJSON (MimeList xs) = toJSON (map show xs)
1117956
1118957instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1120− DEFINE_TOENCODING
958+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1121959
1122960instance ToJSON ParamAnySchema where
1123961 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124962 toJSON (ParamOther s) = toJSON s
1125963
1126964instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
1128− DEFINE_TOENCODING
965+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1129966
1130967instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1132− DEFINE_TOENCODING
968+ toJSON (Responses def rs) = omitEmpties $
969+ toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1133970
1134971instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1136− DEFINE_TOENCODING
972+ toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1137973
1138974instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1140− DEFINE_TOENCODING
975+ toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1141976
1142977instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1144− DEFINE_TOENCODING
978+ toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1145979
1146980instance ToJSON Example where
1147981 toJSON = toJSON . Map.mapKeys show . getExample
1148982
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1151−
1152983instance ToJSON Reference where
1153984 toJSON (Reference ref) = object [ "$ref" .= ref ]
1154985
@@ -1177,14 +1008,8 @@ instance ToJSON (CollectionFormat t) where
11771008 toJSON CollectionPipes = "pipes"
11781009 toJSON CollectionMulti = "multi"
11791010
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
1011+instance ToJSON (ParamSchema t) where
1012+ toJSON = genericToJSON (jsonPrefix "paramSchema")
11881013
11891014-- =======================================================================
11901015-- Manual FromJSON instances
@@ -1204,7 +1029,7 @@ instance FromJSON OAuth2Flow where
12041029 parseJSON _ = empty
12051030
12061031instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
1032+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
12081033
12091034instance FromJSON SecuritySchemeType where
12101035 parseJSON js@(Object o) = do
@@ -1217,65 +1042,61 @@ instance FromJSON SecuritySchemeType where
12171042 parseJSON _ = empty
12181043
12191044instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
1045+ parseJSON js@(Object o) = do
1046+ (version :: Text) <- o .: "swagger"
1047+ when (version /= "2.0") empty
1048+ (genericParseJSON (jsonPrefix "")
1049+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
1050+ , "produces" .= (mempty :: MimeList)
1051+ , "security" .= ([] :: [SecurityRequirement])
1052+ , "tags" .= ([] :: [Tag])
1053+ , "definitions" .= (mempty :: HashMap Text Schema)
1054+ , "parameters" .= (mempty :: HashMap Text Param)
1055+ , "responses" .= (mempty :: HashMap Text Response)
1056+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
1057+ ] ) js
1058+ parseJSON _ = empty
12211059
12221060instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
1061+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
12241062
12251063instance 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
1064+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1065+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1066+ , "required" .= ([] :: [ParamName]) ]
12331067
12341068instance 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
1069+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
1070+
1071+instance FromJSON Items where
1072+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
1073+
1074+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerItems t) where
1075+ parseJSON js = SwaggerItemsPrimitive <$> parseJSON js
1076+
1077+instance {-# OVERLAPPING #-} FromJSON (SwaggerItems Schema) where
1078+ parseJSON js@(Object _) = SwaggerItemsObject <$> parseJSON js
12621079 parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
12631080 parseJSON _ = empty
12641081
12651082instance 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 ++ "'"
1083+ parseJSON (String s) =
1084+ case fromInteger <$> readMaybe portStr of
1085+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1086+ mport -> pure $ Host host mport
1087+ where
1088+ (hostText, portText) = Text.breakOn ":" s
1089+ [host, portStr] = map Text.unpack [hostText, portText]
12721090 parseJSON _ = empty
12731091
1092+instance FromJSON Paths where
1093+ parseJSON js = Paths <$> parseJSON js
1094+
12741095instance FromJSON MimeList where
12751096 parseJSON js = (MimeList . map fromString) <$> parseJSON js
12761097
12771098instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
1099+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
12791100
12801101instance FromJSON ParamAnySchema where
12811102 parseJSON js@(Object o) = do
@@ -1288,12 +1109,12 @@ instance FromJSON ParamAnySchema where
12881109 parseJSON _ = empty
12891110
12901111instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
1112+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
12921113
12931114instance FromJSON Responses where
12941115 parseJSON (Object o) = Responses
12951116 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1117+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
12971118 parseJSON _ = empty
12981119
12991120instance FromJSON Example where
@@ -1302,16 +1123,16 @@ instance FromJSON Example where
13021123 pure $ Example (Map.mapKeys fromString m)
13031124
13041125instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1126+ parseJSON = genericParseJSON (jsonPrefix "response")
1127+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
13061128
13071129instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1130+ parseJSON = genericParseJSON (jsonPrefix "operation")
1131+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
13091132
13101133instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1312−
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1134+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1135+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
13151136
13161137instance FromJSON Reference where
13171138 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1328,7 +1149,6 @@ referencedParseJSON prefix js@(Object o) = do
13281149 case Text.stripPrefix prefix s of
13291150 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
13301151 Just suffix -> pure (Reference suffix)
1331−referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
13321152
13331153instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
13341154instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1337,91 +1157,25 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
13371157instance FromJSON Xml where
13381158 parseJSON = genericParseJSON (jsonPrefix "xml")
13391159
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1160+instance FromJSON (SwaggerType Schema) where
13411161 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
13421162
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1163+instance FromJSON (SwaggerType ParamOtherSchema) where
13441164 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
13451165
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1166+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
13471167 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
13481168
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
1169+instance FromJSON (CollectionFormat Param) where
13571170 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
13581171
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
1172+instance FromJSON (CollectionFormat Items) where
1173+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1174+
1175+-- NOTE: The constraints @FromJSON (SwaggerType t)@ and
1176+-- @FromJSON (SwaggerItems t)@ are necessary here!
1177+-- Without the constraint the general instance will be used
1178+-- that only accepts common types (i.e. NOT object, null or file)
1179+-- and primitive array items.
1180+instance (FromJSON (SwaggerType t), FromJSON (SwaggerItems t)) => FromJSON (ParamSchema t) where
1181+ parseJSON = genericParseJSON (jsonPrefix "ParamSchema")