@@ -1,10 +1,5 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
51{-# LANGUAGE DeriveGeneric #-}
62{-# LANGUAGE DeriveTraversable #-}
7−{-# LANGUAGE FlexibleContexts #-}
83{-# LANGUAGE FlexibleInstances #-}
94{-# LANGUAGE GADTs #-}
105{-# LANGUAGE GeneralizedNewtypeDeriving #-}
@@ -13,128 +8,88 @@
138{-# LANGUAGE ScopedTypeVariables #-}
149{-# LANGUAGE StandaloneDeriving #-}
1510{-# LANGUAGE TemplateHaskell #-}
16−{-# LANGUAGE TypeFamilies #-}
17−{-# LANGUAGE UndecidableInstances #-}
18−#if __GLASGOW_HASKELL__ <710
19−{-# LANGUAGE PolyKinds #-}
20−#endif
21−#include "overlapping-compat.h"
2211module Data.Swagger.Internal where
2312
24−import Prelude ()
25−import Prelude.Compat
26−
27−import Control.Lens ((&), (.~), (?~))
2813import Control.Applicative
14+import Control.Monad
2915import Data.Aeson
30−import qualified Data.Aeson.Types as JSON
31−import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32−import Data.Hashable (Hashable)
16+import Data.Aeson.TH (deriveJSON)
17+import Data.HashMap.Strict (HashMap)
3318import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
3519import Data.Map (Map)
3620import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
38−import Data.Semigroup.Compat (Semigroup (..))
21+import Data.Monoid
3922import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
23+import Data.String (fromString)
4124import Data.Text (Text)
4225import qualified Data.Text as Text
4326import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
27+import Network (HostName, PortNumber)
4528import Network.HTTP.Media (MediaType)
4629import Text.Read (readMaybe)
4730
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)
6031import Data.Swagger.Internal.Utils
6132
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−
7633-- | This is the root document object for the API specification.
7734data Swagger = Swagger
7835 { -- | Provides metadata about the API.
7936 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
37+ _info :: Info
8138
8239 -- | The host (name or ip) serving the API. It MAY include a port.
8340 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
41+ , _host :: Maybe Host
8542
8643 -- | The base path on which the API is served, which is relative to the host.
8744 -- If it is not included, the API is served directly under the host.
8845 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
46+ , _basePath :: Maybe FilePath
9047
9148 -- | The transfer protocol of the API.
9249 -- 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]
50+ , _schemes :: Maybe [Scheme]
9451
9552 -- | A list of MIME types the APIs can consume.
9653 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
54+ , _consumes :: MimeList
9855
9956 -- | 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
57+ -- This is global to all APIs but can be overridden on specific API calls.
58+ , _produces :: MimeList
10259
10360 -- | 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
61+ , _paths :: Paths
10762
10863 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
64+ , _definitions :: HashMap Text Schema
11065
11166 -- | An object to hold parameters that can be used across operations.
11267 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
68+ , _parameters :: HashMap Text Param
11469
11570 -- | An object to hold responses that can be used across operations.
11671 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
72+ , _responses :: HashMap Text Response
11873
11974 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
75+ , _securityDefinitions :: HashMap Text SecurityScheme
12176
12277 -- | A declaration of which security schemes are applied for the API as a whole.
12378 -- The list of values describes alternative security schemes that can be used
12479 -- (that is, there is a logical OR between the security requirements).
12580 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
81+ , _security :: [SecurityRequirement]
12782
12883 -- | A list of tags used by the specification with additional metadata.
12984 -- The order of the tags can be used to reflect on their order by the parsing tools.
13085 -- Not all tags that are used by the Operation Object must be declared.
13186 -- The tags that are not declared may be organized randomly or based on the tools' logic.
13287 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
88+ , _tags :: [Tag]
13489
13590 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
137− } deriving (Eq, Show, Generic, Data, Typeable)
91+ , _externalDocs :: Maybe ExternalDocs
92+ } deriving (Eq, Show, Generic)
13893
13994-- | The object provides metadata about the API.
14095-- The metadata can be used by the clients if needed,
@@ -159,7 +114,7 @@ data Info = Info
159114 -- | Provides the version of the application API
160115 -- (not to be confused with the specification version).
161116 , _infoVersion :: Text
162− } deriving (Eq, Show, Generic, Data, Typeable)
117+ } deriving (Eq, Show, Generic)
163118
164119-- | Contact information for the exposed API.
165120data Contact = Contact
@@ -171,7 +126,7 @@ data Contact = Contact
171126
172127 -- | The email address of the contact person/organization.
173128 , _contactEmail :: Maybe Text
174− } deriving (Eq, Show, Generic, Data, Typeable)
129+ } deriving (Eq, Show)
175130
176131-- | License information for the exposed API.
177132data License = License
@@ -180,32 +135,13 @@ data License = License
180135
181136 -- | A URL to the license used for the API.
182137 , _licenseUrl :: Maybe URL
183− } deriving (Eq, Show, Generic, Data, Typeable)
184−
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
138+ } deriving (Eq, Show)
187139
188140-- | The host (name or ip) serving the API. It MAY include a port.
189141data Host = Host
190142 { _hostName :: HostName -- ^ Host name.
191143 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192− } deriving (Eq, Show, Generic, Typeable)
193−
194−instance IsString Host where
195− fromString s = Host s Nothing
196−
197−hostConstr :: Constr
198−hostConstr = mkConstr hostDataType "Host" [] Prefix
199−
200−hostDataType :: DataType
201−hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
202−
203−instance Data Host where
204− gunfold k z c = case constrIndex c of
205− 1 -> k (k (z (\name mport -> Host name (fromInteger <$> mport))))
206− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Host."
207− toConstr (Host _ _) = hostConstr
208− dataTypeOf _ = hostDataType
144+ } deriving (Eq, Show)
209145
210146-- | The transfer protocol of the API.
211147data Scheme
@@ -213,7 +149,14 @@ data Scheme
213149 | Https
214150 | Ws
215151 | Wss
216− deriving (Eq, Show, Generic, Data, Typeable)
152+ deriving (Eq, Show)
153+
154+-- | The available paths and operations for the API.
155+data Paths = Paths
156+ { -- | Holds the relative paths to the individual endpoints.
157+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
158+ _pathsMap :: HashMap FilePath PathItem
159+ } deriving (Eq, Show, Generic)
217160
218161-- | Describes the operations available on a single path.
219162-- A @'PathItem'@ may be empty, due to ACL constraints.
@@ -246,13 +189,13 @@ data PathItem = PathItem
246189 -- The list MUST NOT include duplicated parameters.
247190 -- A unique parameter is defined by a combination of a name and location.
248191 , _pathItemParameters :: [Referenced Param]
249− } deriving (Eq, Show, Generic, Data, Typeable)
192+ } deriving (Eq, Show, Generic)
250193
251194-- | Describes a single API operation on a path.
252195data Operation = Operation
253196 { -- | A list of tags for API documentation control.
254197 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
198+ _operationTags :: [Text]
256199
257200 -- | A short summary of what the operation does.
258201 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -306,23 +249,10 @@ data Operation = Operation
306249 -- This definition overrides any declared top-level security.
307250 -- To remove a top-level security declaration, @Just []@ can be used.
308251 , _operationSecurity :: [SecurityRequirement]
309− } deriving (Eq, Show, Generic, Data, Typeable)
252+ } deriving (Eq, Show, Generic)
310253
311254newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
313−
314−mimeListConstr :: Constr
315−mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
316−
317−mimeListDataType :: DataType
318−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
319−
320−instance Data MimeList where
321− gunfold k z c = case constrIndex c of
322− 1 -> k (z (\xs -> MimeList (map fromString xs)))
323− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
324− toConstr (MimeList _) = mimeListConstr
325− dataTypeOf _ = mimeListDataType
255+ deriving (Eq, Show, Monoid)
326256
327257-- | Describes a single operation parameter.
328258-- A unique parameter is defined by a combination of a name and location.
@@ -342,13 +272,13 @@ data Param = Param
342272 , _paramRequired :: Maybe Bool
343273
344274 -- | Parameter schema.
345− , _paramSchema :: ParamAnySchema
346− } deriving (Eq, Show, Generic, Data, Typeable)
275+ , _paramSchema :: ParamSchema
276+ } deriving (Eq, Show, Generic)
347277
348−data ParamAnySchema
278+data ParamSchema
349279 = ParamBody (Referenced Schema)
350280 | ParamOther ParamOtherSchema
351− deriving (Eq, Show, Generic, Data, Typeable)
281+ deriving (Eq, Show)
352282
353283data ParamOtherSchema = ParamOtherSchema
354284 { -- | The location of the parameter.
@@ -360,92 +290,12 @@ data ParamOtherSchema = ParamOtherSchema
360290 -- Default value is @False@.
361291 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362292
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
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
293+ -- | Determines the format of the array if @'ParamArray'@ is used.
294+ -- Default value is csv.
295+ , _paramOtherSchemaCollectionFormat :: Maybe CollectionFormat
296+
297+ , _paramOtherSchemaCommon :: SchemaCommon (SwaggerType Param) Items
298+ } deriving (Eq, Show, Generic)
449299
450300data SwaggerType t where
451301 SwaggerString :: SwaggerType t
@@ -453,48 +303,13 @@ data SwaggerType t where
453303 SwaggerInteger :: SwaggerType t
454304 SwaggerBoolean :: SwaggerType t
455305 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
459− deriving (Typeable)
306+ SwaggerFile :: SwaggerType Param
307+ SwaggerNull :: SwaggerType Schema
308+ SwaggerObject :: SwaggerType Schema
460309
461310deriving instance Eq (SwaggerType t)
462311deriving instance Show (SwaggerType t)
463312
464−swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465−swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466−
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468−swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
469−
470−swaggerCommonTypes :: [SwaggerType k]
471−swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472−
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474−swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475−
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477−swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
478−
479−swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481− ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
482−
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484− gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485− toConstr = swaggerTypeConstr
486− dataTypeOf = swaggerTypeDataType
487−
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490− toConstr = swaggerTypeConstr
491− dataTypeOf = swaggerTypeDataType
492−
493−instance Data (SwaggerType 'SwaggerKindSchema) where
494− gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495− toConstr = swaggerTypeConstr
496− dataTypeOf = swaggerTypeDataType
497−
498313data ParamLocation
499314 = -- | Parameters that are appended to the URL.
500315 -- For example, in @/items?id=###@, the query parameter is @id@.
@@ -513,45 +328,28 @@ data ParamLocation
513328 -- Form parameters have a different format based on the content-type used
514329 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
515330 | ParamFormData
516− deriving (Eq, Show, Generic, Data, Typeable)
331+ deriving (Eq, Show)
517332
518333type Format = Text
519334
520335-- | Determines the format of the array.
521−data CollectionFormat t where
522− -- Comma separated values: @foo,bar@.
523− CollectionCSV :: CollectionFormat t
524− -- Space separated values: @foo bar@.
525− CollectionSSV :: CollectionFormat t
526− -- Tab separated values: @foo\\tbar@.
527− CollectionTSV :: CollectionFormat t
528− -- Pipe separated values: @foo|bar@.
529− CollectionPipes :: CollectionFormat t
530− -- Corresponds to multiple parameter instances
531− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532− -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
535−
536−deriving instance Eq (CollectionFormat t)
537−deriving instance Show (CollectionFormat t)
538−
539−collectionFormatConstr :: CollectionFormat t -> Constr
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
541−
542−collectionFormatDataType :: DataType
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
544− map collectionFormatConstr collectionCommonFormats
545−
546−collectionCommonFormats :: [CollectionFormat t]
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548−
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551− toConstr = collectionFormatConstr
552− dataTypeOf _ = collectionFormatDataType
553−
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
336+data CollectionFormat
337+ = CollectionCSV -- ^ Comma separated values: @foo,bar@.
338+ | CollectionSSV -- ^ Space separated values: @foo bar@.
339+ | CollectionTSV -- ^ Tab separated values: @foo\\tbar@.
340+ | CollectionPipes -- ^ Pipe separated values: @foo|bar@.
341+ | CollectionMulti -- ^ Corresponds to multiple parameter instances
342+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
343+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
344+ deriving (Eq, Show)
345+
346+-- | Determines the format of the nested array.
347+data ItemsCollectionFormat
348+ = ItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
349+ | ItemsCollectionSSV -- ^ Space separated values: @foo bar@.
350+ | ItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
351+ | ItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
352+ deriving (Eq, Show)
555353
556354type ParamName = Text
557355
@@ -560,9 +358,9 @@ data Schema = Schema
560358 , _schemaDescription :: Maybe Text
561359 , _schemaRequired :: [ParamName]
562360
563− , _schemaAllOf :: Maybe [Referenced Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
361+ , _schemaAllOf :: Maybe [Schema]
362+ , _schemaProperties :: HashMap Text (Referenced Schema)
363+ , _schemaAdditionalProperties :: Maybe Schema
566364
567365 , _schemaDiscriminator :: Maybe Text
568366 , _schemaReadOnly :: Maybe Bool
@@ -573,49 +371,42 @@ data Schema = Schema
573371 , _schemaMaxProperties :: Maybe Integer
574372 , _schemaMinProperties :: Maybe Integer
575373
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
584− } deriving (Eq, Show, Generic, Data, Typeable)
374+ , _schemaSchemaCommon :: SchemaCommon (SwaggerType Schema) SchemaItems
375+ } deriving (Eq, Show, Generic)
585376
586−-- | Regex pattern for @string@ type.
587−type Pattern = Text
377+data SchemaItems
378+ = SchemaItemsObject (Referenced Schema)
379+ | SchemaItemsArray [Referenced Schema]
380+ deriving (Eq, Show)
588381
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
382+data SchemaCommon typeDomain items = SchemaCommon
590383 { -- | Declares the value of the parameter that the server will use if none is provided,
591384 -- for example a @"count"@ to control the number of results per page might default to @100@
592385 -- if not supplied by the client in the request.
593386 -- (Note: "default" has no meaning for required parameters.)
594387 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595− _paramSchemaDefault :: Maybe Value
596−
597− , _paramSchemaType :: Maybe (SwaggerType t)
598− , _paramSchemaFormat :: Maybe Format
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
600− , _paramSchemaMaximum :: Maybe Scientific
601− , _paramSchemaExclusiveMaximum :: Maybe Bool
602− , _paramSchemaMinimum :: Maybe Scientific
603− , _paramSchemaExclusiveMinimum :: Maybe Bool
604− , _paramSchemaMaxLength :: Maybe Integer
605− , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
607− , _paramSchemaMaxItems :: Maybe Integer
608− , _paramSchemaMinItems :: Maybe Integer
609− , _paramSchemaUniqueItems :: Maybe Bool
610− , _paramSchemaEnum :: Maybe [Value]
611− , _paramSchemaMultipleOf :: Maybe Scientific
612− } deriving (Eq, Show, Generic, Typeable)
613−
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
388+ _schemaCommonDefault :: Maybe Value
389+
390+ , _schemaCommonType :: typeDomain
391+ , _schemaCommonFormat :: Maybe Format
392+ , _schemaCommonItems :: Maybe items
393+ , _schemaCommonMaximum :: Maybe Scientific
394+ , _schemaCommonExclusiveMaximum :: Maybe Bool
395+ , _schemaCommonMinimum :: Maybe Scientific
396+ , _schemaCommonExclusiveMinimum :: Maybe Bool
397+ , _schemaCommonMaxLength :: Maybe Integer
398+ , _schemaCommonMinLength :: Maybe Integer
399+ , _schemaCommonPattern :: Maybe Text
400+ , _schemaCommonMaxItems :: Maybe Integer
401+ , _schemaCommonMinItems :: Maybe Integer
402+ , _schemaCommonUniqueItems :: Maybe Bool
403+ , _schemaCommonEnum :: Maybe [Value]
404+ , _schemaCommonMultipleOf :: Maybe Scientific
405+ } deriving (Eq, Show, Generic)
615406
616407data Xml = Xml
617408 { -- | 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.
409+ -- When defined within the @'Items'@ (items), it will affect the name of the individual XML elements within the list.
619410 -- When defined alongside type being array (outside the items),
620411 -- it will affect the wrapping element and only if wrapped is true.
621412 -- If wrapped is false, it will be ignored.
@@ -639,7 +430,15 @@ data Xml = Xml
639430 -- Default value is @False@.
640431 -- The definition takes effect only when defined alongside type being array (outside the items).
641432 , _xmlWrapped :: Maybe Bool
642− } deriving (Eq, Show, Generic, Data, Typeable)
433+ } deriving (Eq, Show, Generic)
434+
435+data Items = Items
436+ { -- | Determines the format of the array if type array is used.
437+ -- Default value is @'ItemsCollectionCSV'@.
438+ _itemsCollectionFormat :: Maybe ItemsCollectionFormat
439+
440+ , _itemsCommon :: SchemaCommon (SwaggerType Items) Items
441+ } deriving (Eq, Show, Generic)
643442
644443-- | A container for the expected responses of an operation.
645444-- The container maps a HTTP response code to the expected response.
@@ -653,8 +452,8 @@ data Responses = Responses
653452
654453 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655454 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
657− } deriving (Eq, Show, Generic, Data, Typeable)
455+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
456+ } deriving (Eq, Show, Generic)
658457
659458type HttpStatusCode = Int
660459
@@ -672,14 +471,11 @@ data Response = Response
672471 , _responseSchema :: Maybe (Referenced Schema)
673472
674473 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
474+ , _responseHeaders :: HashMap HeaderName Header
676475
677476 -- | An example of the response message.
678477 , _responseExamples :: Maybe Example
679− } deriving (Eq, Show, Generic, Data, Typeable)
680−
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
478+ } deriving (Eq, Show, Generic)
683479
684480type HeaderName = Text
685481
@@ -687,30 +483,21 @@ data Header = Header
687483 { -- | A short description of the header.
688484 _headerDescription :: Maybe Text
689485
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
691− } deriving (Eq, Show, Generic, Data, Typeable)
486+ -- | Determines the format of the array if type array is used.
487+ -- Default value is @'ItemsCollectionCSV'@.
488+ , _headerCollectionFormat :: Maybe ItemsCollectionFormat
692489
693−data Example = Example { getExample :: Map MediaType Value }
694− deriving (Eq, Show, Generic, Typeable)
695−
696−exampleConstr :: Constr
697−exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
698−
699−exampleDataType :: DataType
700−exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
490+ , _headerCommon :: SchemaCommon (SwaggerType Items) Items
491+ } deriving (Eq, Show, Generic)
701492
702−instance Data Example where
703− gunfold k z c = case constrIndex c of
704− 1 -> k (z (\m -> Example (Map.mapKeys fromString m)))
705− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Example."
706− toConstr (Example _) = exampleConstr
707− dataTypeOf _ = exampleDataType
493+data Example = Example { getExample :: Map MediaType Value }
494+ deriving (Eq, Show)
708495
709496-- | The location of the API key.
710497data ApiKeyLocation
711498 = ApiKeyQuery
712499 | ApiKeyHeader
713− deriving (Eq, Show, Generic, Data, Typeable)
500+ deriving (Eq, Show)
714501
715502data ApiKeyParams = ApiKeyParams
716503 { -- | The name of the header or query parameter to be used.
@@ -718,7 +505,7 @@ data ApiKeyParams = ApiKeyParams
718505
719506 -- | The location of the API key.
720507 , _apiKeyIn :: ApiKeyLocation
721− } deriving (Eq, Show, Generic, Data, Typeable)
508+ } deriving (Eq, Show)
722509
723510-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
724511type AuthorizationURL = Text
@@ -731,21 +518,21 @@ data OAuth2Flow
731518 | OAuth2Password TokenURL
732519 | OAuth2Application TokenURL
733520 | OAuth2AccessCode AuthorizationURL TokenURL
734− deriving (Eq, Show, Generic, Data, Typeable)
521+ deriving (Eq, Show)
735522
736523data OAuth2Params = OAuth2Params
737524 { -- | The flow used by the OAuth2 security scheme.
738525 _oauth2Flow :: OAuth2Flow
739526
740527 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
742− } deriving (Eq, Show, Generic, Data, Typeable)
528+ , _oauth2Scopes :: HashMap Text Text
529+ } deriving (Eq, Show, Generic)
743530
744531data SecuritySchemeType
745532 = SecuritySchemeBasic
746533 | SecuritySchemeApiKey ApiKeyParams
747534 | SecuritySchemeOAuth2 OAuth2Params
748− deriving (Eq, Show, Generic, Data, Typeable)
535+ deriving (Eq, Show)
749536
750537data SecurityScheme = SecurityScheme
751538 { -- | The type of the security scheme.
@@ -753,39 +540,20 @@ data SecurityScheme = SecurityScheme
753540
754541 -- | A short description for security scheme.
755542 , _securitySchemeDescription :: Maybe Text
756− } deriving (Eq, Show, Generic, Data, Typeable)
757−
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)
543+ } deriving (Eq, Show, Generic)
773544
774545-- | Lists the required security schemes to execute this operation.
775546-- The object can have multiple security schemes declared in it which are all required
776547-- (that is, there is a logical AND between the schemes).
777548newtype 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
549+ { getSecurityRequirement :: HashMap Text [Text]
550+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
783551
784552-- | Allows adding meta data to a single tag that is used by @Operation@.
785553-- It is not mandatory to have a @Tag@ per tag used there.
786554data Tag = Tag
787555 { -- | The name of the tag.
788− _tagName :: TagName
556+ _tagName :: Text
789557
790558 -- | A short description for the tag.
791559 -- GFM syntax can be used for rich text representation.
@@ -793,12 +561,7 @@ data Tag = Tag
793561
794562 -- | Additional external documentation for this tag.
795563 , _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
564+ } deriving (Eq, Show)
802565
803566-- | Allows referencing an external resource for extended documentation.
804567data ExternalDocs = ExternalDocs
@@ -808,145 +571,87 @@ data ExternalDocs = ExternalDocs
808571
809572 -- | The URL for the target documentation.
810573 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812−
813−instance Hashable ExternalDocs
574+ } deriving (Eq, Show, Generic)
814575
815576-- | A simple object to allow referencing other definitions in the specification.
816577-- It can be used to reference parameters and responses that are defined at the top level for reuse.
817578newtype Reference = Reference { getReference :: Text }
818− deriving (Eq, Show, Data, Typeable)
579+ deriving (Eq, Show)
819580
820581data Referenced a
821582 = Ref Reference
822583 | Inline a
823− deriving (Eq, Show, Functor, Data, Typeable)
824−
825−instance IsString a => IsString (Referenced a) where
826− fromString = Inline . fromString
584+ deriving (Eq, Show)
827585
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)
586+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
834587
835588-- =======================================================================
836589-- Monoid instances
837590-- =======================================================================
838591
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841592instance Monoid Swagger where
842593 mempty = genericMempty
843− mappend = (<>)
594+ mappend = genericMappend
844595
845−instance Semigroup Info where
846− (<>) = genericMappend
847596instance Monoid Info where
848597 mempty = genericMempty
849− mappend = (<>)
598+ mappend = genericMappend
850599
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
600+instance Monoid Paths where
854601 mempty = genericMempty
855− mappend = (<>)
602+ mappend = genericMappend
856603
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859604instance Monoid PathItem where
860605 mempty = genericMempty
861− mappend = (<>)
606+ mappend = genericMappend
862607
863−instance Semigroup Schema where
864− (<>) = genericMappend
865608instance Monoid Schema where
866609 mempty = genericMempty
867− mappend = (<>)
610+ mappend = genericMappend
868611
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
612+instance SwaggerMonoid t => Monoid (SchemaCommon t i) where
872613 mempty = genericMempty
873− mappend = (<>)
614+ mappend = genericMappend
874615
875−instance Semigroup Param where
876− (<>) = genericMappend
877616instance Monoid Param where
878617 mempty = genericMempty
879− mappend = (<>)
618+ mappend = genericMappend
880619
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883620instance Monoid ParamOtherSchema where
884621 mempty = genericMempty
885− mappend = (<>)
886−
887−instance Semigroup Header where
888− (<>) = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
891− mappend = (<>)
622+ mappend = genericMappend
892623
893−instance Semigroup Responses where
894− (<>) = genericMappend
895624instance Monoid Responses where
896625 mempty = genericMempty
897− mappend = (<>)
626+ mappend = genericMappend
898627
899−instance Semigroup Response where
900− (<>) = genericMappend
901628instance Monoid Response where
902629 mempty = genericMempty
903− mappend = (<>)
630+ mappend = genericMappend
904631
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907632instance Monoid ExternalDocs where
908633 mempty = genericMempty
909− mappend = (<>)
634+ mappend = genericMappend
910635
911−instance Semigroup Operation where
912− (<>) = genericMappend
913636instance Monoid Operation where
914637 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 = (<>)
638+ mappend = genericMappend
933639
934640-- =======================================================================
935641-- SwaggerMonoid helper instances
936642-- =======================================================================
937643
938644instance SwaggerMonoid Info
645+instance SwaggerMonoid Paths
939646instance SwaggerMonoid PathItem
940647instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
648+instance SwaggerMonoid t => SwaggerMonoid (SchemaCommon t i)
942649instance SwaggerMonoid Param
943650instance SwaggerMonoid ParamOtherSchema
944651instance SwaggerMonoid Responses
945652instance SwaggerMonoid Response
946653instance SwaggerMonoid ExternalDocs
947654instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950655
951656instance SwaggerMonoid MimeList
952657deriving instance SwaggerMonoid URL
@@ -959,85 +664,70 @@ instance SwaggerMonoid ParamLocation where
959664 swaggerMempty = ParamQuery
960665 swaggerMappend _ y = y
961666
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
667+instance SwaggerMonoid (HashMap Text Schema) where
668+ swaggerMempty = HashMap.empty
669+ swaggerMappend = HashMap.unionWith mappend
670+
671+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
672+ swaggerMempty = HashMap.empty
673+ swaggerMappend = HashMap.unionWith swaggerMappend
965674
966675instance Monoid a => SwaggerMonoid (Referenced a) where
967676 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)
677+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
975678 swaggerMappend _ y = y
976679
977−-- =======================================================================
978−-- Simple Generic-based ToJSON instances
979−-- =======================================================================
980−
981−instance ToJSON ParamLocation where
982− toJSON = genericToJSON (jsonPrefix "Param")
680+instance SwaggerMonoid (HashMap Text Param) where
681+ swaggerMempty = HashMap.empty
682+ swaggerMappend = HashMap.unionWith mappend
983683
984−instance ToJSON Info where
985− toJSON = genericToJSON (jsonPrefix "Info")
684+instance SwaggerMonoid (HashMap Text Response) where
685+ swaggerMempty = HashMap.empty
686+ swaggerMappend = flip HashMap.union
986687
987−instance ToJSON Contact where
988− toJSON = genericToJSON (jsonPrefix "Contact")
688+instance SwaggerMonoid (HashMap Text SecurityScheme) where
689+ swaggerMempty = HashMap.empty
690+ swaggerMappend = flip HashMap.union
989691
990−instance ToJSON License where
991− toJSON = genericToJSON (jsonPrefix "License")
692+instance SwaggerMonoid (HashMap FilePath PathItem) where
693+ swaggerMempty = HashMap.empty
694+ swaggerMappend = HashMap.unionWith mappend
992695
993−instance ToJSON ApiKeyLocation where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
696+instance SwaggerMonoid (HashMap HeaderName Header) where
697+ swaggerMempty = HashMap.empty
698+ swaggerMappend = flip HashMap.union
995699
996−instance ToJSON ApiKeyParams where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
700+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
701+ swaggerMempty = HashMap.empty
702+ swaggerMappend = flip HashMap.union
998703
999−instance ToJSON Scheme where
1000− toJSON = genericToJSON (jsonPrefix "")
1001−
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")
704+instance SwaggerMonoid ParamSchema where
705+ swaggerMempty = ParamOther swaggerMempty
706+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
707+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
708+ swaggerMappend _ y = y
1010709
1011710-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
711+-- TH derived ToJSON and FromJSON instances
1013712-- =======================================================================
1014713
1015−instance FromJSON ParamLocation where
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
1017−
1018−instance FromJSON Info where
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
1020−
1021−instance FromJSON Contact where
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
1023−
1024−instance FromJSON License where
1025− parseJSON = genericParseJSON (jsonPrefix "License")
1026−
1027−instance FromJSON ApiKeyLocation where
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1029−
1030−instance FromJSON ApiKeyParams where
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
1032−
1033−instance FromJSON Scheme where
1034− parseJSON = genericParseJSON (jsonPrefix "")
1035−
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1038−
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
714+deriveJSON (jsonPrefix "Param") ''ParamLocation
715+deriveJSON' ''Info
716+deriveJSON' ''Contact
717+deriveJSON' ''License
718+deriveJSON (jsonPrefix "ItemsCollection") ''ItemsCollectionFormat
719+deriveJSON (jsonPrefix "Collection") ''CollectionFormat
720+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
721+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
722+deriveJSON' ''SchemaCommon
723+deriveJSONDefault ''Scheme
724+deriveJSON' ''Tag
725+deriveJSON' ''ExternalDocs
726+
727+deriveToJSON' ''Operation
728+deriveToJSON' ''Response
729+deriveToJSON' ''PathItem
730+deriveToJSON' ''Xml
1041731
1042732-- =======================================================================
1043733-- Manual ToJSON instances
@@ -1059,8 +749,7 @@ instance ToJSON OAuth2Flow where
1059749 , "tokenUrl" .= tokenUrl ]
1060750
1061751instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
1063− DEFINE_TOENCODING
752+ toJSON = genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1064753
1065754instance ToJSON SecuritySchemeType where
1066755 toJSON SecuritySchemeBasic
@@ -1073,38 +762,22 @@ instance ToJSON SecuritySchemeType where
1073762 <+> object [ "type" .= ("oauth2" :: Text) ]
1074763
1075764instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
1077− DEFINE_TOENCODING
765+ toJSON = addVersion . genericToJSON (jsonPrefix "")
766+ where
767+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
768+ addVersion _ = error "impossible"
1078769
1079770instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
1081− DEFINE_TOENCODING
771+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1082772
1083773instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1085− DEFINE_TOENCODING
774+ toJSON = genericToJSONWithSub "schemaCommon" (jsonPrefix "schema")
1086775
1087776instance 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 ]
777+ toJSON = genericToJSONWithSub "common" (jsonPrefix "header")
778+
779+instance ToJSON Items where
780+ toJSON = genericToJSONWithSub "common" (jsonPrefix "items")
1108781
1109782instance ToJSON Host where
1110783 toJSON (Host host mport) = toJSON $
@@ -1112,53 +785,38 @@ instance ToJSON Host where
1112785 Nothing -> host
1113786 Just port -> host ++ ":" ++ show port
1114787
788+instance ToJSON Paths where
789+ toJSON (Paths m) = toJSON m
790+
1115791instance ToJSON MimeList where
1116792 toJSON (MimeList xs) = toJSON (map show xs)
1117793
1118794instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1120− DEFINE_TOENCODING
795+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1121796
1122−instance ToJSON ParamAnySchema where
797+instance ToJSON ParamSchema where
1123798 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124799 toJSON (ParamOther s) = toJSON s
1125800
1126801instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
1128− DEFINE_TOENCODING
802+ toJSON = genericToJSONWithSub "common" (jsonPrefix "paramOtherSchema")
1129803
1130−instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1132− DEFINE_TOENCODING
1133−
1134−instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1136− DEFINE_TOENCODING
1137−
1138−instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1140− DEFINE_TOENCODING
804+instance ToJSON SchemaItems where
805+ toJSON (SchemaItemsObject x) = toJSON x
806+ toJSON (SchemaItemsArray xs) = toJSON xs
1141807
1142−instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1144− DEFINE_TOENCODING
808+instance ToJSON Responses where
809+ toJSON (Responses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1145810
1146811instance ToJSON Example where
1147812 toJSON = toJSON . Map.mapKeys show . getExample
1148813
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1151−
1152814instance ToJSON Reference where
1153815 toJSON (Reference ref) = object [ "$ref" .= ref ]
1154816
1155−referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
1156−referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
1157−referencedToJSON _ (Inline x) = toJSON x
1158−
1159−instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
1160−instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
1161−instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
817+instance ToJSON a => ToJSON (Referenced a) where
818+ toJSON (Ref ref) = toJSON ref
819+ toJSON (Inline x) = toJSON x
1162820
1163821instance ToJSON (SwaggerType t) where
1164822 toJSON SwaggerArray = "array"
@@ -1170,22 +828,6 @@ instance ToJSON (SwaggerType t) where
1170828 toJSON SwaggerNull = "null"
1171829 toJSON SwaggerObject = "object"
1172830
1173−instance ToJSON (CollectionFormat t) where
1174− toJSON CollectionCSV = "csv"
1175− toJSON CollectionSSV = "ssv"
1176− toJSON CollectionTSV = "tsv"
1177− toJSON CollectionPipes = "pipes"
1178− toJSON CollectionMulti = "multi"
1179−
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
1188−
1189831-- =======================================================================
1190832-- Manual FromJSON instances
1191833-- =======================================================================
@@ -1204,7 +846,7 @@ instance FromJSON OAuth2Flow where
1204846 parseJSON _ = empty
1205847
1206848instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
849+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1208850
1209851instance FromJSON SecuritySchemeType where
1210852 parseJSON js@(Object o) = do
@@ -1217,67 +859,55 @@ instance FromJSON SecuritySchemeType where
1217859 parseJSON _ = empty
1218860
1219861instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
862+ parseJSON js@(Object o) = do
863+ (version :: Text) <- o .: "swagger"
864+ when (version /= "2.0") empty
865+ (genericParseJSON (jsonPrefix "")
866+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
867+ , "produces" .= (mempty :: MimeList)
868+ , "security" .= ([] :: [SecurityRequirement])
869+ , "tags" .= ([] :: [Tag])
870+ , "definitions" .= (mempty :: HashMap Text Schema)
871+ , "parameters" .= (mempty :: HashMap Text Param)
872+ , "responses" .= (mempty :: HashMap Text Response)
873+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
874+ ] ) js
875+ parseJSON _ = empty
1221876
1222877instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
878+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1224879
1225880instance 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
881+ parseJSON = genericParseJSONWithSub "schemaCommon" (jsonPrefix "schema")
882+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
883+ , "required" .= ([] :: [ParamName]) ]
1233884
1234885instance 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
886+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "header")
887+
888+instance FromJSON Items where
889+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "items")
1264890
1265891instance 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 ++ "'"
892+ parseJSON (String s) =
893+ case fromInteger <$> readMaybe portStr of
894+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
895+ mport -> pure $ Host host mport
896+ where
897+ (hostText, portText) = Text.breakOn ":" s
898+ [host, portStr] = map Text.unpack [hostText, portText]
1272899 parseJSON _ = empty
1273900
901+instance FromJSON Paths where
902+ parseJSON js = Paths <$> parseJSON js
903+
1274904instance FromJSON MimeList where
1275905 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1276906
1277907instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
908+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1279909
1280−instance FromJSON ParamAnySchema where
910+instance FromJSON ParamSchema where
1281911 parseJSON js@(Object o) = do
1282912 (i :: Text) <- o .: "in"
1283913 case i of
@@ -1288,12 +918,17 @@ instance FromJSON ParamAnySchema where
1288918 parseJSON _ = empty
1289919
1290920instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
921+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "paramOtherSchema")
922+
923+instance FromJSON SchemaItems where
924+ parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
925+ parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
926+ parseJSON _ = empty
1292927
1293928instance FromJSON Responses where
1294929 parseJSON (Object o) = Responses
1295930 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
931+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1297932 parseJSON _ = empty
1298933
1299934instance FromJSON Example where
@@ -1302,126 +937,35 @@ instance FromJSON Example where
1302937 pure $ Example (Map.mapKeys fromString m)
1303938
1304939instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
940+ parseJSON = genericParseJSON (jsonPrefix "response")
941+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1306942
1307943instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
944+ parseJSON = genericParseJSON (jsonPrefix "operation")
945+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1309946
1310947instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1312−
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
948+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
949+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1315950
1316951instance FromJSON Reference where
1317952 parseJSON (Object o) = Reference <$> o .: "$ref"
1318953 parseJSON _ = empty
1319954
1320−referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
1321−referencedParseJSON prefix js@(Object o) = do
1322− ms <- o .:? "$ref"
1323− case ms of
1324− Nothing -> Inline <$> parseJSON js
1325− Just s -> Ref <$> parseRef s
1326− where
1327− parseRef s = do
1328− case Text.stripPrefix prefix s of
1329− Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1330− Just suffix -> pure (Reference suffix)
1331−referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
1332−
1333−instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1334−instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
1335−instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#/responses/"
955+instance FromJSON a => FromJSON (Referenced a) where
956+ parseJSON js
957+ = Ref <$> parseJSON js
958+ <|> Inline <$> parseJSON js
1336959
1337960instance FromJSON Xml where
1338961 parseJSON = genericParseJSON (jsonPrefix "xml")
1339962
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
963+instance FromJSON (SwaggerType Schema) where
1341964 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1342965
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
966+instance FromJSON (SwaggerType Param) where
1344967 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1345968
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
969+instance FromJSON (SwaggerType Items) where
1347970 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1348971
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
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