@@ -1,140 +1,94 @@
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
5{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
6{-# LANGUAGE DeriveTraversable #-}
2{-# LANGUAGE DeriveTraversable #-}
7−{-# LANGUAGE FlexibleContexts #-}
8{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11{-# LANGUAGE OverloadedStrings #-}
5{-# LANGUAGE OverloadedStrings #-}
12{-# LANGUAGE RecordWildCards #-}
6{-# LANGUAGE RecordWildCards #-}
13{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE StandaloneDeriving #-}
8{-# LANGUAGE StandaloneDeriving #-}
15{-# LANGUAGE TemplateHaskell #-}
9{-# 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
10module Data.Swagger.Internal where
27−import Control.Lens ((&), (.~), (?~))
28import Control.Applicative
12import Control.Applicative
29import Data.Aeson
14import Data.Aeson
30−import qualified Data.Aeson.Types as JSON
15+import Data.Aeson.TH (deriveJSON)
31−import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
16+import Data.HashMap.Strict (HashMap)
32−import Data.Hashable (Hashable)
33import qualified Data.HashMap.Strict as HashMap
17import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
35import Data.Map (Map)
18import Data.Map (Map)
36import qualified Data.Map as Map
19import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
20+import Data.Monoid
38−import Data.Semigroup.Compat (Semigroup (..))
39import Data.Scientific (Scientific)
21import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
22+import Data.String (fromString)
41import Data.Text (Text)
23import Data.Text (Text)
42import qualified Data.Text as Text
24import qualified Data.Text as Text
43import GHC.Generics (Generic)
25import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
26+import Network (HostName, PortNumber)
45import Network.HTTP.Media (MediaType)
27import Network.HTTP.Media (MediaType)
46import Text.Read (readMaybe)
28import 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
30import 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.
32-- | This is the root document object for the API specification.
77data Swagger = Swagger
33data Swagger = Swagger
78 { -- | Provides metadata about the API.
34 { -- | Provides metadata about the API.
79 -- The metadata can be used by the clients if needed.
35 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
36+ _info :: Info
82 -- | The host (name or ip) serving the API. It MAY include a port.
38 -- | 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).
39 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
40+ , _host :: Maybe Host
86 -- | The base path on which the API is served, which is relative to the host.
42 -- | 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.
43 -- If it is not included, the API is served directly under the host.
88 -- The value MUST start with a leading slash (/).
44 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
45+ , _basePath :: Maybe FilePath
91 -- | The transfer protocol of the API.
47 -- | 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.
48 -- 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]
49+ , _schemes :: Maybe [Scheme]
95 -- | A list of MIME types the APIs can consume.
51 -- | A list of MIME types the APIs can consume.
96 -- This is global to all APIs but can be overridden on specific API calls.
52 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
53+ , _consumes :: MimeList
99 -- | A list of MIME types the APIs can produce.
55 -- | A list of MIME types the APIs can produce.
100− -- This is global to all APIs but can be overridden on specific API calls.
56+ -- This is global to all APIs but can be overridden on specific API calls.
101− , _swaggerProduces :: MimeList
57+ , _produces :: MimeList
103 -- | The available paths and operations for the API.
59 -- | The available paths and operations for the API.
104− -- Holds the relative paths to the individual endpoints.
60+ , _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.
62 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
63+ , _definitions :: HashMap Text Schema
111 -- | An object to hold parameters that can be used across operations.
65 -- | An object to hold parameters that can be used across operations.
112 -- This property does not define global parameters for all operations.
66 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
67+ , _parameters :: HashMap Text Param
115 -- | An object to hold responses that can be used across operations.
69 -- | An object to hold responses that can be used across operations.
116 -- This property does not define global responses for all operations.
70 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
71+ , _responses :: HashMap Text Response
119 -- | Security scheme definitions that can be used across the specification.
73 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
74+ , _securityDefinitions :: HashMap Text SecurityScheme
122 -- | A declaration of which security schemes are applied for the API as a whole.
76 -- | 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
77 -- The list of values describes alternative security schemes that can be used
124 -- (that is, there is a logical OR between the security requirements).
78 -- (that is, there is a logical OR between the security requirements).
125 -- Individual operations can override this definition.
79 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
80+ , _security :: [SecurityRequirement]
128 -- | A list of tags used by the specification with additional metadata.
82 -- | 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.
83 -- 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.
84 -- 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.
85 -- 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.
86 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
87+ , _tags :: [Tag]
135 -- | Additional external documentation.
89 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
90+ , _externalDocs :: Maybe ExternalDocs
137− } deriving (Eq, Show, Generic, Data, Typeable)
91+ } deriving (Eq, Show, Generic)
139-- | The object provides metadata about the API.
93-- | The object provides metadata about the API.
140-- The metadata can be used by the clients if needed,
94-- The metadata can be used by the clients if needed,
@@ -159,7 +113,7 @@ data Info = Info
159 -- | Provides the version of the application API
113 -- | Provides the version of the application API
160 -- (not to be confused with the specification version).
114 -- (not to be confused with the specification version).
161 , _infoVersion :: Text
115 , _infoVersion :: Text
162− } deriving (Eq, Show, Generic, Data, Typeable)
116+ } deriving (Eq, Show, Generic)
164-- | Contact information for the exposed API.
118-- | Contact information for the exposed API.
165data Contact = Contact
119data Contact = Contact
@@ -171,7 +125,7 @@ data Contact = Contact
172 -- | The email address of the contact person/organization.
126 -- | The email address of the contact person/organization.
173 , _contactEmail :: Maybe Text
127 , _contactEmail :: Maybe Text
174− } deriving (Eq, Show, Generic, Data, Typeable)
128+ } deriving (Eq, Show)
176-- | License information for the exposed API.
130-- | License information for the exposed API.
177data License = License
131data License = License
@@ -180,32 +134,13 @@ data License = License
181 -- | A URL to the license used for the API.
135 -- | A URL to the license used for the API.
182 , _licenseUrl :: Maybe URL
136 , _licenseUrl :: Maybe URL
183− } deriving (Eq, Show, Generic, Data, Typeable)
137+ } 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.
139-- | The host (name or ip) serving the API. It MAY include a port.
189data Host = Host
140data Host = Host
190 { _hostName :: HostName -- ^ Host name.
141 { _hostName :: HostName -- ^ Host name.
191 , _hostPort :: Maybe PortNumber -- ^ Optional port.
142 , _hostPort :: Maybe PortNumber -- ^ Optional port.
192− } deriving (Eq, Show, Generic, Typeable)
143+ } 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.
145-- | The transfer protocol of the API.
211data Scheme
146data Scheme
@@ -213,7 +148,14 @@ data Scheme
216− deriving (Eq, Show, Generic, Data, Typeable)
151+ deriving (Eq, Show)
153+-- | The available paths and operations for the API.
155+ { -- | Holds the relative paths to the individual endpoints.
156+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
157+ _pathsMap :: HashMap FilePath PathItem
158+ } deriving (Eq, Show, Generic)
218-- | Describes the operations available on a single path.
160-- | Describes the operations available on a single path.
219-- A @'PathItem'@ may be empty, due to ACL constraints.
161-- A @'PathItem'@ may be empty, due to ACL constraints.
@@ -246,13 +188,13 @@ data PathItem = PathItem
246 -- The list MUST NOT include duplicated parameters.
188 -- The list MUST NOT include duplicated parameters.
247 -- A unique parameter is defined by a combination of a name and location.
189 -- A unique parameter is defined by a combination of a name and location.
248 , _pathItemParameters :: [Referenced Param]
190 , _pathItemParameters :: [Referenced Param]
249− } deriving (Eq, Show, Generic, Data, Typeable)
191+ } deriving (Eq, Show, Generic)
251-- | Describes a single API operation on a path.
193-- | Describes a single API operation on a path.
252data Operation = Operation
194data Operation = Operation
253 { -- | A list of tags for API documentation control.
195 { -- | A list of tags for API documentation control.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
196 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
197+ _operationTags :: [Text]
257 -- | A short summary of what the operation does.
199 -- | A short summary of what the operation does.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
200 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -306,23 +248,10 @@ data Operation = Operation
306 -- This definition overrides any declared top-level security.
248 -- This definition overrides any declared top-level security.
307 -- To remove a top-level security declaration, @Just []@ can be used.
249 -- To remove a top-level security declaration, @Just []@ can be used.
308 , _operationSecurity :: [SecurityRequirement]
250 , _operationSecurity :: [SecurityRequirement]
309− } deriving (Eq, Show, Generic, Data, Typeable)
251+ } deriving (Eq, Show, Generic)
311newtype MimeList = MimeList { getMimeList :: [MediaType] }
253newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
254+ 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.
256-- | Describes a single operation parameter.
328-- A unique parameter is defined by a combination of a name and location.
257-- A unique parameter is defined by a combination of a name and location.
@@ -342,13 +271,13 @@ data Param = Param
342 , _paramRequired :: Maybe Bool
271 , _paramRequired :: Maybe Bool
344 -- | Parameter schema.
273 -- | Parameter schema.
345− , _paramSchema :: ParamAnySchema
274+ , _paramSchema :: ParamSchema
346− } deriving (Eq, Show, Generic, Data, Typeable)
275+ } deriving (Eq, Show, Generic)
348−data ParamAnySchema
277+data ParamSchema
349 = ParamBody (Referenced Schema)
278 = ParamBody (Referenced Schema)
350 | ParamOther ParamOtherSchema
279 | ParamOther ParamOtherSchema
351− deriving (Eq, Show, Generic, Data, Typeable)
280+ deriving (Eq, Show)
353data ParamOtherSchema = ParamOtherSchema
282data ParamOtherSchema = ParamOtherSchema
354 { -- | The location of the parameter.
283 { -- | The location of the parameter.
@@ -360,140 +289,21 @@ data ParamOtherSchema = ParamOtherSchema
360 -- Default value is @False@.
289 -- Default value is @False@.
361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
290 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
292+ -- | Determines the format of the array if @'ParamArray'@ is used.
364− } deriving (Eq, Show, Generic, Typeable, Data)
293+ -- Default value is csv.
365−
294+ , _paramOtherSchemaCollectionFormat :: Maybe CollectionFormat
366−-- | Items for @'SwaggerArray'@ schemas.
295+
367−--
296+ , _paramOtherSchemaCommon :: SchemaCommon ParamType Items
368−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
297+ } deriving (Eq, Show, Generic)
369−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
298+
370−-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
299+data ParamType
371−-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
300+ = ParamString
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
302+ | ParamInteger
374−--
303+ | ParamBoolean
375−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
304+ | ParamArray
376−data SwaggerItems t where
305+ | ParamFile
377− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
306+ deriving (Eq, Show)
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
450−data SwaggerType t where
451− SwaggerString :: SwaggerType t
452− SwaggerNumber :: SwaggerType t
453− SwaggerInteger :: SwaggerType t
454− SwaggerBoolean :: SwaggerType t
455− SwaggerArray :: SwaggerType t
456− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457− SwaggerNull :: SwaggerType 'SwaggerKindSchema
458− SwaggerObject :: SwaggerType 'SwaggerKindSchema
461−deriving instance Eq (SwaggerType t)
462−deriving 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
308data ParamLocation
499 = -- | Parameters that are appended to the URL.
309 = -- | Parameters that are appended to the URL.
@@ -513,45 +323,46 @@ data ParamLocation
513 -- Form parameters have a different format based on the content-type used
323 -- 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>).
324 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
515 | ParamFormData
325 | ParamFormData
516− deriving (Eq, Show, Generic, Data, Typeable)
326+ deriving (Eq, Show)
518type Format = Text
328type Format = Text
520-- | Determines the format of the array.
330-- | Determines the format of the array.
521−data CollectionFormat t where
331+data CollectionFormat
522− -- Comma separated values: @foo,bar@.
332+ = CollectionCSV -- ^ Comma separated values: @foo,bar@.
523− CollectionCSV :: CollectionFormat t
524− -- Space separated values: @foo bar@.
333+ | CollectionSSV -- ^ Space separated values: @foo bar@.
525− CollectionSSV :: CollectionFormat t
526− -- Tab separated values: @foo\\tbar@.
334+ | CollectionTSV -- ^ Tab separated values: @foo\\tbar@.
527− CollectionTSV :: CollectionFormat t
528− -- Pipe separated values: @foo|bar@.
335+ | CollectionPipes -- ^ Pipe separated values: @foo|bar@.
529− CollectionPipes :: CollectionFormat t
530− -- Corresponds to multiple parameter instances
336+ | CollectionMulti -- ^ Corresponds to multiple parameter instances
531− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
337+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532− -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
338+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
339+ deriving (Eq, Show)
536−deriving instance Eq (CollectionFormat t)
341+data ItemsType
537−deriving instance Show (CollectionFormat t)
342+ = ItemsString
539−collectionFormatConstr :: CollectionFormat t -> Constr
344+ | ItemsInteger
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
345+ | ItemsBoolean
542−collectionFormatDataType :: DataType
347+ deriving (Eq, Show)
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
348+
544− map collectionFormatConstr collectionCommonFormats
349+data SchemaType
546−collectionCommonFormats :: [CollectionFormat t]
351+ | SchemaBoolean
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
352+ | SchemaInteger
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
354+ | SchemaNull
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
355+ | SchemaObject
551− toConstr = collectionFormatConstr
356+ | SchemaString
552− dataTypeOf _ = collectionFormatDataType
357+ deriving (Eq, Show)
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
359+-- | Determines the format of the nested array.
360+data ItemsCollectionFormat
361+ = ItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
362+ | ItemsCollectionSSV -- ^ Space separated values: @foo bar@.
363+ | ItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
364+ | ItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
556type ParamName = Text
367type ParamName = Text
@@ -560,9 +371,9 @@ data Schema = Schema
560 , _schemaDescription :: Maybe Text
371 , _schemaDescription :: Maybe Text
561 , _schemaRequired :: [ParamName]
372 , _schemaRequired :: [ParamName]
563− , _schemaAllOf :: Maybe [Referenced Schema]
374+ , _schemaAllOf :: Maybe [Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
375+ , _schemaProperties :: HashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
376+ , _schemaAdditionalProperties :: Maybe Schema
567 , _schemaDiscriminator :: Maybe Text
378 , _schemaDiscriminator :: Maybe Text
568 , _schemaReadOnly :: Maybe Bool
379 , _schemaReadOnly :: Maybe Bool
@@ -573,49 +384,42 @@ data Schema = Schema
573 , _schemaMaxProperties :: Maybe Integer
384 , _schemaMaxProperties :: Maybe Integer
574 , _schemaMinProperties :: Maybe Integer
385 , _schemaMinProperties :: Maybe Integer
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
387+ , _schemaSchemaCommon :: SchemaCommon SchemaType SchemaItems
577− } deriving (Eq, Show, Generic, Data, Typeable)
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)
388+ } deriving (Eq, Show, Generic)
586−-- | Regex pattern for @string@ type.
390+data SchemaItems
587−type Pattern = Text
391+ = SchemaItemsObject (Referenced Schema)
392+ | SchemaItemsArray [Referenced Schema]
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
395+data SchemaCommon typeDomain items = SchemaCommon
590 { -- | Declares the value of the parameter that the server will use if none is provided,
396 { -- | 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@
397 -- 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.
398 -- if not supplied by the client in the request.
593 -- (Note: "default" has no meaning for required parameters.)
399 -- (Note: "default" has no meaning for required parameters.)
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
400 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595− _paramSchemaDefault :: Maybe Value
401+ _schemaCommonDefault :: Maybe Value
597− , _paramSchemaType :: Maybe (SwaggerType t)
403+ , _schemaCommonType :: typeDomain
598− , _paramSchemaFormat :: Maybe Format
404+ , _schemaCommonFormat :: Maybe Format
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
405+ , _schemaCommonItems :: Maybe items
600− , _paramSchemaMaximum :: Maybe Scientific
406+ , _schemaCommonMaximum :: Maybe Scientific
601− , _paramSchemaExclusiveMaximum :: Maybe Bool
407+ , _schemaCommonExclusiveMaximum :: Maybe Bool
602− , _paramSchemaMinimum :: Maybe Scientific
408+ , _schemaCommonMinimum :: Maybe Scientific
603− , _paramSchemaExclusiveMinimum :: Maybe Bool
409+ , _schemaCommonExclusiveMinimum :: Maybe Bool
604− , _paramSchemaMaxLength :: Maybe Integer
410+ , _schemaCommonMaxLength :: Maybe Integer
605− , _paramSchemaMinLength :: Maybe Integer
411+ , _schemaCommonMinLength :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
412+ , _schemaCommonPattern :: Maybe Text
607− , _paramSchemaMaxItems :: Maybe Integer
413+ , _schemaCommonMaxItems :: Maybe Integer
608− , _paramSchemaMinItems :: Maybe Integer
414+ , _schemaCommonMinItems :: Maybe Integer
609− , _paramSchemaUniqueItems :: Maybe Bool
415+ , _schemaCommonUniqueItems :: Maybe Bool
610− , _paramSchemaEnum :: Maybe [Value]
416+ , _schemaCommonEnum :: Maybe [Value]
611− , _paramSchemaMultipleOf :: Maybe Scientific
417+ , _schemaCommonMultipleOf :: Maybe Scientific
612− } deriving (Eq, Show, Generic, Typeable)
418+ } deriving (Eq, Show, Generic)
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
616data Xml = Xml
420data Xml = Xml
617 { -- | Replaces the name of the element/attribute used for the described schema property.
421 { -- | 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.
422+ -- 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),
423 -- When defined alongside type being array (outside the items),
620 -- it will affect the wrapping element and only if wrapped is true.
424 -- it will affect the wrapping element and only if wrapped is true.
621 -- If wrapped is false, it will be ignored.
425 -- If wrapped is false, it will be ignored.
@@ -639,7 +443,15 @@ data Xml = Xml
639 -- Default value is @False@.
443 -- Default value is @False@.
640 -- The definition takes effect only when defined alongside type being array (outside the items).
444 -- The definition takes effect only when defined alongside type being array (outside the items).
641 , _xmlWrapped :: Maybe Bool
445 , _xmlWrapped :: Maybe Bool
642− } deriving (Eq, Show, Generic, Data, Typeable)
446+ } deriving (Eq, Show, Generic)
449+ { -- | Determines the format of the array if type array is used.
450+ -- Default value is @'ItemsCollectionCSV'@.
451+ _itemsCollectionFormat :: Maybe ItemsCollectionFormat
453+ , _itemsCommon :: SchemaCommon ItemsType Items
454+ } deriving (Eq, Show, Generic)
644-- | A container for the expected responses of an operation.
456-- | A container for the expected responses of an operation.
645-- The container maps a HTTP response code to the expected response.
457-- The container maps a HTTP response code to the expected response.
@@ -653,8 +465,8 @@ data Responses = Responses
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
466 -- | 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.
467 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
468+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657− } deriving (Eq, Show, Generic, Data, Typeable)
469+ } deriving (Eq, Show, Generic)
659type HttpStatusCode = Int
471type HttpStatusCode = Int
@@ -672,14 +484,11 @@ data Response = Response
672 , _responseSchema :: Maybe (Referenced Schema)
484 , _responseSchema :: Maybe (Referenced Schema)
674 -- | A list of headers that are sent with the response.
486 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
487+ , _responseHeaders :: HashMap HeaderName Header
677 -- | An example of the response message.
489 -- | An example of the response message.
678 , _responseExamples :: Maybe Example
490 , _responseExamples :: Maybe Example
679− } deriving (Eq, Show, Generic, Data, Typeable)
491+ } deriving (Eq, Show, Generic)
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
684type HeaderName = Text
493type HeaderName = Text
@@ -687,30 +496,21 @@ data Header = Header
687 { -- | A short description of the header.
496 { -- | A short description of the header.
688 _headerDescription :: Maybe Text
497 _headerDescription :: Maybe Text
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
499+ -- | Determines the format of the array if type array is used.
691− } deriving (Eq, Show, Generic, Data, Typeable)
500+ -- Default value is @'ItemsCollectionCSV'@.
692−
501+ , _headerCollectionFormat :: Maybe ItemsCollectionFormat
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
503+ , _headerCommon :: SchemaCommon ItemsType Items
700−exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
504+ } deriving (Eq, Show, Generic)
702−instance Data Example where
506+data Example = Example { getExample :: Map MediaType Value }
703− gunfold k z c = case constrIndex c of
507+ 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.
509-- | The location of the API key.
710data ApiKeyLocation
510data ApiKeyLocation
711 = ApiKeyQuery
511 = ApiKeyQuery
712 | ApiKeyHeader
512 | ApiKeyHeader
713− deriving (Eq, Show, Generic, Data, Typeable)
513+ deriving (Eq, Show)
715data ApiKeyParams = ApiKeyParams
515data ApiKeyParams = ApiKeyParams
716 { -- | The name of the header or query parameter to be used.
516 { -- | The name of the header or query parameter to be used.
@@ -718,7 +518,7 @@ data ApiKeyParams = ApiKeyParams
719 -- | The location of the API key.
519 -- | The location of the API key.
720 , _apiKeyIn :: ApiKeyLocation
520 , _apiKeyIn :: ApiKeyLocation
721− } deriving (Eq, Show, Generic, Data, Typeable)
521+ } deriving (Eq, Show)
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
523-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
724type AuthorizationURL = Text
524type AuthorizationURL = Text
@@ -731,21 +531,21 @@ data OAuth2Flow
731 | OAuth2Password TokenURL
531 | OAuth2Password TokenURL
732 | OAuth2Application TokenURL
532 | OAuth2Application TokenURL
733 | OAuth2AccessCode AuthorizationURL TokenURL
533 | OAuth2AccessCode AuthorizationURL TokenURL
734− deriving (Eq, Show, Generic, Data, Typeable)
534+ deriving (Eq, Show)
736data OAuth2Params = OAuth2Params
536data OAuth2Params = OAuth2Params
737 { -- | The flow used by the OAuth2 security scheme.
537 { -- | The flow used by the OAuth2 security scheme.
738 _oauth2Flow :: OAuth2Flow
538 _oauth2Flow :: OAuth2Flow
740 -- | The available scopes for the OAuth2 security scheme.
540 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
541+ , _oauth2Scopes :: HashMap Text Text
742− } deriving (Eq, Show, Generic, Data, Typeable)
542+ } deriving (Eq, Show, Generic)
744data SecuritySchemeType
544data SecuritySchemeType
745 = SecuritySchemeBasic
545 = SecuritySchemeBasic
746 | SecuritySchemeApiKey ApiKeyParams
546 | SecuritySchemeApiKey ApiKeyParams
747 | SecuritySchemeOAuth2 OAuth2Params
547 | SecuritySchemeOAuth2 OAuth2Params
748− deriving (Eq, Show, Generic, Data, Typeable)
548+ deriving (Eq, Show)
750data SecurityScheme = SecurityScheme
550data SecurityScheme = SecurityScheme
751 { -- | The type of the security scheme.
551 { -- | The type of the security scheme.
@@ -753,39 +553,20 @@ data SecurityScheme = SecurityScheme
754 -- | A short description for security scheme.
554 -- | A short description for security scheme.
755 , _securitySchemeDescription :: Maybe Text
555 , _securitySchemeDescription :: Maybe Text
756− } deriving (Eq, Show, Generic, Data, Typeable)
556+ } 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.
558-- | Lists the required security schemes to execute this operation.
775-- The object can have multiple security schemes declared in it which are all required
559-- 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).
560-- (that is, there is a logical AND between the schemes).
777newtype SecurityRequirement = SecurityRequirement
561newtype SecurityRequirement = SecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
562+ { getSecurityRequirement :: HashMap Text [Text]
779− } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
563+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
784-- | Allows adding meta data to a single tag that is used by @Operation@.
565-- | 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.
566-- It is not mandatory to have a @Tag@ per tag used there.
786data Tag = Tag
567data Tag = Tag
787 { -- | The name of the tag.
568 { -- | The name of the tag.
788− _tagName :: TagName
569+ _tagName :: Text
790 -- | A short description for the tag.
571 -- | A short description for the tag.
791 -- GFM syntax can be used for rich text representation.
572 -- GFM syntax can be used for rich text representation.
@@ -793,12 +574,7 @@ data Tag = Tag
794 -- | Additional external documentation for this tag.
575 -- | Additional external documentation for this tag.
795 , _tagExternalDocs :: Maybe ExternalDocs
576 , _tagExternalDocs :: Maybe ExternalDocs
796− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
577+ } 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.
579-- | Allows referencing an external resource for extended documentation.
804data ExternalDocs = ExternalDocs
580data ExternalDocs = ExternalDocs
@@ -808,236 +584,170 @@ data ExternalDocs = ExternalDocs
809 -- | The URL for the target documentation.
585 -- | The URL for the target documentation.
810 , _externalDocsUrl :: URL
586 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
587+ } deriving (Eq, Show, Generic)
813−instance Hashable ExternalDocs
815-- | A simple object to allow referencing other definitions in the specification.
589-- | 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.
590-- It can be used to reference parameters and responses that are defined at the top level for reuse.
817newtype Reference = Reference { getReference :: Text }
591newtype Reference = Reference { getReference :: Text }
818− deriving (Eq, Show, Data, Typeable)
592+ deriving (Eq, Show)
820data Referenced a
594data Referenced a
821 = Ref Reference
595 = Ref Reference
822 | Inline a
596 | Inline a
823− deriving (Eq, Show, Functor, Data, Typeable)
597+ 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)
830−data AdditionalProperties
599+newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
831− = AdditionalPropertiesAllowed Bool
832− | AdditionalPropertiesSchema (Referenced Schema)
833− deriving (Eq, Show, Data, Typeable)
835-- =======================================================================
601-- =======================================================================
836-- Monoid instances
602-- Monoid instances
837-- =======================================================================
603-- =======================================================================
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841instance Monoid Swagger where
605instance Monoid Swagger where
842 mempty = genericMempty
606 mempty = genericMempty
843− mappend = (<>)
607+ mappend = genericMappend
845−instance Semigroup Info where
846− (<>) = genericMappend
847instance Monoid Info where
609instance Monoid Info where
848 mempty = genericMempty
610 mempty = genericMempty
849− mappend = (<>)
611+ mappend = genericMappend
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
613+instance Monoid Paths where
854 mempty = genericMempty
614 mempty = genericMempty
855− mappend = (<>)
615+ mappend = genericMappend
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859instance Monoid PathItem where
617instance Monoid PathItem where
860 mempty = genericMempty
618 mempty = genericMempty
861− mappend = (<>)
619+ mappend = genericMappend
863−instance Semigroup Schema where
864− (<>) = genericMappend
865instance Monoid Schema where
621instance Monoid Schema where
866 mempty = genericMempty
622 mempty = genericMempty
867− mappend = (<>)
623+ mappend = genericMappend
869−instance Semigroup (ParamSchema t) where
625+instance SwaggerMonoid t => Monoid (SchemaCommon t i) where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
872 mempty = genericMempty
626 mempty = genericMempty
873− mappend = (<>)
627+ mappend = genericMappend
875−instance Semigroup Param where
876− (<>) = genericMappend
877instance Monoid Param where
629instance Monoid Param where
878 mempty = genericMempty
630 mempty = genericMempty
879− mappend = (<>)
631+ mappend = genericMappend
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883instance Monoid ParamOtherSchema where
633instance Monoid ParamOtherSchema where
884 mempty = genericMempty
634 mempty = genericMempty
887−instance Semigroup Header where
888− (<>) = genericMappend
635+ mappend = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
893−instance Semigroup Responses where
894− (<>) = genericMappend
895instance Monoid Responses where
637instance Monoid Responses where
896 mempty = genericMempty
638 mempty = genericMempty
897− mappend = (<>)
639+ mappend = genericMappend
899−instance Semigroup Response where
900− (<>) = genericMappend
901instance Monoid Response where
641instance Monoid Response where
902 mempty = genericMempty
642 mempty = genericMempty
903− mappend = (<>)
643+ mappend = genericMappend
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907instance Monoid ExternalDocs where
645instance Monoid ExternalDocs where
908 mempty = genericMempty
646 mempty = genericMempty
909− mappend = (<>)
647+ mappend = genericMappend
911−instance Semigroup Operation where
912− (<>) = genericMappend
913instance Monoid Operation where
649instance Monoid Operation where
914 mempty = genericMempty
650 mempty = genericMempty
917−instance Semigroup Example where
918− (<>) = genericMappend
651+ 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-- =======================================================================
653-- =======================================================================
935-- SwaggerMonoid helper instances
654-- SwaggerMonoid helper instances
936-- =======================================================================
655-- =======================================================================
938instance SwaggerMonoid Info
657instance SwaggerMonoid Info
658+instance SwaggerMonoid Paths
939instance SwaggerMonoid PathItem
659instance SwaggerMonoid PathItem
940instance SwaggerMonoid Schema
660instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
661+instance SwaggerMonoid t => SwaggerMonoid (SchemaCommon t i)
942instance SwaggerMonoid Param
662instance SwaggerMonoid Param
943instance SwaggerMonoid ParamOtherSchema
663instance SwaggerMonoid ParamOtherSchema
944instance SwaggerMonoid Responses
664instance SwaggerMonoid Responses
945instance SwaggerMonoid Response
665instance SwaggerMonoid Response
946instance SwaggerMonoid ExternalDocs
666instance SwaggerMonoid ExternalDocs
947instance SwaggerMonoid Operation
667instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
951instance SwaggerMonoid MimeList
669instance SwaggerMonoid MimeList
952deriving instance SwaggerMonoid URL
670deriving instance SwaggerMonoid URL
954−instance SwaggerMonoid (SwaggerType t) where
672+instance SwaggerMonoid SchemaType where
673+ swaggerMempty = SchemaNull
674+ swaggerMappend _ y = y
676+instance SwaggerMonoid ParamType where
955− swaggerMempty = SwaggerString
677+ swaggerMempty = ParamString
956 swaggerMappend _ y = y
678 swaggerMappend _ y = y
958instance SwaggerMonoid ParamLocation where
680instance SwaggerMonoid ParamLocation where
959 swaggerMempty = ParamQuery
681 swaggerMempty = ParamQuery
960 swaggerMappend _ y = y
682 swaggerMappend _ y = y
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
684+instance SwaggerMonoid (HashMap Text Schema) where
963− swaggerMempty = InsOrdHashMap.empty
685+ swaggerMempty = HashMap.empty
964− swaggerMappend = InsOrdHashMap.unionWith mappend
686+ swaggerMappend = HashMap.unionWith mappend
688+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
689+ swaggerMempty = HashMap.empty
690+ swaggerMappend = HashMap.unionWith swaggerMappend
966instance Monoid a => SwaggerMonoid (Referenced a) where
692instance Monoid a => SwaggerMonoid (Referenced a) where
967 swaggerMempty = Inline mempty
693 swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
694+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
969 swaggerMappend _ y = y
695 swaggerMappend _ y = y
971−instance SwaggerMonoid ParamAnySchema where
697+instance SwaggerMonoid (HashMap Text Param) where
972− swaggerMempty = ParamOther swaggerMempty
698+ swaggerMempty = HashMap.empty
973− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
699+ 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
701+instance SwaggerMonoid (HashMap Text Response) where
985− toJSON = genericToJSON (jsonPrefix "Info")
702+ swaggerMempty = HashMap.empty
703+ swaggerMappend = flip HashMap.union
987−instance ToJSON Contact where
705+instance SwaggerMonoid (HashMap Text SecurityScheme) where
988− toJSON = genericToJSON (jsonPrefix "Contact")
706+ swaggerMempty = HashMap.empty
707+ swaggerMappend = flip HashMap.union
990−instance ToJSON License where
709+instance SwaggerMonoid (HashMap FilePath PathItem) where
991− toJSON = genericToJSON (jsonPrefix "License")
710+ swaggerMempty = HashMap.empty
711+ swaggerMappend = HashMap.unionWith mappend
993−instance ToJSON ApiKeyLocation where
713+instance SwaggerMonoid (HashMap HeaderName Header) where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
714+ swaggerMempty = HashMap.empty
715+ swaggerMappend = flip HashMap.union
996−instance ToJSON ApiKeyParams where
717+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
718+ swaggerMempty = HashMap.empty
719+ swaggerMappend = flip HashMap.union
999−instance ToJSON Scheme where
721+instance SwaggerMonoid ParamSchema where
1000− toJSON = genericToJSON (jsonPrefix "")
722+ swaggerMempty = ParamOther swaggerMempty
1001−
723+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
1002−instance ToJSON Tag where
724+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
1003− toJSON = genericToJSON (jsonPrefix "Tag")
725+ swaggerMappend _ y = y
1005−instance ToJSON ExternalDocs where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
1011-- =======================================================================
727-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
728+-- TH derived ToJSON and FromJSON instances
1013-- =======================================================================
729-- =======================================================================
1015−instance FromJSON ParamLocation where
731+deriveJSON (jsonPrefix "Param") ''ParamLocation
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
732+deriveJSON (jsonPrefix "Param") ''ParamType
1017−
733+deriveJSON' ''Info
1018−instance FromJSON Info where
734+deriveJSON' ''Contact
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
735+deriveJSON' ''License
1020−
736+deriveJSON (jsonPrefix "Schema") ''SchemaType
1021−instance FromJSON Contact where
737+deriveJSON (jsonPrefix "Items") ''ItemsType
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
738+deriveJSON (jsonPrefix "ItemsCollection") ''ItemsCollectionFormat
1023−
739+deriveJSON (jsonPrefix "Collection") ''CollectionFormat
1024−instance FromJSON License where
740+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
1025− parseJSON = genericParseJSON (jsonPrefix "License")
741+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
1026−
742+deriveJSON' ''SchemaCommon
1027−instance FromJSON ApiKeyLocation where
743+deriveJSONDefault ''Scheme
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
744+deriveJSON' ''Tag
1029−
745+deriveJSON' ''ExternalDocs
1030−instance FromJSON ApiKeyParams where
746+
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
747+deriveToJSON' ''Operation
1032−
748+deriveToJSON' ''Response
1033−instance FromJSON Scheme where
749+deriveToJSON' ''PathItem
1034− parseJSON = genericParseJSON (jsonPrefix "")
750+deriveToJSON' ''Xml
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
1042-- =======================================================================
752-- =======================================================================
1043-- Manual ToJSON instances
753-- Manual ToJSON instances
@@ -1059,8 +769,7 @@ instance ToJSON OAuth2Flow where
1059 , "tokenUrl" .= tokenUrl ]
769 , "tokenUrl" .= tokenUrl ]
1061instance ToJSON OAuth2Params where
771instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
772+ toJSON = genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1065instance ToJSON SecuritySchemeType where
774instance ToJSON SecuritySchemeType where
1066 toJSON SecuritySchemeBasic
775 toJSON SecuritySchemeBasic
@@ -1073,38 +782,22 @@ instance ToJSON SecuritySchemeType where
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
782 <+> object [ "type" .= ("oauth2" :: Text) ]
1075instance ToJSON Swagger where
784instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
785+ toJSON = addVersion . genericToJSON (jsonPrefix "")
1077− DEFINE_TOENCODING
786+ where
787+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
788+ addVersion _ = error "impossible"
1079instance ToJSON SecurityScheme where
790instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
791+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1083instance ToJSON Schema where
793instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
794+ toJSON = genericToJSONWithSub "schemaCommon" (jsonPrefix "schema")
1087instance ToJSON Header where
796instance ToJSON Header where
1088− toJSON = sopSwaggerGenericToJSON
797+ toJSON = genericToJSONWithSub "common" (jsonPrefix "header")
1089− DEFINE_TOENCODING
798+
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
799+instance ToJSON Items where
1098− toJSON (SwaggerItemsPrimitive fmt schema) = object
800+ toJSON = genericToJSONWithSub "common" (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
802instance ToJSON Host where
1110 toJSON (Host host mport) = toJSON $
803 toJSON (Host host mport) = toJSON $
@@ -1112,79 +805,38 @@ instance ToJSON Host where
1112 Nothing -> host
805 Nothing -> host
1113 Just port -> host ++ ":" ++ show port
806 Just port -> host ++ ":" ++ show port
808+instance ToJSON Paths where
809+ toJSON (Paths m) = toJSON m
1115instance ToJSON MimeList where
811instance ToJSON MimeList where
1116 toJSON (MimeList xs) = toJSON (map show xs)
812 toJSON (MimeList xs) = toJSON (map show xs)
1118instance ToJSON Param where
814instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
815+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1122−instance ToJSON ParamAnySchema where
817+instance ToJSON ParamSchema where
1123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
818 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124 toJSON (ParamOther s) = toJSON s
819 toJSON (ParamOther s) = toJSON s
1126instance ToJSON ParamOtherSchema where
821instance ToJSON ParamOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
822+ toJSON = genericToJSONWithSub "common" (jsonPrefix "paramOtherSchema")
1130−instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1134−instance ToJSON Response where
1135− toJSON = sopSwaggerGenericToJSON
1138−instance ToJSON Operation where
824+instance ToJSON SchemaItems where
1139− toJSON = sopSwaggerGenericToJSON
825+ toJSON (SchemaItemsObject x) = toJSON x
1140− DEFINE_TOENCODING
826+ toJSON (SchemaItemsArray xs) = toJSON xs
1142−instance ToJSON PathItem where
828+instance ToJSON Responses where
1143− toJSON = sopSwaggerGenericToJSON
829+ toJSON (Responses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1146instance ToJSON Example where
831instance ToJSON Example where
1147 toJSON = toJSON . Map.mapKeys show . getExample
832 toJSON = toJSON . Map.mapKeys show . getExample
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1152instance ToJSON Reference where
834instance ToJSON Reference where
1153 toJSON (Reference ref) = object [ "$ref" .= ref ]
835 toJSON (Reference ref) = object [ "$ref" .= ref ]
1155−referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
837+instance ToJSON a => ToJSON (Referenced a) where
1156−referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
838+ toJSON (Ref ref) = toJSON ref
1157−referencedToJSON _ (Inline x) = toJSON x
839+ 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/"
1163−instance ToJSON (SwaggerType t) where
1164− toJSON SwaggerArray = "array"
1165− toJSON SwaggerString = "string"
1166− toJSON SwaggerInteger = "integer"
1167− toJSON SwaggerNumber = "number"
1168− toJSON SwaggerBoolean = "boolean"
1169− toJSON SwaggerFile = "file"
1170− toJSON SwaggerNull = "null"
1171− toJSON SwaggerObject = "object"
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"
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-- =======================================================================
841-- =======================================================================
1190-- Manual FromJSON instances
842-- Manual FromJSON instances
@@ -1204,7 +856,7 @@ instance FromJSON OAuth2Flow where
1204 parseJSON _ = empty
856 parseJSON _ = empty
1206instance FromJSON OAuth2Params where
858instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
859+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1209instance FromJSON SecuritySchemeType where
861instance FromJSON SecuritySchemeType where
1210 parseJSON js@(Object o) = do
862 parseJSON js@(Object o) = do
@@ -1217,67 +869,55 @@ instance FromJSON SecuritySchemeType where
1217 parseJSON _ = empty
869 parseJSON _ = empty
1219instance FromJSON Swagger where
871instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
872+ parseJSON js@(Object o) = do
873+ (version :: Text) <- o .: "swagger"
874+ when (version /= "2.0") empty
875+ (genericParseJSON (jsonPrefix "")
876+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
877+ , "produces" .= (mempty :: MimeList)
878+ , "security" .= ([] :: [SecurityRequirement])
879+ , "tags" .= ([] :: [Tag])
880+ , "definitions" .= (mempty :: HashMap Text Schema)
881+ , "parameters" .= (mempty :: HashMap Text Param)
882+ , "responses" .= (mempty :: HashMap Text Response)
883+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
1222instance FromJSON SecurityScheme where
887instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
888+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1225instance FromJSON Schema where
890instance FromJSON Schema where
1226− parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
891+ parseJSON = genericParseJSONWithSub "schemaCommon" (jsonPrefix "schema")
1227− where nullaryCleanup :: Schema -> Schema
892+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1228− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
893+ , "required" .= ([] :: [ParamName]) ]
1229− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230− then s { _schemaExample = Nothing
1231− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1234instance FromJSON Header where
895instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
896+ parseJSON = genericParseJSONWithSub "common" (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
898+instance FromJSON Items where
1243− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
899+ parseJSON = genericParseJSONWithSub "common" (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
901instance FromJSON Host where
1266− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
902+ parseJSON (String s) =
1267− [host] -> return $ Host host Nothing
903+ case fromInteger <$> readMaybe portStr of
1268− [host, port] -> case readMaybe port of
904+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1269− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
905+ mport -> pure $ Host host mport
1270− Just p -> return $ Host host (Just (fromInteger p))
906+ where
1271− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
907+ (hostText, portText) = Text.breakOn ":" s
908+ [host, portStr] = map Text.unpack [hostText, portText]
1272 parseJSON _ = empty
909 parseJSON _ = empty
911+instance FromJSON Paths where
912+ parseJSON js = Paths <$> parseJSON js
1274instance FromJSON MimeList where
914instance FromJSON MimeList where
1275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
915 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1277instance FromJSON Param where
917instance FromJSON Param where
1278− parseJSON = sopSwaggerGenericParseJSON
918+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1280−instance FromJSON ParamAnySchema where
920+instance FromJSON ParamSchema where
1281 parseJSON js@(Object o) = do
921 parseJSON js@(Object o) = do
1282 (i :: Text) <- o .: "in"
922 (i :: Text) <- o .: "in"
1283 case i of
923 case i of
@@ -1288,12 +928,17 @@ instance FromJSON ParamAnySchema where
1288 parseJSON _ = empty
928 parseJSON _ = empty
1290instance FromJSON ParamOtherSchema where
930instance FromJSON ParamOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
931+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "paramOtherSchema")
933+instance FromJSON SchemaItems where
934+ parseJSON js@(Object _) = SchemaItemsObject <$> parseJSON js
935+ parseJSON js@(Array _) = SchemaItemsArray <$> parseJSON js
1293instance FromJSON Responses where
938instance FromJSON Responses where
1294 parseJSON (Object o) = Responses
939 parseJSON (Object o) = Responses
1295 <$> o .:? "default"
940 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
941+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1297 parseJSON _ = empty
942 parseJSON _ = empty
1299instance FromJSON Example where
944instance FromJSON Example where
@@ -1302,126 +947,26 @@ instance FromJSON Example where
1302 pure $ Example (Map.mapKeys fromString m)
947 pure $ Example (Map.mapKeys fromString m)
1304instance FromJSON Response where
949instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
950+ parseJSON = genericParseJSON (jsonPrefix "response")
951+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1307instance FromJSON Operation where
953instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
954+ parseJSON = genericParseJSON (jsonPrefix "operation")
955+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1310instance FromJSON PathItem where
957instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
958+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1312−
959+ `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1316instance FromJSON Reference where
961instance FromJSON Reference where
1317 parseJSON (Object o) = Reference <$> o .: "$ref"
962 parseJSON (Object o) = Reference <$> o .: "$ref"
1318 parseJSON _ = empty
963 parseJSON _ = empty
1320−referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
965+instance FromJSON a => FromJSON (Referenced a) where
1321−referencedParseJSON prefix js@(Object o) = do
1324− Nothing -> Inline <$> parseJSON js
966+ parseJSON js
1325− Just s -> Ref <$> parseRef s
967+ = Ref <$> parseJSON js
1326− where
968+ <|> 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
970instance FromJSON Xml where
1338 parseJSON = genericParseJSON (jsonPrefix "xml")
971 parseJSON = genericParseJSON (jsonPrefix "xml")
1340−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1341− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1343−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1344− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1346−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1347− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1349−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) 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]
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
1366−instance FromJSON AdditionalProperties where
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