@@ -1,140 +1,96 @@
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.Foldable (Foldable)
32−import Data.Hashable (Hashable)
17+import Data.HashMap.Strict (HashMap)
33import qualified Data.HashMap.Strict as HashMap
18import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
35import Data.Map (Map)
19import Data.Map (Map)
36import qualified Data.Map as Map
20import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
21+import Data.Monoid
38−import Data.Semigroup.Compat (Semigroup (..))
39−import 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
25+import Data.Traversable (Traversable)
26+import Data.Hashable (Hashable)
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 Parameter
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.
@@ -245,14 +189,14 @@ data PathItem = PathItem
245 -- These parameters can be overridden at the operation level, but cannot be removed there.
189 -- These parameters can be overridden at the operation level, but cannot be removed there.
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 Parameter]
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.
@@ -286,7 +230,7 @@ data Operation = Operation
286 -- the new definition will override it, but can never remove it.
230 -- the new definition will override it, but can never remove it.
287 -- The list MUST NOT include duplicated parameters.
231 -- The list MUST NOT include duplicated parameters.
288 -- A unique parameter is defined by a combination of a name and location.
232 -- A unique parameter is defined by a combination of a name and location.
289− , _operationParameters :: [Referenced Param]
233+ , _operationParameters :: [Referenced Parameter]
291 -- | The list of possible responses as they are returned from executing this operation.
235 -- | The list of possible responses as they are returned from executing this operation.
292 , _operationResponses :: Responses
236 , _operationResponses :: Responses
@@ -306,205 +250,88 @@ 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.
329−data Param = Param
260+data Parameter = Parameter
330 { -- | The name of the parameter.
261 { -- | The name of the parameter.
331 -- Parameter names are case sensitive.
262 -- Parameter names are case sensitive.
332− _paramName :: Text
263+ _parameterName :: Text
334 -- | A brief description of the parameter.
265 -- | A brief description of the parameter.
335 -- This could contain examples of use.
266 -- This could contain examples of use.
336 -- GFM syntax can be used for rich text representation.
267 -- GFM syntax can be used for rich text representation.
337− , _paramDescription :: Maybe Text
268+ , _parameterDescription :: Maybe Text
339 -- | Determines whether this parameter is mandatory.
270 -- | Determines whether this parameter is mandatory.
340 -- If the parameter is in "path", this property is required and its value MUST be true.
271 -- If the parameter is in "path", this property is required and its value MUST be true.
341 -- Otherwise, the property MAY be included and its default value is @False@.
272 -- Otherwise, the property MAY be included and its default value is @False@.
342− , _paramRequired :: Maybe Bool
273+ , _parameterRequired :: Maybe Bool
344 -- | Parameter schema.
275 -- | Parameter schema.
345− , _paramSchema :: ParamAnySchema
276+ , _parameterSchema :: ParameterSchema
346− } deriving (Eq, Show, Generic, Data, Typeable)
277+ } deriving (Eq, Show, Generic)
348−data ParamAnySchema
279+data ParameterSchema
349− = ParamBody (Referenced Schema)
280+ = ParameterBody (Referenced Schema)
350− | ParamOther ParamOtherSchema
281+ | ParameterOther ParameterOtherSchema
351− deriving (Eq, Show, Generic, Data, Typeable)
282+ deriving (Eq, Show)
353−data ParamOtherSchema = ParamOtherSchema
284+data ParameterOtherSchema = ParameterOtherSchema
354 { -- | The location of the parameter.
285 { -- | The location of the parameter.
355− _paramOtherSchemaIn :: ParamLocation
286+ _parameterOtherSchemaIn :: ParameterLocation
288+ -- | The type of the parameter.
289+ -- Since the parameter is not located at the request body,
290+ -- it is limited to simple types (that is, not an object).
291+ -- If type is @'ParamFile'@, the @consumes@ MUST be either
292+ -- "multipart/form-data" or " application/x-www-form-urlencoded"
293+ -- and the parameter MUST be in @'ParameterFormData'@.
294+ , _parameterOtherSchemaType :: ParameterType
296+ -- | The extending format for the previously mentioned type.
297+ , _parameterOtherSchemaFormat :: Maybe Format
357 -- | Sets the ability to pass empty-valued parameters.
299 -- | Sets the ability to pass empty-valued parameters.
358− -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
300+ -- This is valid only for either @'ParameterQuery'@ or @'ParameterFormData'@
359 -- and allows you to send a parameter with a name only or an empty value.
301 -- and allows you to send a parameter with a name only or an empty value.
360 -- Default value is @False@.
302 -- Default value is @False@.
361− , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
303+ , _parameterOtherSchemaAllowEmptyValue :: Maybe Bool
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
305+ -- | __Required if type is @'ParamArray'@__.
364− } deriving (Eq, Show, Generic, Typeable, Data)
306+ -- Describes the type of items in the array.
365−
307+ , _parameterOtherSchemaItems :: Maybe Items
366−-- | Items for @'SwaggerArray'@ schemas.
308+
367−--
309+ -- | Determines the format of the array if @'ParamArray'@ is used.
368−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
310+ -- Default value is csv.
369−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
311+ , _parameterOtherSchemaCollectionFormat :: Maybe CollectionFormat
370−-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
312+
371−-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
313+ , _parameterOtherSchemaCommon :: SchemaCommon
372−--
314+ } deriving (Eq, Show, Generic)
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
315+
374−--
316+data ParameterType
375−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
317+ = ParamString
376−data SwaggerItems t where
318+ | ParamNumber
377− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
319+ | ParamInteger
378− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
320+ | ParamBoolean
379− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
321+ | ParamArray
380− deriving (Typeable)
322+ | ParamFile
381−
323+ deriving (Eq, Show)
382−deriving instance Eq (SwaggerItems t)
324+
383−deriving instance Show (SwaggerItems t)
325+data ParameterLocation
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
499 = -- | Parameters that are appended to the URL.
326 = -- | Parameters that are appended to the URL.
500 -- For example, in @/items?id=###@, the query parameter is @id@.
327 -- For example, in @/items?id=###@, the query parameter is @id@.
501− ParamQuery
328+ ParameterQuery
502 -- | Custom headers that are expected as part of the request.
329 -- | Custom headers that are expected as part of the request.
503− | ParamHeader
330+ | ParameterHeader
504 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
331 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
505 -- This does not include the host or base path of the API.
332 -- This does not include the host or base path of the API.
506 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
333 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
507− | ParamPath
334+ | ParameterPath
508 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
335 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
509 -- or @multipart/form-data@ are used as the content type of the request
336 -- or @multipart/form-data@ are used as the content type of the request
510 -- (in Swagger's definition, the @consumes@ property of an operation).
337 -- (in Swagger's definition, the @consumes@ property of an operation).
@@ -512,57 +339,61 @@ data ParamLocation
512 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
339 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
513 -- Form parameters have a different format based on the content-type used
340 -- 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>).
341 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
515− | ParamFormData
342+ | ParameterFormData
516− deriving (Eq, Show, Generic, Data, Typeable)
343+ deriving (Eq, Show)
518type Format = Text
345type Format = Text
520-- | Determines the format of the array.
347-- | Determines the format of the array.
521−data CollectionFormat t where
348+data CollectionFormat
522− -- Comma separated values: @foo,bar@.
349+ = CollectionCSV -- ^ Comma separated values: @foo,bar@.
523− CollectionCSV :: CollectionFormat t
524− -- Space separated values: @foo bar@.
350+ | CollectionSSV -- ^ Space separated values: @foo bar@.
525− CollectionSSV :: CollectionFormat t
526− -- Tab separated values: @foo\\tbar@.
351+ | CollectionTSV -- ^ Tab separated values: @foo\\tbar@.
527− CollectionTSV :: CollectionFormat t
528− -- Pipe separated values: @foo|bar@.
352+ | CollectionPipes -- ^ Pipe separated values: @foo|bar@.
529− CollectionPipes :: CollectionFormat t
530− -- Corresponds to multiple parameter instances
353+ | CollectionMulti -- ^ Corresponds to multiple parameter instances
531− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
354+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532− -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
355+ -- This is valid only for parameters in @'ParameterQuery'@ or @'ParameterFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
356+ deriving (Eq, Show)
534− deriving (Typeable)
357+
536−deriving instance Eq (CollectionFormat t)
359+ = ItemsString
537−deriving instance Show (CollectionFormat t)
364+ deriving (Eq, Show)
539−collectionFormatConstr :: CollectionFormat t -> Constr
366+data SchemaType
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
367+ = SchemaArray
542−collectionFormatDataType :: DataType
369+ | SchemaInteger
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
370+ | SchemaNumber
544− map collectionFormatConstr collectionCommonFormats
371+ | SchemaNull
546−collectionCommonFormats :: [CollectionFormat t]
373+ | SchemaString
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
374+ deriving (Eq, Show)
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
376+-- | Determines the format of the nested array.
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
377+data ItemsCollectionFormat
551− toConstr = collectionFormatConstr
378+ = ItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
552− dataTypeOf _ = collectionFormatDataType
379+ | ItemsCollectionSSV -- ^ Space separated values: @foo bar@.
553−
380+ | ItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
381+ | ItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
556type ParamName = Text
384type ParamName = Text
558data Schema = Schema
386data Schema = Schema
387+ { _schemaType :: SchemaType
388+ , _schemaFormat :: Maybe Format
559− { _schemaTitle :: Maybe Text
389+ , _schemaTitle :: Maybe Text
560 , _schemaDescription :: Maybe Text
390 , _schemaDescription :: Maybe Text
561 , _schemaRequired :: [ParamName]
391 , _schemaRequired :: [ParamName]
393+ , _schemaItems :: Maybe SchemaItems
563− , _schemaAllOf :: Maybe [Referenced Schema]
394+ , _schemaAllOf :: Maybe [Schema]
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
395+ , _schemaProperties :: HashMap Text (Referenced Schema)
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
396+ , _schemaAdditionalProperties :: Maybe Schema
567 , _schemaDiscriminator :: Maybe Text
398 , _schemaDiscriminator :: Maybe Text
568 , _schemaReadOnly :: Maybe Bool
399 , _schemaReadOnly :: Maybe Bool
@@ -573,49 +404,39 @@ data Schema = Schema
573 , _schemaMaxProperties :: Maybe Integer
404 , _schemaMaxProperties :: Maybe Integer
574 , _schemaMinProperties :: Maybe Integer
405 , _schemaMinProperties :: Maybe Integer
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
407+ , _schemaSchemaCommon :: SchemaCommon
577− } deriving (Eq, Show, Generic, Data, Typeable)
408+ } deriving (Eq, Show, Generic)
579−-- | A @'Schema'@ with an optional name.
410+data SchemaItems
580−-- This name can be used in references.
411+ = SchemaItemsObject (Referenced Schema)
581−data NamedSchema = NamedSchema
412+ | SchemaItemsArray [Referenced Schema]
582− { _namedSchemaName :: Maybe Text
583− , _namedSchemaSchema :: Schema
584− } deriving (Eq, Show, Generic, Data, Typeable)
413+ deriving (Eq, Show)
586−-- | Regex pattern for @string@ type.
415+data SchemaCommon = SchemaCommon
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
590 { -- | Declares the value of the parameter that the server will use if none is provided,
416 { -- | 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@
417 -- 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.
418 -- if not supplied by the client in the request.
593 -- (Note: "default" has no meaning for required parameters.)
419 -- (Note: "default" has no meaning for required parameters.)
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
420 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595− _paramSchemaDefault :: Maybe Value
421+ _schemaCommonDefault :: Maybe Value
597− , _paramSchemaType :: Maybe (SwaggerType t)
423+ , _schemaCommonMaximum :: Maybe Integer
598− , _paramSchemaFormat :: Maybe Format
424+ , _schemaCommonExclusiveMaximum :: Maybe Bool
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
425+ , _schemaCommonMinimum :: Maybe Integer
600− , _paramSchemaMaximum :: Maybe Scientific
426+ , _schemaCommonExclusiveMinimum :: Maybe Bool
601− , _paramSchemaExclusiveMaximum :: Maybe Bool
427+ , _schemaCommonMaxLength :: Maybe Integer
602− , _paramSchemaMinimum :: Maybe Scientific
428+ , _schemaCommonMinLength :: Maybe Integer
603− , _paramSchemaExclusiveMinimum :: Maybe Bool
429+ , _schemaCommonPattern :: Maybe Text
604− , _paramSchemaMaxLength :: Maybe Integer
430+ , _schemaCommonMaxItems :: Maybe Integer
605− , _paramSchemaMinLength :: Maybe Integer
431+ , _schemaCommonMinItems :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
432+ , _schemaCommonUniqueItems :: Maybe Bool
607− , _paramSchemaMaxItems :: Maybe Integer
433+ , _schemaCommonEnum :: Maybe [Value]
608− , _paramSchemaMinItems :: Maybe Integer
434+ , _schemaCommonMultipleOf :: Maybe Integer
609− , _paramSchemaUniqueItems :: Maybe Bool
610− , _paramSchemaEnum :: Maybe [Value]
611− , _paramSchemaMultipleOf :: Maybe Scientific
612− } deriving (Eq, Show, Generic, Typeable)
435+ } deriving (Eq, Show, Generic)
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
616data Xml = Xml
437data Xml = Xml
617 { -- | Replaces the name of the element/attribute used for the described schema property.
438 { -- | 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.
439+ -- 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),
440 -- When defined alongside type being array (outside the items),
620 -- it will affect the wrapping element and only if wrapped is true.
441 -- it will affect the wrapping element and only if wrapped is true.
621 -- If wrapped is false, it will be ignored.
442 -- If wrapped is false, it will be ignored.
@@ -639,7 +460,25 @@ data Xml = Xml
639 -- Default value is @False@.
460 -- Default value is @False@.
640 -- The definition takes effect only when defined alongside type being array (outside the items).
461 -- The definition takes effect only when defined alongside type being array (outside the items).
641 , _xmlWrapped :: Maybe Bool
462 , _xmlWrapped :: Maybe Bool
642− } deriving (Eq, Show, Generic, Data, Typeable)
463+ } deriving (Eq, Show, Generic)
466+ { -- | The internal type of the array.
467+ _itemsType :: ItemsType
469+ -- | The extending format for the previously mentioned type.
470+ , _itemsFormat :: Maybe Format
472+ -- | __Required if type is @'ItemsArray'@.__
473+ -- Describes the type of items in the array.
474+ , _itemsItems :: Maybe Items
476+ -- | Determines the format of the array if type array is used.
477+ -- Default value is @'ItemsCollectionCSV'@.
478+ , _itemsCollectionFormat :: Maybe ItemsCollectionFormat
480+ , _itemsCommon :: SchemaCommon
481+ } deriving (Eq, Show, Generic)
644-- | A container for the expected responses of an operation.
483-- | A container for the expected responses of an operation.
645-- The container maps a HTTP response code to the expected response.
484-- The container maps a HTTP response code to the expected response.
@@ -653,8 +492,8 @@ data Responses = Responses
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
493 -- | 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.
494 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
495+ , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
657− } deriving (Eq, Show, Generic, Data, Typeable)
496+ } deriving (Eq, Show, Generic)
659type HttpStatusCode = Int
498type HttpStatusCode = Int
@@ -672,14 +511,11 @@ data Response = Response
672 , _responseSchema :: Maybe (Referenced Schema)
511 , _responseSchema :: Maybe (Referenced Schema)
674 -- | A list of headers that are sent with the response.
513 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
514+ , _responseHeaders :: HashMap HeaderName Header
677 -- | An example of the response message.
516 -- | An example of the response message.
678 , _responseExamples :: Maybe Example
517 , _responseExamples :: Maybe Example
679− } deriving (Eq, Show, Generic, Data, Typeable)
518+ } deriving (Eq, Show, Generic)
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
684type HeaderName = Text
520type HeaderName = Text
@@ -687,30 +523,31 @@ data Header = Header
687 { -- | A short description of the header.
523 { -- | A short description of the header.
688 _headerDescription :: Maybe Text
524 _headerDescription :: Maybe Text
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
526+ -- | The type of the object.
691− } deriving (Eq, Show, Generic, Data, Typeable)
527+ , _headerType :: ItemsType
693−data Example = Example { getExample :: Map MediaType Value }
529+ -- | The extending format for the previously mentioned type. See Data Type Formats for further details.
694− deriving (Eq, Show, Generic, Typeable)
530+ , _headerFormat :: Maybe Format
696−exampleConstr :: Constr
532+ -- | __Required if type is @'ItemsArray'@__.
697−exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
533+ -- Describes the type of items in the array.
534+ , _headerItems :: Maybe Items
699−exampleDataType :: DataType
536+ -- | Determines the format of the array if type array is used.
700−exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
537+ -- Default value is @'ItemsCollectionCSV'@.
538+ , _headerCollectionFormat :: Maybe ItemsCollectionFormat
702−instance Data Example where
540+ , _headerCommon :: SchemaCommon
703− gunfold k z c = case constrIndex c of
541+ } deriving (Eq, Show, Generic)
704− 1 -> k (z (\m -> Example (Map.mapKeys fromString m)))
542+
705− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Example."
543+data Example = Example { getExample :: Map MediaType Value }
706− toConstr (Example _) = exampleConstr
544+ deriving (Eq, Show)
707− dataTypeOf _ = exampleDataType
709-- | The location of the API key.
546-- | The location of the API key.
710data ApiKeyLocation
547data ApiKeyLocation
711 = ApiKeyQuery
548 = ApiKeyQuery
712 | ApiKeyHeader
549 | ApiKeyHeader
713− deriving (Eq, Show, Generic, Data, Typeable)
550+ deriving (Eq, Show)
715data ApiKeyParams = ApiKeyParams
552data ApiKeyParams = ApiKeyParams
716 { -- | The name of the header or query parameter to be used.
553 { -- | The name of the header or query parameter to be used.
@@ -718,7 +555,7 @@ data ApiKeyParams = ApiKeyParams
719 -- | The location of the API key.
556 -- | The location of the API key.
720 , _apiKeyIn :: ApiKeyLocation
557 , _apiKeyIn :: ApiKeyLocation
721− } deriving (Eq, Show, Generic, Data, Typeable)
558+ } deriving (Eq, Show)
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
560-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
724type AuthorizationURL = Text
561type AuthorizationURL = Text
@@ -731,21 +568,21 @@ data OAuth2Flow
731 | OAuth2Password TokenURL
568 | OAuth2Password TokenURL
732 | OAuth2Application TokenURL
569 | OAuth2Application TokenURL
733 | OAuth2AccessCode AuthorizationURL TokenURL
570 | OAuth2AccessCode AuthorizationURL TokenURL
734− deriving (Eq, Show, Generic, Data, Typeable)
571+ deriving (Eq, Show)
736data OAuth2Params = OAuth2Params
573data OAuth2Params = OAuth2Params
737 { -- | The flow used by the OAuth2 security scheme.
574 { -- | The flow used by the OAuth2 security scheme.
738 _oauth2Flow :: OAuth2Flow
575 _oauth2Flow :: OAuth2Flow
740 -- | The available scopes for the OAuth2 security scheme.
577 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
578+ , _oauth2Scopes :: HashMap Text Text
742− } deriving (Eq, Show, Generic, Data, Typeable)
579+ } deriving (Eq, Show, Generic)
744data SecuritySchemeType
581data SecuritySchemeType
745 = SecuritySchemeBasic
582 = SecuritySchemeBasic
746 | SecuritySchemeApiKey ApiKeyParams
583 | SecuritySchemeApiKey ApiKeyParams
747 | SecuritySchemeOAuth2 OAuth2Params
584 | SecuritySchemeOAuth2 OAuth2Params
748− deriving (Eq, Show, Generic, Data, Typeable)
585+ deriving (Eq, Show)
750data SecurityScheme = SecurityScheme
587data SecurityScheme = SecurityScheme
751 { -- | The type of the security scheme.
588 { -- | The type of the security scheme.
@@ -753,39 +590,20 @@ data SecurityScheme = SecurityScheme
754 -- | A short description for security scheme.
591 -- | A short description for security scheme.
755 , _securitySchemeDescription :: Maybe Text
592 , _securitySchemeDescription :: Maybe Text
756− } deriving (Eq, Show, Generic, Data, Typeable)
593+ } 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.
595-- | Lists the required security schemes to execute this operation.
775-- The object can have multiple security schemes declared in it which are all required
596-- 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).
597-- (that is, there is a logical AND between the schemes).
777newtype SecurityRequirement = SecurityRequirement
598newtype SecurityRequirement = SecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
599+ { getSecurityRequirement :: HashMap Text [Text]
779− } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
600+ } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
784-- | Allows adding meta data to a single tag that is used by @Operation@.
602-- | 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.
603-- It is not mandatory to have a @Tag@ per tag used there.
786data Tag = Tag
604data Tag = Tag
787 { -- | The name of the tag.
605 { -- | The name of the tag.
788− _tagName :: TagName
606+ _tagName :: Text
790 -- | A short description for the tag.
608 -- | A short description for the tag.
791 -- GFM syntax can be used for rich text representation.
609 -- GFM syntax can be used for rich text representation.
@@ -793,12 +611,7 @@ data Tag = Tag
794 -- | Additional external documentation for this tag.
612 -- | Additional external documentation for this tag.
795 , _tagExternalDocs :: Maybe ExternalDocs
613 , _tagExternalDocs :: Maybe ExternalDocs
796− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
614+ } 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.
616-- | Allows referencing an external resource for extended documentation.
804data ExternalDocs = ExternalDocs
617data ExternalDocs = ExternalDocs
@@ -808,236 +621,170 @@ data ExternalDocs = ExternalDocs
809 -- | The URL for the target documentation.
622 -- | The URL for the target documentation.
810 , _externalDocsUrl :: URL
623 , _externalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
624+ } deriving (Eq, Show, Generic)
813−instance Hashable ExternalDocs
815-- | A simple object to allow referencing other definitions in the specification.
626-- | 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.
627-- It can be used to reference parameters and responses that are defined at the top level for reuse.
817newtype Reference = Reference { getReference :: Text }
628newtype Reference = Reference { getReference :: Text }
818− deriving (Eq, Show, Data, Typeable)
629+ deriving (Eq, Show)
820data Referenced a
631data Referenced a
821 = Ref Reference
632 = Ref Reference
822 | Inline a
633 | Inline a
823− deriving (Eq, Show, Functor, Data, Typeable)
634+ 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)
636+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-- =======================================================================
638-- =======================================================================
836-- Monoid instances
639-- Monoid instances
837-- =======================================================================
640-- =======================================================================
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841instance Monoid Swagger where
642instance Monoid Swagger where
842 mempty = genericMempty
643 mempty = genericMempty
843− mappend = (<>)
644+ mappend = genericMappend
845−instance Semigroup Info where
846− (<>) = genericMappend
847instance Monoid Info where
646instance Monoid Info where
848 mempty = genericMempty
647 mempty = genericMempty
849− mappend = (<>)
648+ mappend = genericMappend
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
650+instance Monoid Paths where
854 mempty = genericMempty
651 mempty = genericMempty
855− mappend = (<>)
652+ mappend = genericMappend
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859instance Monoid PathItem where
654instance Monoid PathItem where
860 mempty = genericMempty
655 mempty = genericMempty
861− mappend = (<>)
656+ mappend = genericMappend
863−instance Semigroup Schema where
864− (<>) = genericMappend
865instance Monoid Schema where
658instance Monoid Schema where
866 mempty = genericMempty
659 mempty = genericMempty
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
660+ mappend = genericMappend
871−instance Monoid (ParamSchema t) where
872− mempty = genericMempty
875−instance Semigroup Param where
876− (<>) = genericMappend
877−instance Monoid Param where
662+instance Monoid SchemaCommon where
878 mempty = genericMempty
663 mempty = genericMempty
879− mappend = (<>)
664+ mappend = genericMappend
881−instance Semigroup ParamOtherSchema where
666+instance Monoid Parameter where
882− (<>) = genericMappend
883−instance Monoid ParamOtherSchema where
884 mempty = genericMempty
667 mempty = genericMempty
885− mappend = (<>)
668+ mappend = genericMappend
887−instance Semigroup Header where
670+instance Monoid ParameterOtherSchema where
888− (<>) = genericMappend
889−instance Monoid Header where
890 mempty = genericMempty
671 mempty = genericMempty
891− mappend = (<>)
672+ mappend = genericMappend
893−instance Semigroup Responses where
894− (<>) = genericMappend
895instance Monoid Responses where
674instance Monoid Responses where
896 mempty = genericMempty
675 mempty = genericMempty
897− mappend = (<>)
676+ mappend = genericMappend
899−instance Semigroup Response where
900− (<>) = genericMappend
901instance Monoid Response where
678instance Monoid Response where
902 mempty = genericMempty
679 mempty = genericMempty
903− mappend = (<>)
680+ mappend = genericMappend
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907instance Monoid ExternalDocs where
682instance Monoid ExternalDocs where
908 mempty = genericMempty
683 mempty = genericMempty
909− mappend = (<>)
684+ mappend = genericMappend
911−instance Semigroup Operation where
912− (<>) = genericMappend
913instance Monoid Operation where
686instance Monoid Operation where
914 mempty = genericMempty
687 mempty = genericMempty
917−instance Semigroup Example where
918− (<>) = genericMappend
688+ 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-- =======================================================================
690-- =======================================================================
935-- SwaggerMonoid helper instances
691-- SwaggerMonoid helper instances
936-- =======================================================================
692-- =======================================================================
938instance SwaggerMonoid Info
694instance SwaggerMonoid Info
695+instance SwaggerMonoid Paths
939instance SwaggerMonoid PathItem
696instance SwaggerMonoid PathItem
940instance SwaggerMonoid Schema
697instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
698+instance SwaggerMonoid SchemaCommon
942−instance SwaggerMonoid Param
699+instance SwaggerMonoid Parameter
943−instance SwaggerMonoid ParamOtherSchema
700+instance SwaggerMonoid ParameterOtherSchema
944instance SwaggerMonoid Responses
701instance SwaggerMonoid Responses
945instance SwaggerMonoid Response
702instance SwaggerMonoid Response
946instance SwaggerMonoid ExternalDocs
703instance SwaggerMonoid ExternalDocs
947instance SwaggerMonoid Operation
704instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
951instance SwaggerMonoid MimeList
706instance SwaggerMonoid MimeList
952deriving instance SwaggerMonoid URL
707deriving instance SwaggerMonoid URL
954−instance SwaggerMonoid (SwaggerType t) where
709+instance SwaggerMonoid SchemaType where
955− swaggerMempty = SwaggerString
710+ swaggerMempty = SchemaNull
956 swaggerMappend _ y = y
711 swaggerMappend _ y = y
958−instance SwaggerMonoid ParamLocation where
713+instance SwaggerMonoid ParameterType where
959− swaggerMempty = ParamQuery
714+ swaggerMempty = ParamString
960 swaggerMappend _ y = y
715 swaggerMappend _ y = y
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
717+instance SwaggerMonoid ParameterLocation where
963− swaggerMempty = InsOrdHashMap.empty
718+ swaggerMempty = ParameterQuery
964− swaggerMappend = InsOrdHashMap.unionWith mappend
966−instance Monoid a => SwaggerMonoid (Referenced a) where
967− swaggerMempty = Inline mempty
968− swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
969 swaggerMappend _ y = y
719 swaggerMappend _ y = y
971−instance SwaggerMonoid ParamAnySchema where
721+instance SwaggerMonoid (HashMap Text Schema) where
972− swaggerMempty = ParamOther swaggerMempty
722+ swaggerMempty = HashMap.empty
973− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975− swaggerMappend _ y = y
723+ swaggerMappend = HashMap.unionWith mappend
977−-- =======================================================================
978−-- Simple Generic-based ToJSON instances
979−-- =======================================================================
981−instance ToJSON ParamLocation where
982− toJSON = genericToJSON (jsonPrefix "Param")
984−instance ToJSON Info where
725+instance SwaggerMonoid (HashMap Text (Referenced Schema)) where
985− toJSON = genericToJSON (jsonPrefix "Info")
726+ swaggerMempty = HashMap.empty
727+ swaggerMappend = HashMap.unionWith swaggerMappend
987−instance ToJSON Contact where
729+instance Monoid a => SwaggerMonoid (Referenced a) where
988− toJSON = genericToJSON (jsonPrefix "Contact")
730+ swaggerMempty = Inline mempty
731+ swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
732+ swaggerMappend _ y = y
990−instance ToJSON License where
734+instance SwaggerMonoid (HashMap Text Parameter) where
991− toJSON = genericToJSON (jsonPrefix "License")
735+ swaggerMempty = HashMap.empty
736+ swaggerMappend = HashMap.unionWith mappend
993−instance ToJSON ApiKeyLocation where
738+instance SwaggerMonoid (HashMap Text Response) where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
739+ swaggerMempty = HashMap.empty
740+ swaggerMappend = flip HashMap.union
996−instance ToJSON ApiKeyParams where
742+instance SwaggerMonoid (HashMap Text SecurityScheme) where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
743+ swaggerMempty = HashMap.empty
744+ swaggerMappend = flip HashMap.union
999−instance ToJSON Scheme where
746+instance SwaggerMonoid (HashMap FilePath PathItem) where
1000− toJSON = genericToJSON (jsonPrefix "")
747+ swaggerMempty = HashMap.empty
748+ swaggerMappend = HashMap.unionWith mappend
1002−instance ToJSON Tag where
750+instance SwaggerMonoid (HashMap HeaderName Header) where
1003− toJSON = genericToJSON (jsonPrefix "Tag")
751+ swaggerMempty = HashMap.empty
752+ swaggerMappend = flip HashMap.union
1005−instance ToJSON ExternalDocs where
754+instance SwaggerMonoid (HashMap HttpStatusCode (Referenced Response)) where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
755+ swaggerMempty = HashMap.empty
756+ swaggerMappend = flip HashMap.union
1008−instance ToJSON Xml where
758+instance SwaggerMonoid ParameterSchema where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
759+ swaggerMempty = ParameterOther swaggerMempty
760+ swaggerMappend (ParameterBody x) (ParameterBody y) = ParameterBody (swaggerMappend x y)
761+ swaggerMappend (ParameterOther x) (ParameterOther y) = ParameterOther (swaggerMappend x y)
762+ swaggerMappend _ y = y
1011-- =======================================================================
764-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
765+-- TH derived ToJSON and FromJSON instances
1013-- =======================================================================
766-- =======================================================================
1015−instance FromJSON ParamLocation where
768+deriveJSON (jsonPrefix "Parameter") ''ParameterLocation
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
769+deriveJSON (jsonPrefix "Param") ''ParameterType
1017−
770+deriveJSON' ''Info
1018−instance FromJSON Info where
771+deriveJSON' ''Contact
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
772+deriveJSON' ''License
1020−
773+deriveJSON (jsonPrefix "Schema") ''SchemaType
1021−instance FromJSON Contact where
774+deriveJSON (jsonPrefix "Items") ''ItemsType
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
775+deriveJSON (jsonPrefix "ItemsCollection") ''ItemsCollectionFormat
1023−
776+deriveJSON (jsonPrefix "Collection") ''CollectionFormat
1024−instance FromJSON License where
777+deriveJSON (jsonPrefix "ApiKey") ''ApiKeyLocation
1025− parseJSON = genericParseJSON (jsonPrefix "License")
1027−instance FromJSON ApiKeyLocation where
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1030−instance FromJSON ApiKeyParams where
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
778+deriveJSON (jsonPrefix "apiKey") ''ApiKeyParams
1032−
779+deriveJSON' ''SchemaCommon
1033−instance FromJSON Scheme where
780+deriveJSONDefault ''Scheme
1034− parseJSON = genericParseJSON (jsonPrefix "")
781+deriveJSON' ''Tag
1035−
782+deriveJSON' ''ExternalDocs
1036−instance FromJSON Tag where
783+
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
784+deriveToJSON' ''Operation
1038−
785+deriveToJSON' ''Response
1039−instance FromJSON ExternalDocs where
786+deriveToJSON' ''PathItem
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
787+deriveToJSON' ''Xml
1042-- =======================================================================
789-- =======================================================================
1043-- Manual ToJSON instances
790-- Manual ToJSON instances
@@ -1059,8 +806,7 @@ instance ToJSON OAuth2Flow where
1059 , "tokenUrl" .= tokenUrl ]
806 , "tokenUrl" .= tokenUrl ]
1061instance ToJSON OAuth2Params where
808instance ToJSON OAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
809+ toJSON = genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1065instance ToJSON SecuritySchemeType where
811instance ToJSON SecuritySchemeType where
1066 toJSON SecuritySchemeBasic
812 toJSON SecuritySchemeBasic
@@ -1073,38 +819,22 @@ instance ToJSON SecuritySchemeType where
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
819 <+> object [ "type" .= ("oauth2" :: Text) ]
1075instance ToJSON Swagger where
821instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
822+ toJSON = addVersion . genericToJSON (jsonPrefix "")
1077− DEFINE_TOENCODING
823+ where
824+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
825+ addVersion _ = error "impossible"
1079instance ToJSON SecurityScheme where
827instance ToJSON SecurityScheme where
1080− toJSON = sopSwaggerGenericToJSON
828+ toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1083instance ToJSON Schema where
830instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
831+ toJSON = genericToJSONWithSub "schemaCommon" (jsonPrefix "schema")
1087instance ToJSON Header where
833instance ToJSON Header where
1088− toJSON = sopSwaggerGenericToJSON
834+ toJSON = genericToJSONWithSub "common" (jsonPrefix "header")
1089− DEFINE_TOENCODING
835+
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
836+instance ToJSON Items where
1098− toJSON (SwaggerItemsPrimitive fmt schema) = object
837+ 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
839instance ToJSON Host where
1110 toJSON (Host host mport) = toJSON $
840 toJSON (Host host mport) = toJSON $
@@ -1112,79 +842,38 @@ instance ToJSON Host where
1112 Nothing -> host
842 Nothing -> host
1113 Just port -> host ++ ":" ++ show port
843 Just port -> host ++ ":" ++ show port
845+instance ToJSON Paths where
846+ toJSON (Paths m) = toJSON m
1115instance ToJSON MimeList where
848instance ToJSON MimeList where
1116 toJSON (MimeList xs) = toJSON (map show xs)
849 toJSON (MimeList xs) = toJSON (map show xs)
1118−instance ToJSON Param where
851+instance ToJSON Parameter where
1119− toJSON = sopSwaggerGenericToJSON
852+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "parameter")
1122−instance ToJSON ParamAnySchema where
854+instance ToJSON ParameterSchema where
1123− toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
855+ toJSON (ParameterBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124− toJSON (ParamOther s) = toJSON s
856+ toJSON (ParameterOther s) = toJSON s
1126−instance ToJSON ParamOtherSchema where
858+instance ToJSON ParameterOtherSchema where
1127− toJSON = sopSwaggerGenericToJSON
859+ toJSON = genericToJSONWithSub "common" (jsonPrefix "parameterOtherSchema")
1130−instance ToJSON Responses where
1131− toJSON = sopSwaggerGenericToJSON
1134−instance ToJSON Response where
861+instance ToJSON SchemaItems where
1135− toJSON = sopSwaggerGenericToJSON
862+ toJSON (SchemaItemsObject x) = toJSON x
1136− DEFINE_TOENCODING
863+ toJSON (SchemaItemsArray xs) = toJSON xs
1138−instance ToJSON Operation where
865+instance ToJSON Responses where
1139− toJSON = sopSwaggerGenericToJSON
866+ toJSON (Responses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1142−instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1146instance ToJSON Example where
868instance ToJSON Example where
1147 toJSON = toJSON . Map.mapKeys show . getExample
869 toJSON = toJSON . Map.mapKeys show . getExample
1149−instance ToJSON SecurityDefinitions where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
1152instance ToJSON Reference where
871instance ToJSON Reference where
1153 toJSON (Reference ref) = object [ "$ref" .= ref ]
872 toJSON (Reference ref) = object [ "$ref" .= ref ]
1155−referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
874+instance ToJSON a => ToJSON (Referenced a) where
1156−referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
875+ toJSON (Ref ref) = toJSON ref
1157−referencedToJSON _ (Inline x) = toJSON x
876+ 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-- =======================================================================
878-- =======================================================================
1190-- Manual FromJSON instances
879-- Manual FromJSON instances
@@ -1204,224 +893,117 @@ instance FromJSON OAuth2Flow where
1204 parseJSON _ = empty
893 parseJSON _ = empty
1206instance FromJSON OAuth2Params where
895instance FromJSON OAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
896+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1209instance FromJSON SecuritySchemeType where
898instance FromJSON SecuritySchemeType where
1210− parseJSON js@(Object o) = do
899+ parseJSON json@(Object o) = do
1211 (t :: Text) <- o .: "type"
900 (t :: Text) <- o .: "type"
1212 case t of
901 case t of
1213 "basic" -> pure SecuritySchemeBasic
902 "basic" -> pure SecuritySchemeBasic
1214− "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
903+ "apiKey" -> SecuritySchemeApiKey <$> parseJSON json
1215− "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
904+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON json
1216 _ -> empty
905 _ -> empty
1217 parseJSON _ = empty
906 parseJSON _ = empty
1219instance FromJSON Swagger where
908instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
909+ parseJSON json@(Object o) = do
910+ (version :: Text) <- o .: "swagger"
911+ when (version /= "2.0") empty
912+ (genericParseJSON (jsonPrefix "")
913+ `withDefaults` [ "consumes" .= (mempty :: MimeList)
914+ , "produces" .= (mempty :: MimeList)
915+ , "security" .= ([] :: [SecurityRequirement])
916+ , "tags" .= ([] :: [Tag])
917+ , "definitions" .= (mempty :: HashMap Text Schema)
918+ , "parameters" .= (mempty :: HashMap Text Parameter)
919+ , "responses" .= (mempty :: HashMap Text Response)
920+ , "securityDefinitions" .= (mempty :: HashMap Text SecurityScheme)
1222instance FromJSON SecurityScheme where
924instance FromJSON SecurityScheme where
1223− parseJSON = sopSwaggerGenericParseJSON
925+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1225instance FromJSON Schema where
927instance FromJSON Schema where
1226− parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
928+ parseJSON = genericParseJSONWithSub "schemaCommon" (jsonPrefix "schema")
1227− where nullaryCleanup :: Schema -> Schema
929+ `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1228− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
930+ , "required" .= ([] :: [ParamName]) ]
1229− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230− then s { _schemaExample = Nothing
1231− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1234instance FromJSON Header where
932instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
933+ 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
935+instance FromJSON Items where
1243− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
936+ 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
938instance FromJSON Host where
1266− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
939+ parseJSON (String s) =
1267− [host] -> return $ Host host Nothing
940+ case fromInteger <$> readMaybe portStr of
1268− [host, port] -> case readMaybe port of
941+ Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1269− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
942+ mport -> pure $ Host host mport
1270− Just p -> return $ Host host (Just (fromInteger p))
943+ where
1271− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
944+ (hostText, portText) = Text.breakOn ":" s
945+ [host, portStr] = map Text.unpack [hostText, portText]
1272 parseJSON _ = empty
946 parseJSON _ = empty
948+instance FromJSON Paths where
949+ parseJSON json = Paths <$> parseJSON json
1274instance FromJSON MimeList where
951instance FromJSON MimeList where
1275− parseJSON js = (MimeList . map fromString) <$> parseJSON js
952+ parseJSON json = (MimeList . map fromString) <$> parseJSON json
1277−instance FromJSON Param where
954+instance FromJSON Parameter where
1278− parseJSON = sopSwaggerGenericParseJSON
955+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "parameter")
1280−instance FromJSON ParamAnySchema where
957+instance FromJSON ParameterSchema where
1281− parseJSON js@(Object o) = do
958+ parseJSON json@(Object o) = do
1282 (i :: Text) <- o .: "in"
959 (i :: Text) <- o .: "in"
1283 case i of
960 case i of
1284 "body" -> do
961 "body" -> do
1285 schema <- o .: "schema"
962 schema <- o .: "schema"
1286− ParamBody <$> parseJSON schema
963+ ParameterBody <$> parseJSON schema
1287− _ -> ParamOther <$> parseJSON js
964+ _ -> ParameterOther <$> parseJSON json
1288 parseJSON _ = empty
965 parseJSON _ = empty
1290−instance FromJSON ParamOtherSchema where
967+instance FromJSON ParameterOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
968+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "parameterOtherSchema")
970+instance FromJSON SchemaItems where
971+ parseJSON json@(Object _) = SchemaItemsObject <$> parseJSON json
972+ parseJSON json@(Array _) = SchemaItemsArray <$> parseJSON json
1293instance FromJSON Responses where
975instance FromJSON Responses where
1294 parseJSON (Object o) = Responses
976 parseJSON (Object o) = Responses
1295 <$> o .:? "default"
977 <$> o .:? "default"
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
978+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1297 parseJSON _ = empty
979 parseJSON _ = empty
1299instance FromJSON Example where
981instance FromJSON Example where
1300− parseJSON js = do
982+ parseJSON json = do
1301− m <- parseJSON js
983+ m <- parseJSON json
1302 pure $ Example (Map.mapKeys fromString m)
984 pure $ Example (Map.mapKeys fromString m)
1304instance FromJSON Response where
986instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
987+ parseJSON = genericParseJSON (jsonPrefix "response")
988+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1307instance FromJSON Operation where
990instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
991+ parseJSON = genericParseJSON (jsonPrefix "operation")
992+ `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1310instance FromJSON PathItem where
994instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
995+ parseJSON = genericParseJSON (jsonPrefix "pathItem")
1312−
996+ `withDefaults` [ "parameters" .= ([] :: [Parameter]) ]
1313−instance FromJSON SecurityDefinitions where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
1316instance FromJSON Reference where
998instance FromJSON Reference where
1317 parseJSON (Object o) = Reference <$> o .: "$ref"
999 parseJSON (Object o) = Reference <$> o .: "$ref"
1318 parseJSON _ = empty
1000 parseJSON _ = empty
1320−referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
1002+instance FromJSON a => FromJSON (Referenced a) where
1321−referencedParseJSON prefix js@(Object o) = do
1324− Nothing -> Inline <$> parseJSON js
1003+ parseJSON json
1325− Just s -> Ref <$> parseRef s
1004+ = Ref <$> parseJSON json
1326− where
1005+ <|> Inline <$> parseJSON json
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
1007instance FromJSON Xml where
1338 parseJSON = genericParseJSON (jsonPrefix "xml")
1008 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