@@ -1,4 +1,7 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
13{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
25{-# LANGUAGE DeriveGeneric #-}
36{-# LANGUAGE DeriveTraversable #-}
47{-# LANGUAGE FlexibleContexts #-}
@@ -9,89 +12,128 @@
912{-# LANGUAGE RecordWildCards #-}
1013{-# LANGUAGE ScopedTypeVariables #-}
1114{-# LANGUAGE StandaloneDeriving #-}
15+{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
1217{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
20+#endif
21+#include "overlapping-compat.h"
1322module Data.Swagger.Internal where
1423
24+import Prelude ()
25+import Prelude.Compat
26+
27+import Control.Lens ((&), (.~), (?~))
1528import Control.Applicative
16−import Control.Monad
1729import Data.Aeson
1830import qualified Data.Aeson.Types as JSON
1931import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
20−import Data.HashMap.Strict (HashMap)
32+import Data.Hashable (Hashable)
2133import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
2235import Data.Map (Map)
2336import qualified Data.Map as Map
24−import Data.Monoid
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
2539import Data.Scientific (Scientific)
26−import Data.String (fromString)
40+import Data.String (IsString(..))
2741import Data.Text (Text)
2842import qualified Data.Text as Text
2943import GHC.Generics (Generic)
30−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
3145import Network.HTTP.Media (MediaType)
3246import Text.Read (readMaybe)
3347
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)
3460import Data.Swagger.Internal.Utils
3561
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+
3676-- | This is the root document object for the API specification.
3777data Swagger = Swagger
3878 { -- | Provides metadata about the API.
3979 -- The metadata can be used by the clients if needed.
40− _info :: Info
80+ _swaggerInfo :: Info
4181
4282 -- | The host (name or ip) serving the API. It MAY include a port.
4383 -- If the host is not included, the host serving the documentation is to be used (including the port).
44− , _host :: Maybe Host
84+ , _swaggerHost :: Maybe Host
4585
4686 -- | The base path on which the API is served, which is relative to the host.
4787 -- If it is not included, the API is served directly under the host.
4888 -- The value MUST start with a leading slash (/).
49− , _basePath :: Maybe FilePath
89+ , _swaggerBasePath :: Maybe FilePath
5090
5191 -- | The transfer protocol of the API.
5292 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
53− , _schemes :: Maybe [Scheme]
93+ , _swaggerSchemes :: Maybe [Scheme]
5494
5595 -- | A list of MIME types the APIs can consume.
5696 -- This is global to all APIs but can be overridden on specific API calls.
57− , _consumes :: MimeList
97+ , _swaggerConsumes :: MimeList
5898
5999 -- | A list of MIME types the APIs can produce.
60− -- This is global to all APIs but can be overridden on specific API calls.
61− , _produces :: MimeList
100+ -- This is global to all APIs but can be overridden on specific API calls.
101+ , _swaggerProduces :: MimeList
62102
63103 -- | The available paths and operations for the API.
64− , _paths :: Paths
104+ -- Holds the relative paths to the individual endpoints.
105+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
106+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
65107
66108 -- | An object to hold data types produced and consumed by operations.
67− , _definitions :: HashMap Text Schema
109+ , _swaggerDefinitions :: Definitions Schema
68110
69111 -- | An object to hold parameters that can be used across operations.
70112 -- This property does not define global parameters for all operations.
71− , _parameters :: HashMap Text Param
113+ , _swaggerParameters :: Definitions Param
72114
73115 -- | An object to hold responses that can be used across operations.
74116 -- This property does not define global responses for all operations.
75− , _responses :: HashMap Text Response
117+ , _swaggerResponses :: Definitions Response
76118
77119 -- | Security scheme definitions that can be used across the specification.
78− , _securityDefinitions :: HashMap Text SecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
79121
80122 -- | A declaration of which security schemes are applied for the API as a whole.
81123 -- The list of values describes alternative security schemes that can be used
82124 -- (that is, there is a logical OR between the security requirements).
83125 -- Individual operations can override this definition.
84− , _security :: [SecurityRequirement]
126+ , _swaggerSecurity :: [SecurityRequirement]
85127
86128 -- | A list of tags used by the specification with additional metadata.
87129 -- The order of the tags can be used to reflect on their order by the parsing tools.
88130 -- Not all tags that are used by the Operation Object must be declared.
89131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
90132 -- Each tag name in the list MUST be unique.
91− , _tags :: [Tag]
133+ , _swaggerTags :: InsOrdHashSet Tag
92134
93135 -- | Additional external documentation.
94− , _externalDocs :: Maybe ExternalDocs
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
95137 } deriving (Eq, Show, Generic, Data, Typeable)
96138
97139-- | The object provides metadata about the API.
@@ -140,12 +182,18 @@ data License = License
140182 , _licenseUrl :: Maybe URL
141183 } deriving (Eq, Show, Generic, Data, Typeable)
142184
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
187+
143188-- | The host (name or ip) serving the API. It MAY include a port.
144189data Host = Host
145190 { _hostName :: HostName -- ^ Host name.
146191 , _hostPort :: Maybe PortNumber -- ^ Optional port.
147192 } deriving (Eq, Show, Generic, Typeable)
148193
194+instance IsString Host where
195+ fromString s = Host s Nothing
196+
149197hostConstr :: Constr
150198hostConstr = mkConstr hostDataType "Host" [] Prefix
151199
@@ -167,13 +215,6 @@ data Scheme
167215 | Wss
168216 deriving (Eq, Show, Generic, Data, Typeable)
169217
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−
177218-- | Describes the operations available on a single path.
178219-- A @'PathItem'@ may be empty, due to ACL constraints.
179220-- The path itself is still exposed to the documentation viewer
@@ -211,7 +252,7 @@ data PathItem = PathItem
211252data Operation = Operation
212253 { -- | A list of tags for API documentation control.
213254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
214− _operationTags :: [Text]
255+ _operationTags :: InsOrdHashSet TagName
215256
216257 -- | A short summary of what the operation does.
217258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -268,7 +309,7 @@ data Operation = Operation
268309 } deriving (Eq, Show, Generic, Data, Typeable)
269310
270311newtype MimeList = MimeList { getMimeList :: [MediaType] }
271− deriving (Eq, Show, Monoid, Typeable)
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
272313
273314mimeListConstr :: Constr
274315mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -319,36 +360,92 @@ data ParamOtherSchema = ParamOtherSchema
319360 -- Default value is @False@.
320361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
321362
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−
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.
329376data SwaggerItems t where
330− SwaggerItemsPrimitive :: Items -> SwaggerItems t
331− SwaggerItemsObject :: Referenced Schema -> SwaggerItems Schema
332− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems Schema
377+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
378+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
379+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
380+ deriving (Typeable)
333381
334382deriving instance Eq (SwaggerItems t)
335383deriving instance Show (SwaggerItems t)
336−deriving instance Typeable (SwaggerItems t)
384+--deriving instance Typeable (SwaggerItems t)
337385
338386swaggerItemsPrimitiveConstr :: Constr
339387swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
340388
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391+
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394+
341395swaggerItemsDataType :: DataType
342396swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
343397
344−instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerItems t) where
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
345403 gunfold k z c = case constrIndex c of
346− 1 -> k (z SwaggerItemsPrimitive)
404+ 1 -> k (k (z SwaggerItemsPrimitive))
347405 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
348406 toConstr _ = swaggerItemsPrimitiveConstr
349407 dataTypeOf _ = swaggerItemsDataType
350408
351−deriving instance Data (SwaggerItems Schema)
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
352449
353450data SwaggerType t where
354451 SwaggerString :: SwaggerType t
@@ -356,44 +453,44 @@ data SwaggerType t where
356453 SwaggerInteger :: SwaggerType t
357454 SwaggerBoolean :: SwaggerType t
358455 SwaggerArray :: SwaggerType t
359− SwaggerFile :: SwaggerType ParamOtherSchema
360− SwaggerNull :: SwaggerType Schema
361− SwaggerObject :: SwaggerType Schema
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
459+ deriving (Typeable)
362460
363461deriving instance Eq (SwaggerType t)
364462deriving instance Show (SwaggerType t)
365−deriving instance Typeable (SwaggerType t)
366463
367464swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
368465swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
369466
370−swaggerTypeDataType :: Data (SwaggerType t) => SwaggerType t -> DataType
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
371468swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
372469
373−swaggerCommonTypes :: [SwaggerType t]
470+swaggerCommonTypes :: [SwaggerType k]
374471swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
375472
376−swaggerParamTypes :: [SwaggerType ParamOtherSchema]
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
377474swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
378475
379−swaggerSchemaTypes :: [SwaggerType Schema]
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
380477swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
381478
382479swaggerTypeConstrs :: [Constr]
383−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType Schema])
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
384481 ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
385482
386−instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerType t) where
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
387484 gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
388485 toConstr = swaggerTypeConstr
389486 dataTypeOf = swaggerTypeDataType
390487
391−instance {-# OVERLAPPING #-} Data (SwaggerType ParamOtherSchema) where
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
392489 gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
393490 toConstr = swaggerTypeConstr
394491 dataTypeOf = swaggerTypeDataType
395492
396−instance {-# OVERLAPPING #-} Data (SwaggerType Schema) where
493+instance Data (SwaggerType 'SwaggerKindSchema) where
397494 gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
398495 toConstr = swaggerTypeConstr
399496 dataTypeOf = swaggerTypeDataType
@@ -433,11 +530,11 @@ data CollectionFormat t where
433530 -- Corresponds to multiple parameter instances
434531 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
435532 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
436− CollectionMulti :: CollectionFormat Param
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534+ deriving (Typeable)
437535
438536deriving instance Eq (CollectionFormat t)
439537deriving instance Show (CollectionFormat t)
440−deriving instance Typeable (CollectionFormat t)
441538
442539collectionFormatConstr :: CollectionFormat t -> Constr
443540collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
@@ -449,12 +546,12 @@ collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
449546collectionCommonFormats :: [CollectionFormat t]
450547collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
451548
452−instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
453550 gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
454551 toConstr = collectionFormatConstr
455552 dataTypeOf _ = collectionFormatDataType
456553
457−deriving instance {-# OVERLAPPING #-} Data (CollectionFormat Param)
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
458555
459556type ParamName = Text
460557
@@ -463,9 +560,9 @@ data Schema = Schema
463560 , _schemaDescription :: Maybe Text
464561 , _schemaRequired :: [ParamName]
465562
466− , _schemaAllOf :: Maybe [Schema]
467− , _schemaProperties :: HashMap Text (Referenced Schema)
468− , _schemaAdditionalProperties :: Maybe Schema
563+ , _schemaAllOf :: Maybe [Referenced Schema]
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
469566
470567 , _schemaDiscriminator :: Maybe Text
471568 , _schemaReadOnly :: Maybe Bool
@@ -476,10 +573,20 @@ data Schema = Schema
476573 , _schemaMaxProperties :: Maybe Integer
477574 , _schemaMinProperties :: Maybe Integer
478575
479− , _schemaParamSchema :: ParamSchema Schema
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
480584 } deriving (Eq, Show, Generic, Data, Typeable)
481585
482−data ParamSchema t = ParamSchema
586+-- | Regex pattern for @string@ type.
587+type Pattern = Text
588+
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
483590 { -- | Declares the value of the parameter that the server will use if none is provided,
484591 -- for example a @"count"@ to control the number of results per page might default to @100@
485592 -- if not supplied by the client in the request.
@@ -487,7 +594,7 @@ data ParamSchema t = ParamSchema
487594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
488595 _paramSchemaDefault :: Maybe Value
489596
490− , _paramSchemaType :: SwaggerType t
597+ , _paramSchemaType :: Maybe (SwaggerType t)
491598 , _paramSchemaFormat :: Maybe Format
492599 , _paramSchemaItems :: Maybe (SwaggerItems t)
493600 , _paramSchemaMaximum :: Maybe Scientific
@@ -496,7 +603,7 @@ data ParamSchema t = ParamSchema
496603 , _paramSchemaExclusiveMinimum :: Maybe Bool
497604 , _paramSchemaMaxLength :: Maybe Integer
498605 , _paramSchemaMinLength :: Maybe Integer
499− , _paramSchemaPattern :: Maybe Text
606+ , _paramSchemaPattern :: Maybe Pattern
500607 , _paramSchemaMaxItems :: Maybe Integer
501608 , _paramSchemaMinItems :: Maybe Integer
502609 , _paramSchemaUniqueItems :: Maybe Bool
@@ -504,11 +611,11 @@ data ParamSchema t = ParamSchema
504611 , _paramSchemaMultipleOf :: Maybe Scientific
505612 } deriving (Eq, Show, Generic, Typeable)
506613
507−deriving instance (Data t, Data (SwaggerType t), Data (SwaggerItems t)) => Data (ParamSchema t)
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
508615
509616data Xml = Xml
510617 { -- | Replaces the name of the element/attribute used for the described schema property.
511− -- When defined within the @'Items'@ (items), it will affect the name of the individual XML elements within the list.
618+ -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
512619 -- When defined alongside type being array (outside the items),
513620 -- it will affect the wrapping element and only if wrapped is true.
514621 -- If wrapped is false, it will be ignored.
@@ -534,14 +641,6 @@ data Xml = Xml
534641 , _xmlWrapped :: Maybe Bool
535642 } deriving (Eq, Show, Generic, Data, Typeable)
536643
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−
545644-- | A container for the expected responses of an operation.
546645-- The container maps a HTTP response code to the expected response.
547646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
@@ -554,7 +653,7 @@ data Responses = Responses
554653
555654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
556655 -- Describes the expected response for those HTTP status codes.
557− , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
558657 } deriving (Eq, Show, Generic, Data, Typeable)
559658
560659type HttpStatusCode = Int
@@ -573,23 +672,22 @@ data Response = Response
573672 , _responseSchema :: Maybe (Referenced Schema)
574673
575674 -- | A list of headers that are sent with the response.
576− , _responseHeaders :: HashMap HeaderName Header
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
577676
578677 -- | An example of the response message.
579678 , _responseExamples :: Maybe Example
580679 } deriving (Eq, Show, Generic, Data, Typeable)
581680
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
683+
582684type HeaderName = Text
583685
584686data Header = Header
585687 { -- | A short description of the header.
586688 _headerDescription :: Maybe Text
587689
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
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
593691 } deriving (Eq, Show, Generic, Data, Typeable)
594692
595693data Example = Example { getExample :: Map MediaType Value }
@@ -640,7 +738,7 @@ data OAuth2Params = OAuth2Params
640738 _oauth2Flow :: OAuth2Flow
641739
642740 -- | The available scopes for the OAuth2 security scheme.
643− , _oauth2Scopes :: HashMap Text Text
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
644742 } deriving (Eq, Show, Generic, Data, Typeable)
645743
646744data SecuritySchemeType
@@ -657,18 +755,37 @@ data SecurityScheme = SecurityScheme
657755 , _securitySchemeDescription :: Maybe Text
658756 } deriving (Eq, Show, Generic, Data, Typeable)
659757
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+
660774-- | Lists the required security schemes to execute this operation.
661775-- The object can have multiple security schemes declared in it which are all required
662776-- (that is, there is a logical AND between the schemes).
663777newtype SecurityRequirement = SecurityRequirement
664− { getSecurityRequirement :: HashMap Text [Text]
665− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
780+
781+-- | Tag name.
782+type TagName = Text
666783
667784-- | Allows adding meta data to a single tag that is used by @Operation@.
668785-- It is not mandatory to have a @Tag@ per tag used there.
669786data Tag = Tag
670787 { -- | The name of the tag.
671− _tagName :: Text
788+ _tagName :: TagName
672789
673790 -- | A short description for the tag.
674791 -- GFM syntax can be used for rich text representation.
@@ -676,7 +793,12 @@ data Tag = Tag
676793
677794 -- | Additional external documentation for this tag.
678795 , _tagExternalDocs :: Maybe ExternalDocs
679− } deriving (Eq, Show, Generic, Data, Typeable)
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
680802
681803-- | Allows referencing an external resource for extended documentation.
682804data ExternalDocs = ExternalDocs
@@ -686,7 +808,9 @@ data ExternalDocs = ExternalDocs
686808
687809 -- | The URL for the target documentation.
688810 , _externalDocsUrl :: URL
689− } deriving (Eq, Show, Generic, Data, Typeable)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812+
813+instance Hashable ExternalDocs
690814
691815-- | A simple object to allow referencing other definitions in the specification.
692816-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -696,68 +820,122 @@ newtype Reference = Reference { getReference :: Text }
696820data Referenced a
697821 = Ref Reference
698822 | Inline a
699− deriving (Eq, Show, Data, Typeable)
823+ deriving (Eq, Show, Functor, Data, Typeable)
824+
825+instance IsString a => IsString (Referenced a) where
826+ fromString = Inline . fromString
700827
701−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
829+
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
702834
703835-- =======================================================================
704836-- Monoid instances
705837-- =======================================================================
706838
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
707841instance Monoid Swagger where
708842 mempty = genericMempty
709− mappend = genericMappend
843+ mappend = (<>)
710844
845+instance Semigroup Info where
846+ (<>) = genericMappend
711847instance Monoid Info where
712848 mempty = genericMempty
713− mappend = genericMappend
849+ mappend = (<>)
714850
715−instance Monoid Paths where
851+instance Semigroup Contact where
852+ (<>) = genericMappend
853+instance Monoid Contact where
716854 mempty = genericMempty
717− mappend = genericMappend
855+ mappend = (<>)
718856
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
719859instance Monoid PathItem where
720860 mempty = genericMempty
721− mappend = genericMappend
861+ mappend = (<>)
722862
863+instance Semigroup Schema where
864+ (<>) = genericMappend
723865instance Monoid Schema where
724866 mempty = genericMempty
725− mappend = genericMappend
867+ mappend = (<>)
726868
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
727871instance Monoid (ParamSchema t) where
728872 mempty = genericMempty
729− mappend = genericMappend
873+ mappend = (<>)
730874
875+instance Semigroup Param where
876+ (<>) = genericMappend
731877instance Monoid Param where
732878 mempty = genericMempty
733− mappend = genericMappend
879+ mappend = (<>)
734880
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
735883instance Monoid ParamOtherSchema where
736884 mempty = genericMempty
737− mappend = genericMappend
885+ mappend = (<>)
738886
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
739895instance Monoid Responses where
740896 mempty = genericMempty
741− mappend = genericMappend
897+ mappend = (<>)
742898
899+instance Semigroup Response where
900+ (<>) = genericMappend
743901instance Monoid Response where
744902 mempty = genericMempty
745− mappend = genericMappend
903+ mappend = (<>)
746904
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
747907instance Monoid ExternalDocs where
748908 mempty = genericMempty
749− mappend = genericMappend
909+ mappend = (<>)
750910
911+instance Semigroup Operation where
912+ (<>) = genericMappend
751913instance Monoid Operation where
752914 mempty = genericMempty
753− mappend = genericMappend
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 = (<>)
754933
755934-- =======================================================================
756935-- SwaggerMonoid helper instances
757936-- =======================================================================
758937
759938instance SwaggerMonoid Info
760−instance SwaggerMonoid Paths
761939instance SwaggerMonoid PathItem
762940instance SwaggerMonoid Schema
763941instance SwaggerMonoid (ParamSchema t)
@@ -767,6 +945,8 @@ instance SwaggerMonoid Responses
767945instance SwaggerMonoid Response
768946instance SwaggerMonoid ExternalDocs
769947instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
770950
771951instance SwaggerMonoid MimeList
772952deriving instance SwaggerMonoid URL
@@ -779,43 +959,15 @@ instance SwaggerMonoid ParamLocation where
779959 swaggerMempty = ParamQuery
780960 swaggerMappend _ y = y
781961
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
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963+ swaggerMempty = InsOrdHashMap.empty
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
789965
790966instance Monoid a => SwaggerMonoid (Referenced a) where
791967 swaggerMempty = Inline mempty
792− swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
793969 swaggerMappend _ y = y
794970
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−
819971instance SwaggerMonoid ParamAnySchema where
820972 swaggerMempty = ParamOther swaggerMempty
821973 swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
@@ -907,7 +1059,8 @@ instance ToJSON OAuth2Flow where
9071059 , "tokenUrl" .= tokenUrl ]
9081060
9091061instance ToJSON OAuth2Params where
910− toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1062+ toJSON = sopSwaggerGenericToJSON
1063+ DEFINE_TOENCODING
9111064
9121065instance ToJSON SecuritySchemeType where
9131066 toJSON SecuritySchemeBasic
@@ -920,27 +1073,38 @@ instance ToJSON SecuritySchemeType where
9201073 <+> object [ "type" .= ("oauth2" :: Text) ]
9211074
9221075instance ToJSON Swagger where
923− toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
924− where
925− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
926− addVersion _ = error "impossible"
1076+ toJSON = sopSwaggerGenericToJSON
1077+ DEFINE_TOENCODING
9271078
9281079instance ToJSON SecurityScheme where
929− toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1080+ toJSON = sopSwaggerGenericToJSON
1081+ DEFINE_TOENCODING
9301082
9311083instance ToJSON Schema where
932− toJSON = omitEmpties . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1084+ toJSON = sopSwaggerGenericToJSON
1085+ DEFINE_TOENCODING
9331086
9341087instance ToJSON Header where
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
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 ]
9441108
9451109instance ToJSON Host where
9461110 toJSON (Host host mport) = toJSON $
@@ -948,38 +1112,43 @@ instance ToJSON Host where
9481112 Nothing -> host
9491113 Just port -> host ++ ":" ++ show port
9501114
951−instance ToJSON Paths where
952− toJSON (Paths m) = toJSON m
953−
9541115instance ToJSON MimeList where
9551116 toJSON (MimeList xs) = toJSON (map show xs)
9561117
9571118instance ToJSON Param where
958− toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1119+ toJSON = sopSwaggerGenericToJSON
1120+ DEFINE_TOENCODING
9591121
9601122instance ToJSON ParamAnySchema where
9611123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
9621124 toJSON (ParamOther s) = toJSON s
9631125
9641126instance ToJSON ParamOtherSchema where
965− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1127+ toJSON = sopSwaggerGenericToJSON
1128+ DEFINE_TOENCODING
9661129
9671130instance ToJSON Responses where
968− toJSON (Responses def rs) = omitEmpties $
969− toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1131+ toJSON = sopSwaggerGenericToJSON
1132+ DEFINE_TOENCODING
9701133
9711134instance ToJSON Response where
972− toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1135+ toJSON = sopSwaggerGenericToJSON
1136+ DEFINE_TOENCODING
9731137
9741138instance ToJSON Operation where
975− toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1139+ toJSON = sopSwaggerGenericToJSON
1140+ DEFINE_TOENCODING
9761141
9771142instance ToJSON PathItem where
978− toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1143+ toJSON = sopSwaggerGenericToJSON
1144+ DEFINE_TOENCODING
9791145
9801146instance ToJSON Example where
9811147 toJSON = toJSON . Map.mapKeys show . getExample
9821148
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
1151+
9831152instance ToJSON Reference where
9841153 toJSON (Reference ref) = object [ "$ref" .= ref ]
9851154
@@ -1008,8 +1177,14 @@ instance ToJSON (CollectionFormat t) where
10081177 toJSON CollectionPipes = "pipes"
10091178 toJSON CollectionMulti = "multi"
10101179
1011−instance ToJSON (ParamSchema t) where
1012− toJSON = genericToJSON (jsonPrefix "paramSchema")
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
10131188
10141189-- =======================================================================
10151190-- Manual FromJSON instances
@@ -1029,7 +1204,7 @@ instance FromJSON OAuth2Flow where
10291204 parseJSON _ = empty
10301205
10311206instance FromJSON OAuth2Params where
1032− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1207+ parseJSON = sopSwaggerGenericParseJSON
10331208
10341209instance FromJSON SecuritySchemeType where
10351210 parseJSON js@(Object o) = do
@@ -1042,61 +1217,65 @@ instance FromJSON SecuritySchemeType where
10421217 parseJSON _ = empty
10431218
10441219instance FromJSON Swagger where
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
1220+ parseJSON = sopSwaggerGenericParseJSON
10591221
10601222instance FromJSON SecurityScheme where
1061− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1223+ parseJSON = sopSwaggerGenericParseJSON
10621224
10631225instance FromJSON Schema where
1064− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1065− `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1066− , "required" .= ([] :: [ParamName]) ]
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
10671233
10681234instance FromJSON Header where
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
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
10791262 parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
10801263 parseJSON _ = empty
10811264
10821265instance FromJSON Host where
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]
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 ++ "'"
10901272 parseJSON _ = empty
10911273
1092−instance FromJSON Paths where
1093− parseJSON js = Paths <$> parseJSON js
1094−
10951274instance FromJSON MimeList where
10961275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
10971276
10981277instance FromJSON Param where
1099− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1278+ parseJSON = sopSwaggerGenericParseJSON
11001279
11011280instance FromJSON ParamAnySchema where
11021281 parseJSON js@(Object o) = do
@@ -1109,12 +1288,12 @@ instance FromJSON ParamAnySchema where
11091288 parseJSON _ = empty
11101289
11111290instance FromJSON ParamOtherSchema where
1112− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1291+ parseJSON = sopSwaggerGenericParseJSON
11131292
11141293instance FromJSON Responses where
11151294 parseJSON (Object o) = Responses
11161295 <$> o .:? "default"
1117− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
11181297 parseJSON _ = empty
11191298
11201299instance FromJSON Example where
@@ -1123,16 +1302,16 @@ instance FromJSON Example where
11231302 pure $ Example (Map.mapKeys fromString m)
11241303
11251304instance FromJSON Response where
1126− parseJSON = genericParseJSON (jsonPrefix "response")
1127− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1305+ parseJSON = sopSwaggerGenericParseJSON
11281306
11291307instance FromJSON Operation where
1130− parseJSON = genericParseJSON (jsonPrefix "operation")
1131− `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1308+ parseJSON = sopSwaggerGenericParseJSON
11321309
11331310instance FromJSON PathItem where
1134− parseJSON = genericParseJSON (jsonPrefix "pathItem")
1135− `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1311+ parseJSON = sopSwaggerGenericParseJSON
1312+
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
11361315
11371316instance FromJSON Reference where
11381317 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1149,6 +1328,7 @@ referencedParseJSON prefix js@(Object o) = do
11491328 case Text.stripPrefix prefix s of
11501329 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
11511330 Just suffix -> pure (Reference suffix)
1331+referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
11521332
11531333instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
11541334instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1157,25 +1337,91 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
11571337instance FromJSON Xml where
11581338 parseJSON = genericParseJSON (jsonPrefix "xml")
11591339
1160−instance FromJSON (SwaggerType Schema) where
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
11611341 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
11621342
1163−instance FromJSON (SwaggerType ParamOtherSchema) where
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
11641344 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
11651345
1166−instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
11671347 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
11681348
1169−instance FromJSON (CollectionFormat Param) where
1170− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1171−
1172−instance FromJSON (CollectionFormat Items) where
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
11731350 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
11741351
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")
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
1357+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1358+
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