@@ -1,7 +1,4 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
31{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
52{-# LANGUAGE DeriveGeneric #-}
63{-# LANGUAGE DeriveTraversable #-}
74{-# LANGUAGE FlexibleContexts #-}
@@ -13,127 +10,89 @@
1310{-# LANGUAGE ScopedTypeVariables #-}
1411{-# LANGUAGE StandaloneDeriving #-}
1512{-# LANGUAGE TemplateHaskell #-}
16−{-# LANGUAGE TypeFamilies #-}
17−{-# LANGUAGE UndecidableInstances #-}
18−#if __GLASGOW_HASKELL__ <710
19−{-# LANGUAGE PolyKinds #-}
20−#endif
21−#include "overlapping-compat.h"
2213module Data.Swagger.Internal where
2314
24−import Prelude ()
25−import Prelude.Compat
26−
27−import Control.Lens ((&), (.~), (?~))
2815import Control.Applicative
16+import Control.Monad
2917import Data.Aeson
18+import Data.Aeson.TH (deriveJSON)
3019import qualified Data.Aeson.Types as JSON
3120import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32−import Data.Hashable (Hashable)
21+import Data.HashMap.Strict (HashMap)
3322import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
3523import Data.Map (Map)
3624import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
38−import Data.Semigroup.Compat (Semigroup (..))
25+import Data.Monoid
3926import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
27+import Data.String (fromString)
4128import Data.Text (Text)
4229import qualified Data.Text as Text
4330import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
31+import Network (HostName, PortNumber)
4532import Network.HTTP.Media (MediaType)
4633import Text.Read (readMaybe)
4734
48−import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49−import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50−
51−import Generics.SOP.TH (deriveGeneric)
52−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53− ,sopSwaggerGenericToJSONWithOpts
54− ,sopSwaggerGenericParseJSON
55− ,HasSwaggerAesonOptions(..)
56− ,AesonDefaultValue(..)
57− ,mkSwaggerAesonOptions
58− ,saoAdditionalPairs
59− ,saoSubObject)
6035import Data.Swagger.Internal.Utils
6136
62−#if MIN_VERSION_aeson(0,10,0)
63−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64−#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
65−#else
66−#define DEFINE_TOENCODING
67−#endif
68−
69−-- $setup
70−-- >>> :seti -XDataKinds
71−-- >>> import Data.Aeson
72−
73−-- | A list of definitions that can be used in references.
74−type Definitions = InsOrdHashMap Text
75−
7637-- | This is the root document object for the API specification.
7738data Swagger = Swagger
7839 { -- | Provides metadata about the API.
7940 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
41+ _info :: Info
8142
8243 -- | The host (name or ip) serving the API. It MAY include a port.
8344 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
45+ , _host :: Maybe Host
8546
8647 -- | The base path on which the API is served, which is relative to the host.
8748 -- If it is not included, the API is served directly under the host.
8849 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
50+ , _basePath :: Maybe FilePath
9051
9152 -- | The transfer protocol of the API.
9253 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
93− , _swaggerSchemes :: Maybe [Scheme]
54+ , _schemes :: Maybe [Scheme]
9455
9556 -- | A list of MIME types the APIs can consume.
9657 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
58+ , _consumes :: MimeList
9859
9960 -- | A list of MIME types the APIs can produce.
100− -- This is global to all APIs but can be overridden on specific API calls.
101− , _swaggerProduces :: MimeList
61+ -- This is global to all APIs but can be overridden on specific API calls.
62+ , _produces :: MimeList
10263
10364 -- | The available paths and operations for the API.
104− -- Holds the relative paths to the individual endpoints.
105− -- The path is appended to the @'basePath'@ in order to construct the full URL.
106− , _swaggerPaths :: InsOrdHashMap FilePath PathItem
65+ , _paths :: Paths
10766
10867 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
68+ , _definitions :: HashMap Text Schema
11069
11170 -- | An object to hold parameters that can be used across operations.
11271 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
72+ , _parameters :: HashMap Text Param
11473
11574 -- | An object to hold responses that can be used across operations.
11675 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
76+ , _responses :: HashMap Text Response
11877
11978 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
79+ , _securityDefinitions :: HashMap Text SecurityScheme
12180
12281 -- | A declaration of which security schemes are applied for the API as a whole.
12382 -- The list of values describes alternative security schemes that can be used
12483 -- (that is, there is a logical OR between the security requirements).
12584 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
85+ , _security :: [SecurityRequirement]
12786
12887 -- | A list of tags used by the specification with additional metadata.
12988 -- The order of the tags can be used to reflect on their order by the parsing tools.
13089 -- Not all tags that are used by the Operation Object must be declared.
13190 -- The tags that are not declared may be organized randomly or based on the tools' logic.
13291 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
92+ , _tags :: [Tag]
13493
13594 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
95+ , _externalDocs :: Maybe ExternalDocs
13796 } deriving (Eq, Show, Generic, Data, Typeable)
13897
13998-- | The object provides metadata about the API.
@@ -182,18 +141,12 @@ data License = License
182141 , _licenseUrl :: Maybe URL
183142 } deriving (Eq, Show, Generic, Data, Typeable)
184143
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
187−
188144-- | The host (name or ip) serving the API. It MAY include a port.
189145data Host = Host
190146 { _hostName :: HostName -- ^ Host name.
191147 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192148 } deriving (Eq, Show, Generic, Typeable)
193149
194−instance IsString Host where
195− fromString s = Host s Nothing
196−
197150hostConstr :: Constr
198151hostConstr = mkConstr hostDataType "Host" [] Prefix
199152
@@ -215,6 +168,13 @@ data Scheme
215168 | Wss
216169 deriving (Eq, Show, Generic, Data, Typeable)
217170
171+-- | The available paths and operations for the API.
172+data Paths = Paths
173+ { -- | Holds the relative paths to the individual endpoints.
174+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
175+ _pathsMap :: HashMap FilePath PathItem
176+ } deriving (Eq, Show, Generic, Data, Typeable)
177+
218178-- | Describes the operations available on a single path.
219179-- A @'PathItem'@ may be empty, due to ACL constraints.
220180-- The path itself is still exposed to the documentation viewer
@@ -252,7 +212,7 @@ data PathItem = PathItem
252212data Operation = Operation
253213 { -- | A list of tags for API documentation control.
254214 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
215+ _operationTags :: [Text]
256216
257217 -- | A short summary of what the operation does.
258218 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -309,7 +269,7 @@ data Operation = Operation
309269 } deriving (Eq, Show, Generic, Data, Typeable)
310270
311271newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
272+ deriving (Eq, Show, Monoid, Typeable)
313273
314274mimeListConstr :: Constr
315275mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -360,92 +320,12 @@ data ParamOtherSchema = ParamOtherSchema
360320 -- Default value is @False@.
361321 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362322
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
364− } deriving (Eq, Show, Generic, Typeable, Data)
365−
366−-- | Items for @'SwaggerArray'@ schemas.
367−--
368−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
369−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
370−-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
371−-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
372−--
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
374−--
375−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
376−data SwaggerItems t where
377− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
378− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
379− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
380− deriving (Typeable)
381−
382−deriving instance Eq (SwaggerItems t)
383−deriving instance Show (SwaggerItems t)
384−--deriving instance Typeable (SwaggerItems t)
385−
386−swaggerItemsPrimitiveConstr :: Constr
387−swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388−
389−swaggerItemsObjectConstr :: Constr
390−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391−
392−swaggerItemsArrayConstr :: Constr
393−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394−
395−swaggerItemsDataType :: DataType
396−swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397−
398−-- Note: unfortunately we have to write these Data instances by hand,
399−-- to get better contexts / avoid duplicate name when using standalone deriving
400−
401−instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
402− -- TODO: define gfoldl
403− gunfold k z c = case constrIndex c of
404− 1 -> k (k (z SwaggerItemsPrimitive))
405− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406− toConstr _ = swaggerItemsPrimitiveConstr
407− dataTypeOf _ = swaggerItemsDataType
408−
409−-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
410−instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411− -- TODO: define gfoldl
412− gunfold k z c = case constrIndex c of
413− 1 -> k (k (z SwaggerItemsPrimitive))
414− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415− toConstr _ = swaggerItemsPrimitiveConstr
416− dataTypeOf _ = swaggerItemsDataType
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
323+ -- | Determines the format of the array if @'ParamArray'@ is used.
324+ -- Default value is csv.
325+ , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
433326
434−-- | Type used as a kind to avoid overlapping instances.
435−data SwaggerKind t
436− = SwaggerKindNormal t
437− | SwaggerKindParamOtherSchema
438− | SwaggerKindSchema
439− deriving (Typeable)
440−
441−deriving instance Typeable 'SwaggerKindNormal
442−deriving instance Typeable 'SwaggerKindParamOtherSchema
443−deriving instance Typeable 'SwaggerKindSchema
444−
445−type family SwaggerKindType (k :: SwaggerKind *) :: *
446−type instance SwaggerKindType ('SwaggerKindNormal t) = t
447−type instance SwaggerKindType 'SwaggerKindSchema = Schema
448−type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
327+ , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema Items
328+ } deriving (Eq, Show, Generic, Data, Typeable)
449329
450330data SwaggerType t where
451331 SwaggerString :: SwaggerType t
@@ -453,47 +333,49 @@ data SwaggerType t where
453333 SwaggerInteger :: SwaggerType t
454334 SwaggerBoolean :: SwaggerType t
455335 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
459− deriving (Typeable)
336+ SwaggerFile :: SwaggerType ParamOtherSchema
337+ SwaggerNull :: SwaggerType Schema
338+ SwaggerObject :: SwaggerType Schema
460339
461340deriving instance Eq (SwaggerType t)
462341deriving instance Show (SwaggerType t)
342+deriving instance Typeable (SwaggerType t)
463343
464344swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465345swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466346
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468−swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
347+swaggerTypeDataType :: Data (SwaggerType t) => [SwaggerType t] -> SwaggerType t -> DataType
348+swaggerTypeDataType cons _ = mkDataType "Data.Swagger.SwaggerType" $ map swaggerTypeConstr cons
469349
470−swaggerCommonTypes :: [SwaggerType k]
350+swaggerCommonTypes :: [SwaggerType t]
471351swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472352
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
353+swaggerParamTypes :: [SwaggerType ParamOtherSchema]
474354swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475355
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477−swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
356+swaggerSchemaTypes :: [SwaggerType Schema]
357+swaggerSchemaTypes = swaggerCommonTypes ++ [SwaggerNull, SwaggerObject]
478358
479−swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481− ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
359+instance Data (SwaggerType Items) where
360+ gunfold = gunfoldEnum "SwaggerType Items" $ zip [1..] swaggerCommonTypes
361+ toConstr = swaggerTypeConstr
362+ dataTypeOf = swaggerTypeDataType swaggerCommonTypes
482363
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484− gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
364+instance Data (SwaggerType Header) where
365+ gunfold = gunfoldEnum "SwaggerType Header" $ zip [1..] swaggerCommonTypes
485366 toConstr = swaggerTypeConstr
486− dataTypeOf = swaggerTypeDataType
367+ dataTypeOf = swaggerTypeDataType swaggerCommonTypes
487368
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
369+instance Data (SwaggerType ParamOtherSchema) where
370+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" $ zip [1..] swaggerParamTypes
490371 toConstr = swaggerTypeConstr
491− dataTypeOf = swaggerTypeDataType
372+ dataTypeOf = swaggerTypeDataType swaggerParamTypes
492373
493−instance Data (SwaggerType 'SwaggerKindSchema) where
494− gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
374+instance Data (SwaggerType Schema) where
375+ gunfold = gunfoldEnum "SwaggerType Schema" $ zip ns swaggerSchemaTypes
376+ where ns = [1, 2, 3, 4, 5, 7, 8] -- skipping constructor #6 here
495377 toConstr = swaggerTypeConstr
496− dataTypeOf = swaggerTypeDataType
378+ dataTypeOf = swaggerTypeDataType swaggerSchemaTypes
497379
498380data ParamLocation
499381 = -- | Parameters that are appended to the URL.
@@ -530,11 +412,11 @@ data CollectionFormat t where
530412 -- Corresponds to multiple parameter instances
531413 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532414 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
415+ CollectionMulti :: CollectionFormat Param
535416
536417deriving instance Eq (CollectionFormat t)
537418deriving instance Show (CollectionFormat t)
419+deriving instance Typeable (CollectionFormat t)
538420
539421collectionFormatConstr :: CollectionFormat t -> Constr
540422collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
@@ -546,12 +428,12 @@ collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
546428collectionCommonFormats :: [CollectionFormat t]
547429collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548430
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
431+instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
432+ gunfold = gunfoldEnum "CollectionFormat" $ zip [1..] collectionCommonFormats
551433 toConstr = collectionFormatConstr
552434 dataTypeOf _ = collectionFormatDataType
553435
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
436+deriving instance {-# OVERLAPPING #-} Data (CollectionFormat Param)
555437
556438type ParamName = Text
557439
@@ -560,9 +442,9 @@ data Schema = Schema
560442 , _schemaDescription :: Maybe Text
561443 , _schemaRequired :: [ParamName]
562444
563− , _schemaAllOf :: Maybe [Referenced Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
445+ , _schemaAllOf :: Maybe [Schema]
446+ , _schemaProperties :: HashMap Text (Referenced Schema)
447+ , _schemaAdditionalProperties :: Maybe Schema
566448
567449 , _schemaDiscriminator :: Maybe Text
568450 , _schemaReadOnly :: Maybe Bool
@@ -573,20 +455,15 @@ data Schema = Schema
573455 , _schemaMaxProperties :: Maybe Integer
574456 , _schemaMinProperties :: Maybe Integer
575457
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
458+ , _schemaParamSchema :: ParamSchema Schema SchemaItems
584459 } deriving (Eq, Show, Generic, Data, Typeable)
585460
586−-- | Regex pattern for @string@ type.
587−type Pattern = Text
461+data SchemaItems
462+ = SchemaItemsObject (Referenced Schema)
463+ | SchemaItemsArray [Referenced Schema]
464+ deriving (Eq, Show, Generic, Data, Typeable)
588465
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
466+data ParamSchema t items = ParamSchema
590467 { -- | Declares the value of the parameter that the server will use if none is provided,
591468 -- for example a @"count"@ to control the number of results per page might default to @100@
592469 -- if not supplied by the client in the request.
@@ -594,16 +471,16 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
594471 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595472 _paramSchemaDefault :: Maybe Value
596473
597− , _paramSchemaType :: Maybe (SwaggerType t)
474+ , _paramSchemaType :: SwaggerType t
598475 , _paramSchemaFormat :: Maybe Format
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
476+ , _paramSchemaItems :: Maybe items
600477 , _paramSchemaMaximum :: Maybe Scientific
601478 , _paramSchemaExclusiveMaximum :: Maybe Bool
602479 , _paramSchemaMinimum :: Maybe Scientific
603480 , _paramSchemaExclusiveMinimum :: Maybe Bool
604481 , _paramSchemaMaxLength :: Maybe Integer
605482 , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
483+ , _paramSchemaPattern :: Maybe Text
607484 , _paramSchemaMaxItems :: Maybe Integer
608485 , _paramSchemaMinItems :: Maybe Integer
609486 , _paramSchemaUniqueItems :: Maybe Bool
@@ -611,11 +488,11 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
611488 , _paramSchemaMultipleOf :: Maybe Scientific
612489 } deriving (Eq, Show, Generic, Typeable)
613490
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
491+deriving instance (Data t, Data (SwaggerType t), Data i) => Data (ParamSchema t i)
615492
616493data Xml = Xml
617494 { -- | 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.
495+ -- When defined within the @'Items'@ (items), it will affect the name of the individual XML elements within the list.
619496 -- When defined alongside type being array (outside the items),
620497 -- it will affect the wrapping element and only if wrapped is true.
621498 -- If wrapped is false, it will be ignored.
@@ -641,6 +518,14 @@ data Xml = Xml
641518 , _xmlWrapped :: Maybe Bool
642519 } deriving (Eq, Show, Generic, Data, Typeable)
643520
521+data Items = Items
522+ { -- | Determines the format of the array if type array is used.
523+ -- Default value is @'ItemsCollectionCSV'@.
524+ _itemsCollectionFormat :: Maybe (CollectionFormat Items)
525+
526+ , _itemsParamSchema :: ParamSchema Items Items
527+ } deriving (Eq, Show, Generic, Data, Typeable)
528+
644529-- | A container for the expected responses of an operation.
645530-- The container maps a HTTP response code to the expected response.
646531-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
@@ -653,7 +538,7 @@ data Responses = Responses
653538
654539 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655540 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
541+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657542 } deriving (Eq, Show, Generic, Data, Typeable)
658543
659544type HttpStatusCode = Int
@@ -672,22 +557,23 @@ data Response = Response
672557 , _responseSchema :: Maybe (Referenced Schema)
673558
674559 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
560+ , _responseHeaders :: HashMap HeaderName Header
676561
677562 -- | An example of the response message.
678563 , _responseExamples :: Maybe Example
679564 } deriving (Eq, Show, Generic, Data, Typeable)
680565
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
683−
684566type HeaderName = Text
685567
686568data Header = Header
687569 { -- | A short description of the header.
688570 _headerDescription :: Maybe Text
689571
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
572+ -- | Determines the format of the array if type array is used.
573+ -- Default value is @'ItemsCollectionCSV'@.
574+ , _headerCollectionFormat :: Maybe (CollectionFormat Items)
575+
576+ , _headerParamSchema :: ParamSchema Header Items
691577 } deriving (Eq, Show, Generic, Data, Typeable)
692578
693579data Example = Example { getExample :: Map MediaType Value }
@@ -738,7 +624,7 @@ data OAuth2Params = OAuth2Params
738624 _oauth2Flow :: OAuth2Flow
739625
740626 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
627+ , _oauth2Scopes :: HashMap Text Text
742628 } deriving (Eq, Show, Generic, Data, Typeable)
743629
744630data SecuritySchemeType
@@ -755,37 +641,18 @@ data SecurityScheme = SecurityScheme
755641 , _securitySchemeDescription :: Maybe Text
756642 } deriving (Eq, Show, Generic, Data, Typeable)
757643
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−
774644-- | Lists the required security schemes to execute this operation.
775645-- The object can have multiple security schemes declared in it which are all required
776646-- (that is, there is a logical AND between the schemes).
777647newtype 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
648+ { getSecurityRequirement :: HashMap Text [Text]
649+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
783650
784651-- | Allows adding meta data to a single tag that is used by @Operation@.
785652-- It is not mandatory to have a @Tag@ per tag used there.
786653data Tag = Tag
787654 { -- | The name of the tag.
788− _tagName :: TagName
655+ _tagName :: Text
789656
790657 -- | A short description for the tag.
791658 -- GFM syntax can be used for rich text representation.
@@ -793,12 +660,7 @@ data Tag = Tag
793660
794661 -- | Additional external documentation for this tag.
795662 , _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
663+ } deriving (Eq, Show, Generic, Data, Typeable)
802664
803665-- | Allows referencing an external resource for extended documentation.
804666data ExternalDocs = ExternalDocs
@@ -808,9 +670,7 @@ data ExternalDocs = ExternalDocs
808670
809671 -- | The URL for the target documentation.
810672 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812−
813−instance Hashable ExternalDocs
673+ } deriving (Eq, Show, Generic, Data, Typeable)
814674
815675-- | A simple object to allow referencing other definitions in the specification.
816676-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -820,133 +680,77 @@ newtype Reference = Reference { getReference :: Text }
820680data Referenced a
821681 = Ref Reference
822682 | 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)
833683 deriving (Eq, Show, Data, Typeable)
834684
685+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
686+
835687-- =======================================================================
836688-- Monoid instances
837689-- =======================================================================
838690
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841691instance Monoid Swagger where
842692 mempty = genericMempty
843− mappend = (<>)
693+ mappend = genericMappend
844694
845−instance Semigroup Info where
846− (<>) = genericMappend
847695instance Monoid Info where
848696 mempty = genericMempty
849− mappend = (<>)
697+ mappend = genericMappend
850698
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
699+instance Monoid Paths where
854700 mempty = genericMempty
855− mappend = (<>)
701+ mappend = genericMappend
856702
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859703instance Monoid PathItem where
860704 mempty = genericMempty
861− mappend = (<>)
705+ mappend = genericMappend
862706
863−instance Semigroup Schema where
864− (<>) = genericMappend
865707instance Monoid Schema where
866708 mempty = genericMempty
867− mappend = (<>)
709+ mappend = genericMappend
868710
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
711+instance Monoid (ParamSchema t i) where
872712 mempty = genericMempty
873− mappend = (<>)
713+ mappend = genericMappend
874714
875−instance Semigroup Param where
876− (<>) = genericMappend
877715instance Monoid Param where
878716 mempty = genericMempty
879− mappend = (<>)
717+ mappend = genericMappend
880718
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883719instance Monoid ParamOtherSchema where
884720 mempty = genericMempty
885− mappend = (<>)
721+ mappend = genericMappend
886722
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
895723instance Monoid Responses where
896724 mempty = genericMempty
897− mappend = (<>)
725+ mappend = genericMappend
898726
899−instance Semigroup Response where
900− (<>) = genericMappend
901727instance Monoid Response where
902728 mempty = genericMempty
903− mappend = (<>)
729+ mappend = genericMappend
904730
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907731instance Monoid ExternalDocs where
908732 mempty = genericMempty
909− mappend = (<>)
733+ mappend = genericMappend
910734
911−instance Semigroup Operation where
912− (<>) = genericMappend
913735instance Monoid Operation where
914736 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 = (<>)
737+ mappend = genericMappend
933738
934739-- =======================================================================
935740-- SwaggerMonoid helper instances
936741-- =======================================================================
937742
938743instance SwaggerMonoid Info
744+instance SwaggerMonoid Paths
939745instance SwaggerMonoid PathItem
940746instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
747+instance SwaggerMonoid (ParamSchema t i)
942748instance SwaggerMonoid Param
943749instance SwaggerMonoid ParamOtherSchema
944750instance SwaggerMonoid Responses
945751instance SwaggerMonoid Response
946752instance SwaggerMonoid ExternalDocs
947753instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950754
951755instance SwaggerMonoid MimeList
952756deriving instance SwaggerMonoid URL
@@ -959,85 +763,64 @@ instance SwaggerMonoid ParamLocation where
959763 swaggerMempty = ParamQuery
960764 swaggerMappend _ y = y
961765
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
766+instance SwaggerMonoid (HashMap Text Schema) where
767+ swaggerMempty = HashMap.empty
768+ swaggerMappend = HashMap.unionWith mappend
769+
770+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
771+ swaggerMempty = HashMap.empty
772+ swaggerMappend = HashMap.unionWith swaggerMappend
965773
966774instance Monoid a => SwaggerMonoid (Referenced a) where
967775 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
969− swaggerMappend _ y = y
970−
971−instance SwaggerMonoid ParamAnySchema where
972− swaggerMempty = ParamOther swaggerMempty
973− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
776+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
975777 swaggerMappend _ y = y
976778
977−-- =======================================================================
978−-- Simple Generic-based ToJSON instances
979−-- =======================================================================
980−
981−instance ToJSON ParamLocation where
982− toJSON = genericToJSON (jsonPrefix "Param")
983−
984−instance ToJSON Info where
985− toJSON = genericToJSON (jsonPrefix "Info")
779+instance SwaggerMonoid (HashMap Text Param) where
780+ swaggerMempty = HashMap.empty
781+ swaggerMappend = HashMap.unionWith mappend
986782
987−instance ToJSON Contact where
988− toJSON = genericToJSON (jsonPrefix "Contact")
783+instance SwaggerMonoid (HashMap Text Response) where
784+ swaggerMempty = HashMap.empty
785+ swaggerMappend = flip HashMap.union
989786
990−instance ToJSON License where
991− toJSON = genericToJSON (jsonPrefix "License")
787+instance SwaggerMonoid (HashMap Text SecurityScheme) where
788+ swaggerMempty = HashMap.empty
789+ swaggerMappend = flip HashMap.union
992790
993−instance ToJSON ApiKeyLocation where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
791+instance SwaggerMonoid (HashMap FilePath PathItem) where
792+ swaggerMempty = HashMap.empty
793+ swaggerMappend = HashMap.unionWith mappend
995794
996−instance ToJSON ApiKeyParams where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
795+instance SwaggerMonoid (HashMap HeaderName Header) where
796+ swaggerMempty = HashMap.empty
797+ swaggerMappend = flip HashMap.union
998798
999−instance ToJSON Scheme where
1000− toJSON = genericToJSON (jsonPrefix "")
799+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
800+ swaggerMempty = HashMap.empty
801+ swaggerMappend = flip HashMap.union
1001802
1002−instance ToJSON Tag where
1003− toJSON = genericToJSON (jsonPrefix "Tag")
1004−
1005−instance ToJSON ExternalDocs where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1007−
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
803+instance SwaggerMonoid ParamAnySchema where
804+ swaggerMempty = ParamOther swaggerMempty
805+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
806+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
807+ swaggerMappend _ y = y
1010808
1011809-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
810+-- TH derived ToJSON and FromJSON instances
1013811-- =======================================================================
1014812
1015−instance FromJSON ParamLocation where
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
1017−
1018−instance FromJSON Info where
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
1020−
1021−instance FromJSON Contact where
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
813+deriveJSON (jsonPrefix "Param") ''ParamLocation
814+deriveJSON' ''Info
815+deriveJSON' ''Contact
816+deriveJSON' ''License
817+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
818+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
819+deriveJSONDefault ''Scheme
820+deriveJSON' ''Tag
821+deriveJSON' ''ExternalDocs
1023822
1024−instance FromJSON License where
1025− parseJSON = genericParseJSON (jsonPrefix "License")
1026−
1027−instance FromJSON ApiKeyLocation where
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1029−
1030−instance FromJSON ApiKeyParams where
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
1032−
1033−instance FromJSON Scheme where
1034− parseJSON = genericParseJSON (jsonPrefix "")
1035−
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1038−
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
823+deriveToJSON' ''Xml
1041824
1042825-- =======================================================================
1043826-- Manual ToJSON instances
@@ -1059,8 +842,7 @@ instance ToJSON OAuth2Flow where
1059842 , "tokenUrl" .= tokenUrl ]
1060843
1061844instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
1063− DEFINE_TOENCODING
845+ toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1064846
1065847instance ToJSON SecuritySchemeType where
1066848 toJSON SecuritySchemeBasic
@@ -1073,38 +855,22 @@ instance ToJSON SecuritySchemeType where
1073855 <+> object [ "type" .= ("oauth2" :: Text) ]
1074856
1075857instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
1077− DEFINE_TOENCODING
858+ toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "")
859+ where
860+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
861+ addVersion _ = error "impossible"
1078862
1079863instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
1081− DEFINE_TOENCODING
864+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1082865
1083866instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1085− DEFINE_TOENCODING
867+ toJSON = omitEmpties . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1086868
1087869instance 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 ]
870+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
871+
872+instance ToJSON Items where
873+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
1108874
1109875instance ToJSON Host where
1110876 toJSON (Host host mport) = toJSON $
@@ -1112,43 +878,42 @@ instance ToJSON Host where
1112878 Nothing -> host
1113879 Just port -> host ++ ":" ++ show port
1114880
881+instance ToJSON Paths where
882+ toJSON (Paths m) = toJSON m
883+
1115884instance ToJSON MimeList where
1116885 toJSON (MimeList xs) = toJSON (map show xs)
1117886
1118887instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1120− DEFINE_TOENCODING
888+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1121889
1122890instance ToJSON ParamAnySchema where
1123891 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124892 toJSON (ParamOther s) = toJSON s
1125893
1126894instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
1128− DEFINE_TOENCODING
895+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
896+
897+instance ToJSON SchemaItems where
898+ toJSON (SchemaItemsObject x) = toJSON x
899+ toJSON (SchemaItemsArray xs) = toJSON xs
1129900
1130901instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1132− DEFINE_TOENCODING
902+ toJSON (Responses def rs) = omitEmpties $
903+ toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1133904
1134905instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1136− DEFINE_TOENCODING
906+ toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1137907
1138908instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1140− DEFINE_TOENCODING
909+ toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1141910
1142911instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1144− DEFINE_TOENCODING
912+ toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1145913
1146914instance ToJSON Example where
1147915 toJSON = toJSON . Map.mapKeys show . getExample
1148916
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1151−
1152917instance ToJSON Reference where
1153918 toJSON (Reference ref) = object [ "$ref" .= ref ]
1154919
@@ -1177,14 +942,8 @@ instance ToJSON (CollectionFormat t) where
1177942 toJSON CollectionPipes = "pipes"
1178943 toJSON CollectionMulti = "multi"
1179944
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
945+instance ToJSON i => ToJSON (ParamSchema t i) where
946+ toJSON = genericToJSON (jsonPrefix "paramSchema")
1188947
1189948-- =======================================================================
1190949-- Manual FromJSON instances
@@ -1204,7 +963,7 @@ instance FromJSON OAuth2Flow where
1204963 parseJSON _ = empty
1205964
1206965instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
966+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1208967
1209968instance FromJSON SecuritySchemeType where
1210969 parseJSON js@(Object o) = do
@@ -1217,65 +976,53 @@ instance FromJSON SecuritySchemeType where
1217976 parseJSON _ = empty
1218977
1219978instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
979+ parseJSON js@(Object o) = do
980+ (version :: Text) <- o .: "swagger"
981+ when (version /= "2.0") empty
982+ (genericParseJSON (jsonPrefix "")
983+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
984+ , "produces" .= (mempty :: MimeList)
985+ , "security" .= ([] :: [SecurityRequirement])
986+ , "tags" .= ([] :: [Tag])
987+ , "definitions" .= (mempty :: HashMap Text Schema)
988+ , "parameters" .= (mempty :: HashMap Text Param)
989+ , "responses" .= (mempty :: HashMap Text Response)
990+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
991+ ] ) js
992+ parseJSON _ = empty
1221993
1222994instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
995+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1224996
1225997instance 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
998+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
999+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1000+ , "required" .= ([] :: [ParamName]) ]
12331001
12341002instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
1236−
1237−instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1238− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1239− <$> o .:? "collectionFormat"
1240− <*> (o .: "items" >>= parseJSON)
1241−
1242−instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1243− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244− <$> o .:? "collectionFormat"
1245− <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1246−
1247−-- |
1248−--
1249−-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250−-- Just (SwaggerItemsArray [])
1251−--
1252−-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253−-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1254−--
1255−-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256−-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1257−--
1258−instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1259− parseJSON js@(Object obj)
1260− | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1261− | otherwise = SwaggerItemsObject <$> parseJSON js
1262− parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1263− parseJSON _ = empty
1003+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
1004+
1005+instance FromJSON Items where
1006+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
12641007
12651008instance 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 ++ "'"
1009+ parseJSON (String s) =
1010+ case fromInteger <$> readMaybe portStr of
1011+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1012+ mport -> pure $ Host host mport
1013+ where
1014+ (hostText, portText) = Text.breakOn ":" s
1015+ [host, portStr] = map Text.unpack [hostText, portText]
12721016 parseJSON _ = empty
12731017
1018+instance FromJSON Paths where
1019+ parseJSON js = Paths <$> parseJSON js
1020+
12741021instance FromJSON MimeList where
12751022 parseJSON js = (MimeList . map fromString) <$> parseJSON js
12761023
12771024instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
1025+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
12791026
12801027instance FromJSON ParamAnySchema where
12811028 parseJSON js@(Object o) = do
@@ -1288,12 +1035,17 @@ instance FromJSON ParamAnySchema where
12881035 parseJSON _ = empty
12891036
12901037instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
1038+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1039+
1040+instance FromJSON SchemaItems where
1041+ parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
1042+ parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
1043+ parseJSON _ = empty
12921044
12931045instance FromJSON Responses where
12941046 parseJSON (Object o) = Responses
12951047 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1048+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
12971049 parseJSON _ = empty
12981050
12991051instance FromJSON Example where
@@ -1302,16 +1054,16 @@ instance FromJSON Example where
13021054 pure $ Example (Map.mapKeys fromString m)
13031055
13041056instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1057+ parseJSON = genericParseJSON (jsonPrefix "response")
1058+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
13061059
13071060instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1061+ parseJSON = genericParseJSON (jsonPrefix "operation")
1062+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
13091063
13101064instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1312−
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1065+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1066+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
13151067
13161068instance FromJSON Reference where
13171069 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1328,7 +1080,6 @@ referencedParseJSON prefix js@(Object o) = do
13281080 case Text.stripPrefix prefix s of
13291081 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
13301082 Just suffix -> pure (Reference suffix)
1331−referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
13321083
13331084instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
13341085instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1337,91 +1088,23 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
13371088instance FromJSON Xml where
13381089 parseJSON = genericParseJSON (jsonPrefix "xml")
13391090
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1091+instance FromJSON (SwaggerType Schema) where
13411092 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
13421093
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1094+instance FromJSON (SwaggerType ParamOtherSchema) where
13441095 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
13451096
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1097+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
13471098 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
13481099
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
1100+instance FromJSON (CollectionFormat Param) where
13571101 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
13581102
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
1103+instance FromJSON (CollectionFormat Items) where
1104+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1105+
1106+-- NOTE: The constraint @FromJSON (SwaggerType t)@ is necessary here!
1107+-- Without the constraint the general instance will be used
1108+-- that only accepts common types (i.e. NOT object, null or file).
1109+instance (FromJSON (SwaggerType t), FromJSON i) => FromJSON (ParamSchema t i) where
1110+ parseJSON = genericParseJSON (jsonPrefix "ParamSchema")