@@ -1,7 +1,3 @@
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
5{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
6{-# LANGUAGE DeriveTraversable #-}
2{-# LANGUAGE DeriveTraversable #-}
7{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
@@ -13,128 +9,88 @@
13{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE StandaloneDeriving #-}
10{-# LANGUAGE StandaloneDeriving #-}
15{-# LANGUAGE TemplateHaskell #-}
11{-# LANGUAGE TemplateHaskell #-}
16−{-# LANGUAGE TypeFamilies #-}
17−{-# LANGUAGE UndecidableInstances #-}
18−#if __GLASGOW_HASKELL__ <710
19−{-# LANGUAGE PolyKinds #-}
21−#include "overlapping-compat.h"
22module Data.Swagger.Internal where
12module Data.Swagger.Internal where
27−import Control.Lens ((&), (.~), (?~))
28import Control.Applicative
14import Control.Applicative
29import Data.Aeson
16import Data.Aeson
30−import qualified Data.Aeson.Types as JSON
17+import Data.Aeson.TH (deriveJSON)
31−import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
18+import Data.HashMap.Strict (HashMap)
32−import Data.Hashable (Hashable)
33import qualified Data.HashMap.Strict as HashMap
19import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
35import Data.Map (Map)
20import Data.Map (Map)
36import qualified Data.Map as Map
21import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
22+import Data.Monoid
38−import Data.Semigroup.Compat (Semigroup (..))
39import Data.Scientific (Scientific)
23import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
24+import Data.String (fromString)
41import Data.Text (Text)
25import Data.Text (Text)
42import qualified Data.Text as Text
26import qualified Data.Text as Text
43import GHC.Generics (Generic)
27import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
28+import Network (HostName, PortNumber)
45import Network.HTTP.Media (MediaType)
29import Network.HTTP.Media (MediaType)
46import Text.Read (readMaybe)
30import Text.Read (readMaybe)
48−import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49−import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
51−import Generics.SOP.TH (deriveGeneric)
52−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53− ,sopSwaggerGenericToJSONWithOpts
54− ,sopSwaggerGenericParseJSON
55− ,HasSwaggerAesonOptions(..)
56− ,AesonDefaultValue(..)
57− ,mkSwaggerAesonOptions
60import Data.Swagger.Internal.Utils
32import Data.Swagger.Internal.Utils
62−#if MIN_VERSION_aeson(0,10,0)
63−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64−#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
66−#define DEFINE_TOENCODING
70−-- >>> :seti -XDataKinds
71−-- >>> import Data.Aeson
73−-- | A list of definitions that can be used in references.
74−type Definitions = InsOrdHashMap Text
76-- | This is the root document object for the API specification.
34-- | This is the root document object for the API specification.
77data Swagger = Swagger
35data Swagger = Swagger
78 { -- | Provides metadata about the API.
36 { -- | Provides metadata about the API.
79 -- The metadata can be used by the clients if needed.
37 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
38+ _info :: Info
82 -- | The host (name or ip) serving the API. It MAY include a port.
40 -- | The host (name or ip) serving the API. It MAY include a port.
83 -- If the host is not included, the host serving the documentation is to be used (including the port).
41 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
42+ , _host :: Maybe Host
86 -- | The base path on which the API is served, which is relative to the host.
44 -- | The base path on which the API is served, which is relative to the host.
87 -- If it is not included, the API is served directly under the host.
45 -- If it is not included, the API is served directly under the host.
88 -- The value MUST start with a leading slash (/).
46 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
47+ , _basePath :: Maybe FilePath
91 -- | The transfer protocol of the API.
49 -- | The transfer protocol of the API.
92 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
50 -- 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]
51+ , _schemes :: Maybe [Scheme]
95 -- | A list of MIME types the APIs can consume.
53 -- | A list of MIME types the APIs can consume.
96 -- This is global to all APIs but can be overridden on specific API calls.
54 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
55+ , _consumes :: MimeList
99 -- | A list of MIME types the APIs can produce.
57 -- | A list of MIME types the APIs can produce.
100− -- This is global to all APIs but can be overridden on specific API calls.
58+ -- This is global to all APIs but can be overridden on specific API calls.
101− , _swaggerProduces :: MimeList
59+ , _produces :: MimeList
103 -- | The available paths and operations for the API.
61 -- | The available paths and operations for the API.
104− -- Holds the relative paths to the individual endpoints.
62+ , _paths :: Paths
105− -- The path is appended to the @'basePath'@ in order to construct the full URL.
106− , _swaggerPaths :: InsOrdHashMap FilePath PathItem
108 -- | An object to hold data types produced and consumed by operations.
64 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
65+ , _definitions :: HashMap Text Schema
111 -- | An object to hold parameters that can be used across operations.
67 -- | An object to hold parameters that can be used across operations.
112 -- This property does not define global parameters for all operations.
68 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
69+ , _parameters :: HashMap Text Param
115 -- | An object to hold responses that can be used across operations.
71 -- | An object to hold responses that can be used across operations.
116 -- This property does not define global responses for all operations.
72 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
73+ , _responses :: HashMap Text Response
119 -- | Security scheme definitions that can be used across the specification.
75 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
76+ , _securityDefinitions :: HashMap Text SecurityScheme
122 -- | A declaration of which security schemes are applied for the API as a whole.
78 -- | A declaration of which security schemes are applied for the API as a whole.
123 -- The list of values describes alternative security schemes that can be used
79 -- The list of values describes alternative security schemes that can be used
124 -- (that is, there is a logical OR between the security requirements).
80 -- (that is, there is a logical OR between the security requirements).
125 -- Individual operations can override this definition.
81 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
82+ , _security :: [SecurityRequirement]
128 -- | A list of tags used by the specification with additional metadata.
84 -- | A list of tags used by the specification with additional metadata.
129 -- The order of the tags can be used to reflect on their order by the parsing tools.
85 -- The order of the tags can be used to reflect on their order by the parsing tools.
130 -- Not all tags that are used by the Operation Object must be declared.
86 -- Not all tags that are used by the Operation Object must be declared.
131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
87 -- The tags that are not declared may be organized randomly or based on the tools' logic.
132 -- Each tag name in the list MUST be unique.
88 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
89+ , _tags :: [Tag]
135 -- | Additional external documentation.
91 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
92+ , _externalDocs :: Maybe ExternalDocs
137− } deriving (Eq, Show, Generic, Data, Typeable)
93+ } deriving (Eq, Show, Generic)
139-- | The object provides metadata about the API.
95-- | The object provides metadata about the API.
140-- The metadata can be used by the clients if needed,
96-- The metadata can be used by the clients if needed,
@@ -159,7 +115,7 @@ data Info = Info
159 -- | Provides the version of the application API
115 -- | Provides the version of the application API
160 -- (not to be confused with the specification version).
116 -- (not to be confused with the specification version).
161 , _infoVersion :: Text
117 , _infoVersion :: Text
162− } deriving (Eq, Show, Generic, Data, Typeable)
118+ } deriving (Eq, Show, Generic)
164-- | Contact information for the exposed API.
120-- | Contact information for the exposed API.
165data Contact = Contact
121data Contact = Contact
@@ -171,7 +127,7 @@ data Contact = Contact
172 -- | The email address of the contact person/organization.
128 -- | The email address of the contact person/organization.
173 , _contactEmail :: Maybe Text
129 , _contactEmail :: Maybe Text
174− } deriving (Eq, Show, Generic, Data, Typeable)
130+ } deriving (Eq, Show)
176-- | License information for the exposed API.
132-- | License information for the exposed API.
177data License = License
133data License = License
@@ -180,32 +136,13 @@ data License = License
181 -- | A URL to the license used for the API.
137 -- | A URL to the license used for the API.
182 , _licenseUrl :: Maybe URL
138 , _licenseUrl :: Maybe URL
183− } deriving (Eq, Show, Generic, Data, Typeable)
139+ } deriving (Eq, Show)
185−instance IsString License where
186− fromString s = License (fromString s) Nothing
188-- | The host (name or ip) serving the API. It MAY include a port.
141-- | The host (name or ip) serving the API. It MAY include a port.
189data Host = Host
142data Host = Host
190 { _hostName :: HostName -- ^ Host name.
143 { _hostName :: HostName -- ^ Host name.
191 , _hostPort :: Maybe PortNumber -- ^ Optional port.
144 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192− } deriving (Eq, Show, Generic, Typeable)
145+ } deriving (Eq, Show)
194−instance IsString Host where
195− fromString s = Host s Nothing
198−hostConstr = mkConstr hostDataType "Host" [] Prefix
200−hostDataType :: DataType
201−hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
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
210-- | The transfer protocol of the API.
147-- | The transfer protocol of the API.
211data Scheme
148data Scheme
@@ -213,7 +150,14 @@ data Scheme
216− deriving (Eq, Show, Generic, Data, Typeable)
153+ deriving (Eq, Show)
155+-- | The available paths and operations for the API.
157+ { -- | Holds the relative paths to the individual endpoints.
158+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
159+ _pathsMap :: HashMap FilePath PathItem
160+ } deriving (Eq, Show, Generic)
218-- | Describes the operations available on a single path.
162-- | Describes the operations available on a single path.
219-- A @'PathItem'@ may be empty, due to ACL constraints.
163-- A @'PathItem'@ may be empty, due to ACL constraints.
@@ -246,13 +190,13 @@ data PathItem = PathItem
246 -- The list MUST NOT include duplicated parameters.
190 -- The list MUST NOT include duplicated parameters.
247 -- A unique parameter is defined by a combination of a name and location.
191 -- A unique parameter is defined by a combination of a name and location.
248 , _pathItemParameters :: [Referenced Param]
192 , _pathItemParameters :: [Referenced Param]
249− } deriving (Eq, Show, Generic, Data, Typeable)
193+ } deriving (Eq, Show, Generic)
251-- | Describes a single API operation on a path.
195-- | Describes a single API operation on a path.
252data Operation = Operation
196data Operation = Operation
253 { -- | A list of tags for API documentation control.
197 { -- | A list of tags for API documentation control.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
198 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
199+ _operationTags :: [Text]
257 -- | A short summary of what the operation does.
201 -- | A short summary of what the operation does.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
202 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -306,23 +250,10 @@ data Operation = Operation
306 -- This definition overrides any declared top-level security.
250 -- This definition overrides any declared top-level security.
307 -- To remove a top-level security declaration, @Just []@ can be used.
251 -- To remove a top-level security declaration, @Just []@ can be used.
308 , _operationSecurity :: [SecurityRequirement]
252 , _operationSecurity :: [SecurityRequirement]
309− } deriving (Eq, Show, Generic, Data, Typeable)
253+ } deriving (Eq, Show, Generic)
311newtype MimeList = MimeList { getMimeList :: [MediaType] }
255newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
256+ deriving (Eq, Show, Monoid)
314−mimeListConstr :: Constr
315−mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
317−mimeListDataType :: DataType
318−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
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
327-- | Describes a single operation parameter.
258-- | Describes a single operation parameter.
328-- A unique parameter is defined by a combination of a name and location.
259-- A unique parameter is defined by a combination of a name and location.
@@ -343,12 +274,12 @@ data Param = Param
344 -- | Parameter schema.
275 -- | Parameter schema.
345 , _paramSchema :: ParamAnySchema
276 , _paramSchema :: ParamAnySchema
346− } deriving (Eq, Show, Generic, Data, Typeable)
277+ } deriving (Eq, Show, Generic)
348data ParamAnySchema
279data ParamAnySchema
349 = ParamBody (Referenced Schema)
280 = ParamBody (Referenced Schema)
350 | ParamOther ParamOtherSchema
281 | ParamOther ParamOtherSchema
351− deriving (Eq, Show, Generic, Data, Typeable)
282+ deriving (Eq, Show)
353data ParamOtherSchema = ParamOtherSchema
284data ParamOtherSchema = ParamOtherSchema
354 { -- | The location of the parameter.
285 { -- | The location of the parameter.
@@ -360,92 +291,12 @@ data ParamOtherSchema = ParamOtherSchema
360 -- Default value is @False@.
291 -- Default value is @False@.
361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
292 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
294+ -- | Determines the format of the array if @'ParamArray'@ is used.
364− } deriving (Eq, Show, Generic, Typeable, Data)
295+ -- Default value is csv.
365−
296+ , _paramOtherSchemaCollectionFormat :: Maybe (CollectionFormat Param)
366−-- | Items for @'SwaggerArray'@ schemas.
297+
367−--
298+ , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema Items
368−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
299+ } deriving (Eq, Show, Generic)
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>.
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
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
382−deriving instance Eq (SwaggerItems t)
383−deriving instance Show (SwaggerItems t)
384−--deriving instance Typeable (SwaggerItems t)
386−swaggerItemsPrimitiveConstr :: Constr
387−swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
389−swaggerItemsObjectConstr :: Constr
390−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
392−swaggerItemsArrayConstr :: Constr
393−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
395−swaggerItemsDataType :: DataType
396−swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
398−-- Note: unfortunately we have to write these Data instances by hand,
399−-- to get better contexts / avoid duplicate name when using standalone deriving
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
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
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
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)."
428− toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429− toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430− toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
432− dataTypeOf _ = swaggerItemsDataType
434−-- | Type used as a kind to avoid overlapping instances.
436− = SwaggerKindNormal t
437− | SwaggerKindParamOtherSchema
441−deriving instance Typeable 'SwaggerKindNormal
442−deriving instance Typeable 'SwaggerKindParamOtherSchema
443−deriving instance Typeable 'SwaggerKindSchema
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
450data SwaggerType t where
301data SwaggerType t where
451 SwaggerString :: SwaggerType t
302 SwaggerString :: SwaggerType t
@@ -453,48 +304,13 @@ data SwaggerType t where
453 SwaggerInteger :: SwaggerType t
304 SwaggerInteger :: SwaggerType t
454 SwaggerBoolean :: SwaggerType t
305 SwaggerBoolean :: SwaggerType t
455 SwaggerArray :: SwaggerType t
306 SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
307+ SwaggerFile :: SwaggerType ParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
308+ SwaggerNull :: SwaggerType Schema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
309+ SwaggerObject :: SwaggerType Schema
461deriving instance Eq (SwaggerType t)
311deriving instance Eq (SwaggerType t)
462deriving instance Show (SwaggerType t)
312deriving instance Show (SwaggerType t)
464−swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465−swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
467−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468−swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
470−swaggerCommonTypes :: [SwaggerType k]
471−swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
473−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474−swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
476−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477−swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
479−swaggerTypeConstrs :: [Constr]
480−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481− ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
483−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484− gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485− toConstr = swaggerTypeConstr
486− dataTypeOf = swaggerTypeDataType
488−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490− toConstr = swaggerTypeConstr
491− dataTypeOf = swaggerTypeDataType
493−instance Data (SwaggerType 'SwaggerKindSchema) where
494− gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495− toConstr = swaggerTypeConstr
496− dataTypeOf = swaggerTypeDataType
498data ParamLocation
314data ParamLocation
499 = -- | Parameters that are appended to the URL.
315 = -- | Parameters that are appended to the URL.
500 -- For example, in @/items?id=###@, the query parameter is @id@.
316 -- For example, in @/items?id=###@, the query parameter is @id@.
@@ -513,7 +329,7 @@ data ParamLocation
513 -- Form parameters have a different format based on the content-type used
329 -- Form parameters have a different format based on the content-type used
514 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
330 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
515 | ParamFormData
331 | ParamFormData
516− deriving (Eq, Show, Generic, Data, Typeable)
332+ deriving (Eq, Show)
518type Format = Text
334type Format = Text
@@ -530,29 +346,11 @@ data CollectionFormat t where
530 -- Corresponds to multiple parameter instances
346 -- Corresponds to multiple parameter instances
531 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
347 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
348 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
349+ CollectionMulti :: CollectionFormat Param
536deriving instance Eq (CollectionFormat t)
351deriving instance Eq (CollectionFormat t)
537deriving instance Show (CollectionFormat t)
352deriving instance Show (CollectionFormat t)
539−collectionFormatConstr :: CollectionFormat t -> Constr
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
542−collectionFormatDataType :: DataType
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
544− map collectionFormatConstr collectionCommonFormats
546−collectionCommonFormats :: [CollectionFormat t]
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551− toConstr = collectionFormatConstr
552− dataTypeOf _ = collectionFormatDataType
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
556type ParamName = Text
354type ParamName = Text
558data Schema = Schema
356data Schema = Schema
@@ -560,9 +358,9 @@ data Schema = Schema
560 , _schemaDescription :: Maybe Text
358 , _schemaDescription :: Maybe Text
561 , _schemaRequired :: [ParamName]
359 , _schemaRequired :: [ParamName]
563− , _schemaAllOf :: Maybe [Referenced Schema]
361+ , _schemaAllOf :: Maybe [Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
362+ , _schemaProperties :: HashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
363+ , _schemaAdditionalProperties :: Maybe Schema
567 , _schemaDiscriminator :: Maybe Text
365 , _schemaDiscriminator :: Maybe Text
568 , _schemaReadOnly :: Maybe Bool
366 , _schemaReadOnly :: Maybe Bool
@@ -573,20 +371,15 @@ data Schema = Schema
573 , _schemaMaxProperties :: Maybe Integer
371 , _schemaMaxProperties :: Maybe Integer
574 , _schemaMinProperties :: Maybe Integer
372 , _schemaMinProperties :: Maybe Integer
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
374+ , _schemaParamSchema :: ParamSchema Schema SchemaItems
577− } deriving (Eq, Show, Generic, Data, Typeable)
375+ } deriving (Eq, Show, Generic)
579−-- | A @'Schema'@ with an optional name.
377+data SchemaItems
580−-- This name can be used in references.
378+ = SchemaItemsObject (Referenced Schema)
581−data NamedSchema = NamedSchema
379+ | SchemaItemsArray [Referenced Schema]
582− { _namedSchemaName :: Maybe Text
583− , _namedSchemaSchema :: Schema
584− } deriving (Eq, Show, Generic, Data, Typeable)
380+ deriving (Eq, Show)
586−-- | Regex pattern for @string@ type.
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
382+data ParamSchema t items = ParamSchema
590 { -- | Declares the value of the parameter that the server will use if none is provided,
383 { -- | Declares the value of the parameter that the server will use if none is provided,
591 -- for example a @"count"@ to control the number of results per page might default to @100@
384 -- for example a @"count"@ to control the number of results per page might default to @100@
592 -- if not supplied by the client in the request.
385 -- if not supplied by the client in the request.
@@ -594,28 +387,26 @@ data ParamSchema (t :: SwaggerKind *) = ParamSchema
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
387 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595 _paramSchemaDefault :: Maybe Value
388 _paramSchemaDefault :: Maybe Value
597− , _paramSchemaType :: Maybe (SwaggerType t)
390+ , _paramSchemaType :: SwaggerType t
598 , _paramSchemaFormat :: Maybe Format
391 , _paramSchemaFormat :: Maybe Format
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
392+ , _paramSchemaItems :: Maybe items
600 , _paramSchemaMaximum :: Maybe Scientific
393 , _paramSchemaMaximum :: Maybe Scientific
601 , _paramSchemaExclusiveMaximum :: Maybe Bool
394 , _paramSchemaExclusiveMaximum :: Maybe Bool
602 , _paramSchemaMinimum :: Maybe Scientific
395 , _paramSchemaMinimum :: Maybe Scientific
603 , _paramSchemaExclusiveMinimum :: Maybe Bool
396 , _paramSchemaExclusiveMinimum :: Maybe Bool
604 , _paramSchemaMaxLength :: Maybe Integer
397 , _paramSchemaMaxLength :: Maybe Integer
605 , _paramSchemaMinLength :: Maybe Integer
398 , _paramSchemaMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
399+ , _paramSchemaPattern :: Maybe Text
607 , _paramSchemaMaxItems :: Maybe Integer
400 , _paramSchemaMaxItems :: Maybe Integer
608 , _paramSchemaMinItems :: Maybe Integer
401 , _paramSchemaMinItems :: Maybe Integer
609 , _paramSchemaUniqueItems :: Maybe Bool
402 , _paramSchemaUniqueItems :: Maybe Bool
610 , _paramSchemaEnum :: Maybe [Value]
403 , _paramSchemaEnum :: Maybe [Value]
611 , _paramSchemaMultipleOf :: Maybe Scientific
404 , _paramSchemaMultipleOf :: Maybe Scientific
612− } deriving (Eq, Show, Generic, Typeable)
405+ } deriving (Eq, Show, Generic)
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
616data Xml = Xml
407data Xml = Xml
617 { -- | Replaces the name of the element/attribute used for the described schema property.
408 { -- | 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.
619 -- When defined alongside type being array (outside the items),
410 -- When defined alongside type being array (outside the items),
620 -- it will affect the wrapping element and only if wrapped is true.
411 -- it will affect the wrapping element and only if wrapped is true.
621 -- If wrapped is false, it will be ignored.
412 -- If wrapped is false, it will be ignored.
@@ -639,7 +430,15 @@ data Xml = Xml
639 -- Default value is @False@.
430 -- Default value is @False@.
640 -- The definition takes effect only when defined alongside type being array (outside the items).
431 -- The definition takes effect only when defined alongside type being array (outside the items).
641 , _xmlWrapped :: Maybe Bool
432 , _xmlWrapped :: Maybe Bool
642− } deriving (Eq, Show, Generic, Data, Typeable)
433+ } deriving (Eq, Show, Generic)
436+ { -- | Determines the format of the array if type array is used.
437+ -- Default value is @'ItemsCollectionCSV'@.
438+ _itemsCollectionFormat :: Maybe (CollectionFormat Items)
440+ , _itemsParamSchema :: ParamSchema Items Items
441+ } deriving (Eq, Show, Generic)
644-- | A container for the expected responses of an operation.
443-- | A container for the expected responses of an operation.
645-- The container maps a HTTP response code to the expected response.
444-- The container maps a HTTP response code to the expected response.
@@ -653,8 +452,8 @@ data Responses = Responses
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
453 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655 -- Describes the expected response for those HTTP status codes.
454 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
455+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657− } deriving (Eq, Show, Generic, Data, Typeable)
456+ } deriving (Eq, Show, Generic)
659type HttpStatusCode = Int
458type HttpStatusCode = Int
@@ -672,14 +471,11 @@ data Response = Response
672 , _responseSchema :: Maybe (Referenced Schema)
471 , _responseSchema :: Maybe (Referenced Schema)
674 -- | A list of headers that are sent with the response.
473 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
474+ , _responseHeaders :: HashMap HeaderName Header
677 -- | An example of the response message.
476 -- | An example of the response message.
678 , _responseExamples :: Maybe Example
477 , _responseExamples :: Maybe Example
679− } deriving (Eq, Show, Generic, Data, Typeable)
478+ } deriving (Eq, Show, Generic)
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
684type HeaderName = Text
480type HeaderName = Text
@@ -687,30 +483,21 @@ data Header = Header
687 { -- | A short description of the header.
483 { -- | A short description of the header.
688 _headerDescription :: Maybe Text
484 _headerDescription :: Maybe Text
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
486+ -- | Determines the format of the array if type array is used.
691− } deriving (Eq, Show, Generic, Data, Typeable)
487+ -- Default value is @'ItemsCollectionCSV'@.
692−
488+ , _headerCollectionFormat :: Maybe (CollectionFormat Items)
693−data Example = Example { getExample :: Map MediaType Value }
694− deriving (Eq, Show, Generic, Typeable)
696−exampleConstr :: Constr
697−exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
699−exampleDataType :: DataType
490+ , _headerParamSchema :: ParamSchema Header Items
700−exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
491+ } deriving (Eq, Show, Generic)
702−instance Data Example where
493+data Example = Example { getExample :: Map MediaType Value }
703− gunfold k z c = case constrIndex c of
494+ deriving (Eq, Show)
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
709-- | The location of the API key.
496-- | The location of the API key.
710data ApiKeyLocation
497data ApiKeyLocation
711 = ApiKeyQuery
498 = ApiKeyQuery
712 | ApiKeyHeader
499 | ApiKeyHeader
713− deriving (Eq, Show, Generic, Data, Typeable)
500+ deriving (Eq, Show)
715data ApiKeyParams = ApiKeyParams
502data ApiKeyParams = ApiKeyParams
716 { -- | The name of the header or query parameter to be used.
503 { -- | The name of the header or query parameter to be used.
@@ -718,7 +505,7 @@ data ApiKeyParams = ApiKeyParams
719 -- | The location of the API key.
506 -- | The location of the API key.
720 , _apiKeyIn :: ApiKeyLocation
507 , _apiKeyIn :: ApiKeyLocation
721− } deriving (Eq, Show, Generic, Data, Typeable)
508+ } deriving (Eq, Show)
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
510-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
724type AuthorizationURL = Text
511type AuthorizationURL = Text
@@ -731,21 +518,21 @@ data OAuth2Flow
731 | OAuth2Password TokenURL
518 | OAuth2Password TokenURL
732 | OAuth2Application TokenURL
519 | OAuth2Application TokenURL
733 | OAuth2AccessCode AuthorizationURL TokenURL
520 | OAuth2AccessCode AuthorizationURL TokenURL
734− deriving (Eq, Show, Generic, Data, Typeable)
521+ deriving (Eq, Show)
736data OAuth2Params = OAuth2Params
523data OAuth2Params = OAuth2Params
737 { -- | The flow used by the OAuth2 security scheme.
524 { -- | The flow used by the OAuth2 security scheme.
738 _oauth2Flow :: OAuth2Flow
525 _oauth2Flow :: OAuth2Flow
740 -- | The available scopes for the OAuth2 security scheme.
527 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
528+ , _oauth2Scopes :: HashMap Text Text
742− } deriving (Eq, Show, Generic, Data, Typeable)
529+ } deriving (Eq, Show, Generic)
744data SecuritySchemeType
531data SecuritySchemeType
745 = SecuritySchemeBasic
532 = SecuritySchemeBasic
746 | SecuritySchemeApiKey ApiKeyParams
533 | SecuritySchemeApiKey ApiKeyParams
747 | SecuritySchemeOAuth2 OAuth2Params
534 | SecuritySchemeOAuth2 OAuth2Params
748− deriving (Eq, Show, Generic, Data, Typeable)
535+ deriving (Eq, Show)
750data SecurityScheme = SecurityScheme
537data SecurityScheme = SecurityScheme
751 { -- | The type of the security scheme.
538 { -- | The type of the security scheme.
@@ -753,39 +540,20 @@ data SecurityScheme = SecurityScheme
754 -- | A short description for security scheme.
541 -- | A short description for security scheme.
755 , _securitySchemeDescription :: Maybe Text
542 , _securitySchemeDescription :: Maybe Text
756− } deriving (Eq, Show, Generic, Data, Typeable)
543+ } deriving (Eq, Show, Generic)
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
768−mergeSecurityScheme s1 _ = s1
770−newtype SecurityDefinitions
771− = SecurityDefinitions (Definitions SecurityScheme)
772− deriving (Eq, Show, Generic, Data, Typeable)
774-- | Lists the required security schemes to execute this operation.
545-- | Lists the required security schemes to execute this operation.
775-- The object can have multiple security schemes declared in it which are all required
546-- The object can have multiple security schemes declared in it which are all required
776-- (that is, there is a logical AND between the schemes).
547-- (that is, there is a logical AND between the schemes).
777newtype SecurityRequirement = SecurityRequirement
548newtype SecurityRequirement = SecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
549+ { getSecurityRequirement :: HashMap Text [Text]
779− } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
550+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
784-- | Allows adding meta data to a single tag that is used by @Operation@.
552-- | Allows adding meta data to a single tag that is used by @Operation@.
785-- It is not mandatory to have a @Tag@ per tag used there.
553-- It is not mandatory to have a @Tag@ per tag used there.
786data Tag = Tag
554data Tag = Tag
787 { -- | The name of the tag.
555 { -- | The name of the tag.
788− _tagName :: TagName
556+ _tagName :: Text
790 -- | A short description for the tag.
558 -- | A short description for the tag.
791 -- GFM syntax can be used for rich text representation.
559 -- GFM syntax can be used for rich text representation.
@@ -793,12 +561,7 @@ data Tag = Tag
794 -- | Additional external documentation for this tag.
562 -- | Additional external documentation for this tag.
795 , _tagExternalDocs :: Maybe ExternalDocs
563 , _tagExternalDocs :: Maybe ExternalDocs
796− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
564+ } deriving (Eq, Show)
798−instance Hashable Tag
800−instance IsString Tag where
801− fromString s = Tag (fromString s) Nothing Nothing
803-- | Allows referencing an external resource for extended documentation.
566-- | Allows referencing an external resource for extended documentation.
804data ExternalDocs = ExternalDocs
567data ExternalDocs = ExternalDocs
@@ -808,145 +571,87 @@ data ExternalDocs = ExternalDocs
809 -- | The URL for the target documentation.
572 -- | The URL for the target documentation.
810 , _externalDocsUrl :: URL
573 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
574+ } deriving (Eq, Show, Generic)
813−instance Hashable ExternalDocs
815-- | A simple object to allow referencing other definitions in the specification.
576-- | A simple object to allow referencing other definitions in the specification.
816-- It can be used to reference parameters and responses that are defined at the top level for reuse.
577-- It can be used to reference parameters and responses that are defined at the top level for reuse.
817newtype Reference = Reference { getReference :: Text }
578newtype Reference = Reference { getReference :: Text }
818− deriving (Eq, Show, Data, Typeable)
579+ deriving (Eq, Show)
820data Referenced a
581data Referenced a
821 = Ref Reference
582 = Ref Reference
822 | Inline a
583 | Inline a
823− deriving (Eq, Show, Functor, Data, Typeable)
584+ deriving (Eq, Show)
825−instance IsString a => IsString (Referenced a) where
826− fromString = Inline . fromString
828−newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
586+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
830−data AdditionalProperties
831− = AdditionalPropertiesAllowed Bool
832− | AdditionalPropertiesSchema (Referenced Schema)
833− deriving (Eq, Show, Data, Typeable)
835-- =======================================================================
588-- =======================================================================
836-- Monoid instances
589-- Monoid instances
837-- =======================================================================
590-- =======================================================================
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841instance Monoid Swagger where
592instance Monoid Swagger where
842 mempty = genericMempty
593 mempty = genericMempty
843− mappend = (<>)
594+ mappend = genericMappend
845−instance Semigroup Info where
846− (<>) = genericMappend
847instance Monoid Info where
596instance Monoid Info where
848 mempty = genericMempty
597 mempty = genericMempty
849− mappend = (<>)
598+ mappend = genericMappend
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
600+instance Monoid Paths where
854 mempty = genericMempty
601 mempty = genericMempty
855− mappend = (<>)
602+ mappend = genericMappend
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859instance Monoid PathItem where
604instance Monoid PathItem where
860 mempty = genericMempty
605 mempty = genericMempty
861− mappend = (<>)
606+ mappend = genericMappend
863−instance Semigroup Schema where
864− (<>) = genericMappend
865instance Monoid Schema where
608instance Monoid Schema where
866 mempty = genericMempty
609 mempty = genericMempty
867− mappend = (<>)
610+ mappend = genericMappend
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
612+instance Monoid (ParamSchema t i) where
872 mempty = genericMempty
613 mempty = genericMempty
873− mappend = (<>)
614+ mappend = genericMappend
875−instance Semigroup Param where
876− (<>) = genericMappend
877instance Monoid Param where
616instance Monoid Param where
878 mempty = genericMempty
617 mempty = genericMempty
879− mappend = (<>)
618+ mappend = genericMappend
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883instance Monoid ParamOtherSchema where
620instance Monoid ParamOtherSchema where
884 mempty = genericMempty
621 mempty = genericMempty
887−instance Semigroup Header where
888− (<>) = genericMappend
622+ mappend = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
893−instance Semigroup Responses where
894− (<>) = genericMappend
895instance Monoid Responses where
624instance Monoid Responses where
896 mempty = genericMempty
625 mempty = genericMempty
897− mappend = (<>)
626+ mappend = genericMappend
899−instance Semigroup Response where
900− (<>) = genericMappend
901instance Monoid Response where
628instance Monoid Response where
902 mempty = genericMempty
629 mempty = genericMempty
903− mappend = (<>)
630+ mappend = genericMappend
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907instance Monoid ExternalDocs where
632instance Monoid ExternalDocs where
908 mempty = genericMempty
633 mempty = genericMempty
909− mappend = (<>)
634+ mappend = genericMappend
911−instance Semigroup Operation where
912− (<>) = genericMappend
913instance Monoid Operation where
636instance Monoid Operation where
914 mempty = genericMempty
637 mempty = genericMempty
917−instance Semigroup Example where
918− (<>) = genericMappend
638+ mappend = genericMappend
919−instance Monoid Example where
920− mempty = genericMempty
923−instance Semigroup SecurityScheme where
924− (<>) = mergeSecurityScheme
926−instance Semigroup SecurityDefinitions where
927− (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928− SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
930−instance Monoid SecurityDefinitions where
931− mempty = SecurityDefinitions $ InsOrdHashMap.empty
934-- =======================================================================
640-- =======================================================================
935-- SwaggerMonoid helper instances
641-- SwaggerMonoid helper instances
936-- =======================================================================
642-- =======================================================================
938instance SwaggerMonoid Info
644instance SwaggerMonoid Info
645+instance SwaggerMonoid Paths
939instance SwaggerMonoid PathItem
646instance SwaggerMonoid PathItem
940instance SwaggerMonoid Schema
647instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
648+instance SwaggerMonoid (ParamSchema t i)
942instance SwaggerMonoid Param
649instance SwaggerMonoid Param
943instance SwaggerMonoid ParamOtherSchema
650instance SwaggerMonoid ParamOtherSchema
944instance SwaggerMonoid Responses
651instance SwaggerMonoid Responses
945instance SwaggerMonoid Response
652instance SwaggerMonoid Response
946instance SwaggerMonoid ExternalDocs
653instance SwaggerMonoid ExternalDocs
947instance SwaggerMonoid Operation
654instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
951instance SwaggerMonoid MimeList
656instance SwaggerMonoid MimeList
952deriving instance SwaggerMonoid URL
657deriving instance SwaggerMonoid URL
@@ -959,85 +664,68 @@ instance SwaggerMonoid ParamLocation where
959 swaggerMempty = ParamQuery
664 swaggerMempty = ParamQuery
960 swaggerMappend _ y = y
665 swaggerMappend _ y = y
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
667+instance SwaggerMonoid (HashMap Text Schema) where
963− swaggerMempty = InsOrdHashMap.empty
668+ swaggerMempty = HashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
669+ swaggerMappend = HashMap.unionWith mappend
671+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
672+ swaggerMempty = HashMap.empty
673+ swaggerMappend = HashMap.unionWith swaggerMappend
966instance Monoid a => SwaggerMonoid (Referenced a) where
675instance Monoid a => SwaggerMonoid (Referenced a) where
967 swaggerMempty = Inline mempty
676 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
677+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
969 swaggerMappend _ y = y
678 swaggerMappend _ y = y
971−instance SwaggerMonoid ParamAnySchema where
680+instance SwaggerMonoid (HashMap Text Param) where
972− swaggerMempty = ParamOther swaggerMempty
681+ swaggerMempty = HashMap.empty
973− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
682+ swaggerMappend = HashMap.unionWith mappend
974− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975− swaggerMappend _ y = y
977−-- =======================================================================
978−-- Simple Generic-based ToJSON instances
979−-- =======================================================================
981−instance ToJSON ParamLocation where
982− toJSON = genericToJSON (jsonPrefix "Param")
984−instance ToJSON Info where
684+instance SwaggerMonoid (HashMap Text Response) where
985− toJSON = genericToJSON (jsonPrefix "Info")
685+ swaggerMempty = HashMap.empty
686+ swaggerMappend = flip HashMap.union
987−instance ToJSON Contact where
688+instance SwaggerMonoid (HashMap Text SecurityScheme) where
988− toJSON = genericToJSON (jsonPrefix "Contact")
689+ swaggerMempty = HashMap.empty
690+ swaggerMappend = flip HashMap.union
990−instance ToJSON License where
692+instance SwaggerMonoid (HashMap FilePath PathItem) where
991− toJSON = genericToJSON (jsonPrefix "License")
693+ swaggerMempty = HashMap.empty
694+ swaggerMappend = HashMap.unionWith mappend
993−instance ToJSON ApiKeyLocation where
696+instance SwaggerMonoid (HashMap HeaderName Header) where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
697+ swaggerMempty = HashMap.empty
698+ swaggerMappend = flip HashMap.union
996−instance ToJSON ApiKeyParams where
700+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
701+ swaggerMempty = HashMap.empty
702+ swaggerMappend = flip HashMap.union
999−instance ToJSON Scheme where
704+instance SwaggerMonoid ParamAnySchema where
1000− toJSON = genericToJSON (jsonPrefix "")
705+ swaggerMempty = ParamOther swaggerMempty
1001−
706+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
1002−instance ToJSON Tag where
707+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
1003− toJSON = genericToJSON (jsonPrefix "Tag")
708+ swaggerMappend _ y = y
1005−instance ToJSON ExternalDocs where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
1011-- =======================================================================
710-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
711+-- TH derived ToJSON and FromJSON instances
1013-- =======================================================================
712-- =======================================================================
1015−instance FromJSON ParamLocation where
714+deriveJSON (jsonPrefix "Param") ''ParamLocation
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
715+deriveJSON' ''Info
1017−
716+deriveJSON' ''Contact
1018−instance FromJSON Info where
717+deriveJSON' ''License
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
718+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
1020−
719+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
1021−instance FromJSON Contact where
720+deriveJSONDefault ''Scheme
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
721+deriveJSON' ''Tag
1023−
722+deriveJSON' ''ExternalDocs
1024−instance FromJSON License where
723+
1025− parseJSON = genericParseJSON (jsonPrefix "License")
724+deriveToJSON' ''ParamSchema
1026−
725+deriveToJSON' ''Operation
1027−instance FromJSON ApiKeyLocation where
726+deriveToJSON' ''Response
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
727+deriveToJSON' ''PathItem
1029−
728+deriveToJSON' ''Xml
1030−instance FromJSON ApiKeyParams where
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
1033−instance FromJSON Scheme where
1034− parseJSON = genericParseJSON (jsonPrefix "")
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
1042-- =======================================================================
730-- =======================================================================
1043-- Manual ToJSON instances
731-- Manual ToJSON instances
@@ -1059,8 +747,7 @@ instance ToJSON OAuth2Flow where
1059 , "tokenUrl" .= tokenUrl ]
747 , "tokenUrl" .= tokenUrl ]
1061instance ToJSON OAuth2Params where
749instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
750+ toJSON = genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1065instance ToJSON SecuritySchemeType where
752instance ToJSON SecuritySchemeType where
1066 toJSON SecuritySchemeBasic
753 toJSON SecuritySchemeBasic
@@ -1073,38 +760,22 @@ instance ToJSON SecuritySchemeType where
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
760 <+> object [ "type" .= ("oauth2" :: Text) ]
1075instance ToJSON Swagger where
762instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
763+ toJSON = addVersion . genericToJSON (jsonPrefix "")
1077− DEFINE_TOENCODING
764+ where
765+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
766+ addVersion _ = error "impossible"
1079instance ToJSON SecurityScheme where
768instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
769+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1083instance ToJSON Schema where
771instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
772+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1087instance ToJSON Header where
774instance ToJSON Header where
1088− toJSON = sopSwaggerGenericToJSON
775+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
1089− DEFINE_TOENCODING
776+
1091−-- | As for nullary schema for 0-arity type constructors, see
1092−-- <https://github.com/GetShopTV/swagger2/issues/167>.
1094−-- >>> encode (SwaggerItemsArray [])
1095−-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1097−instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
777+instance ToJSON Items where
1098− toJSON (SwaggerItemsPrimitive fmt schema) = object
778+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "items")
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
1107− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1109instance ToJSON Host where
780instance ToJSON Host where
1110 toJSON (Host host mport) = toJSON $
781 toJSON (Host host mport) = toJSON $
@@ -1112,53 +783,38 @@ instance ToJSON Host where
1112 Nothing -> host
783 Nothing -> host
1113 Just port -> host ++ ":" ++ show port
784 Just port -> host ++ ":" ++ show port
786+instance ToJSON Paths where
787+ toJSON (Paths m) = toJSON m
1115instance ToJSON MimeList where
789instance ToJSON MimeList where
1116 toJSON (MimeList xs) = toJSON (map show xs)
790 toJSON (MimeList xs) = toJSON (map show xs)
1118instance ToJSON Param where
792instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
793+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1122instance ToJSON ParamAnySchema where
795instance ToJSON ParamAnySchema where
1123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
796 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124 toJSON (ParamOther s) = toJSON s
797 toJSON (ParamOther s) = toJSON s
1126instance ToJSON ParamOtherSchema where
799instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
800+ toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1130−instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1134−instance ToJSON Response where
802+instance ToJSON SchemaItems where
1135− toJSON = sopSwaggerGenericToJSON
803+ toJSON (SchemaItemsObject x) = toJSON x
1136− DEFINE_TOENCODING
804+ toJSON (SchemaItemsArray xs) = toJSON xs
1138−instance ToJSON Operation where
806+instance ToJSON Responses where
1139− toJSON = sopSwaggerGenericToJSON
807+ toJSON (Responses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1142−instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1146instance ToJSON Example where
809instance ToJSON Example where
1147 toJSON = toJSON . Map.mapKeys show . getExample
810 toJSON = toJSON . Map.mapKeys show . getExample
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1152instance ToJSON Reference where
812instance ToJSON Reference where
1153 toJSON (Reference ref) = object [ "$ref" .= ref ]
813 toJSON (Reference ref) = object [ "$ref" .= ref ]
1155−referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
815+instance ToJSON a => ToJSON (Referenced a) where
1156−referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
816+ toJSON (Ref ref) = toJSON ref
1157−referencedToJSON _ (Inline x) = toJSON x
817+ toJSON (Inline x) = toJSON x
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/"
1163instance ToJSON (SwaggerType t) where
819instance ToJSON (SwaggerType t) where
1164 toJSON SwaggerArray = "array"
820 toJSON SwaggerArray = "array"
@@ -1177,15 +833,6 @@ instance ToJSON (CollectionFormat t) where
1177 toJSON CollectionPipes = "pipes"
833 toJSON CollectionPipes = "pipes"
1178 toJSON CollectionMulti = "multi"
834 toJSON CollectionMulti = "multi"
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"
1185−instance ToJSON AdditionalProperties where
1186− toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187− toJSON (AdditionalPropertiesSchema s) = toJSON s
1189-- =======================================================================
836-- =======================================================================
1190-- Manual FromJSON instances
837-- Manual FromJSON instances
1191-- =======================================================================
838-- =======================================================================
@@ -1204,7 +851,7 @@ instance FromJSON OAuth2Flow where
1204 parseJSON _ = empty
851 parseJSON _ = empty
1206instance FromJSON OAuth2Params where
853instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
854+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1209instance FromJSON SecuritySchemeType where
856instance FromJSON SecuritySchemeType where
1210 parseJSON js@(Object o) = do
857 parseJSON js@(Object o) = do
@@ -1217,65 +864,53 @@ instance FromJSON SecuritySchemeType where
1217 parseJSON _ = empty
864 parseJSON _ = empty
1219instance FromJSON Swagger where
866instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
867+ parseJSON js@(Object o) = do
868+ (version :: Text) <- o .: "swagger"
869+ when (version /= "2.0") empty
870+ (genericParseJSON (jsonPrefix "")
871+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
872+ , "produces" .= (mempty :: MimeList)
873+ , "security" .= ([] :: [SecurityRequirement])
874+ , "tags" .= ([] :: [Tag])
875+ , "definitions" .= (mempty :: HashMap Text Schema)
876+ , "parameters" .= (mempty :: HashMap Text Param)
877+ , "responses" .= (mempty :: HashMap Text Response)
878+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
1222instance FromJSON SecurityScheme where
882instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
883+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1225instance FromJSON Schema where
885instance FromJSON Schema where
1226− parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
886+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1227− where nullaryCleanup :: Schema -> Schema
887+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1228− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
888+ , "required" .= ([] :: [ParamName]) ]
1229− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230− then s { _schemaExample = Nothing
1231− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1234instance FromJSON Header where
890instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
891+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
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)
1242−instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
893+instance FromJSON Items where
1243− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
894+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "items")
1244− <$> o .:? "collectionFormat"
1245− <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1249−-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250−-- Just (SwaggerItemsArray [])
1252−-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253−-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1255−-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256−-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
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
1265instance FromJSON Host where
896instance FromJSON Host where
1266− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
897+ parseJSON (String s) =
1267− [host] -> return $ Host host Nothing
898+ case fromInteger <$> readMaybe portStr of
1268− [host, port] -> case readMaybe port of
899+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1269− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
900+ mport -> pure $ Host host mport
1270− Just p -> return $ Host host (Just (fromInteger p))
901+ where
1271− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
902+ (hostText, portText) = Text.breakOn ":" s
903+ [host, portStr] = map Text.unpack [hostText, portText]
1272 parseJSON _ = empty
904 parseJSON _ = empty
906+instance FromJSON Paths where
907+ parseJSON js = Paths <$> parseJSON js
1274instance FromJSON MimeList where
909instance FromJSON MimeList where
1275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
910 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1277instance FromJSON Param where
912instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
913+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1280instance FromJSON ParamAnySchema where
915instance FromJSON ParamAnySchema where
1281 parseJSON js@(Object o) = do
916 parseJSON js@(Object o) = do
@@ -1288,12 +923,17 @@ instance FromJSON ParamAnySchema where
1288 parseJSON _ = empty
923 parseJSON _ = empty
1290instance FromJSON ParamOtherSchema where
925instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
926+ parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
928+instance FromJSON SchemaItems where
929+ parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
930+ parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
1293instance FromJSON Responses where
933instance FromJSON Responses where
1294 parseJSON (Object o) = Responses
934 parseJSON (Object o) = Responses
1295 <$> o .:? "default"
935 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
936+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1297 parseJSON _ = empty
937 parseJSON _ = empty
1299instance FromJSON Example where
939instance FromJSON Example where
@@ -1302,126 +942,46 @@ instance FromJSON Example where
1302 pure $ Example (Map.mapKeys fromString m)
942 pure $ Example (Map.mapKeys fromString m)
1304instance FromJSON Response where
944instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
945+ parseJSON = genericParseJSON (jsonPrefix "response")
946+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1307instance FromJSON Operation where
948instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
949+ parseJSON = genericParseJSON (jsonPrefix "operation")
950+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1310instance FromJSON PathItem where
952instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
953+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1312−
954+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1316instance FromJSON Reference where
956instance FromJSON Reference where
1317 parseJSON (Object o) = Reference <$> o .: "$ref"
957 parseJSON (Object o) = Reference <$> o .: "$ref"
1318 parseJSON _ = empty
958 parseJSON _ = empty
1320−referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
960+instance FromJSON a => FromJSON (Referenced a) where
1321−referencedParseJSON prefix js@(Object o) = do
1324− Nothing -> Inline <$> parseJSON js
961+ parseJSON js
1325− Just s -> Ref <$> parseRef s
962+ = Ref <$> parseJSON js
1326− where
963+ <|> Inline <$> parseJSON js
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"
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/"
1337instance FromJSON Xml where
965instance FromJSON Xml where
1338 parseJSON = genericParseJSON (jsonPrefix "xml")
966 parseJSON = genericParseJSON (jsonPrefix "xml")
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
968+instance FromJSON (SwaggerType Schema) where
1341 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
969 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
971+instance FromJSON (SwaggerType ParamOtherSchema) where
1344 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
972 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
974+instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
1347 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
975 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1349−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
977+instance FromJSON (CollectionFormat Param) where
1350− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1352−-- NOTE: There aren't collections of 'Schema'
1353−--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1354−-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1356−instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1357 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
978 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1359−instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
980+instance FromJSON (CollectionFormat Items) where
1360− parseJSON = sopSwaggerGenericParseJSON
981+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1361−instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
982+
1362− parseJSON = sopSwaggerGenericParseJSON
983+-- NOTE: The constraint @FromJSON (SwaggerType t)@ is necessary here!
1363−instance FromJSON (ParamSchema 'SwaggerKindSchema) where
984+-- Without the constraint the general instance will be used
1364− parseJSON = sopSwaggerGenericParseJSON
985+-- that only accepts common types (i.e. NOT object, null or file).
1365−
986+instance (FromJSON (SwaggerType t), FromJSON i) => FromJSON (ParamSchema t i) where
1366−instance FromJSON AdditionalProperties where
987+ parseJSON = genericParseJSON (jsonPrefix "ParamSchema")
1367− parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368− parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1370−-------------------------------------------------------------------------------
1372−-------------------------------------------------------------------------------
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
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")]
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"
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