@@ -1,636 +1,452 @@
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 #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11{-# LANGUAGE OverloadedStrings #-}
4{-# LANGUAGE OverloadedStrings #-}
12{-# LANGUAGE RecordWildCards #-}
5{-# LANGUAGE RecordWildCards #-}
13{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE ScopedTypeVariables #-}
14−{-# LANGUAGE StandaloneDeriving #-}
15{-# LANGUAGE TemplateHaskell #-}
7{-# 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
8module Data.Swagger.Internal where
27−import Control.Lens ((&), (.~), (?~))
28import Control.Applicative
10import Control.Applicative
29import Data.Aeson
12import Data.Aeson
30−import qualified Data.Aeson.Types as JSON
13+import Data.Aeson.TH (deriveJSON)
31−import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
14+import Data.Foldable (Foldable)
32−import Data.Hashable (Hashable)
15+import Data.HashMap.Strict (HashMap)
33import qualified Data.HashMap.Strict as HashMap
16import qualified Data.HashMap.Strict as HashMap
34−import Data.HashSet.InsOrd (InsOrdHashSet)
35import Data.Map (Map)
17import Data.Map (Map)
36import qualified Data.Map as Map
18import qualified Data.Map as Map
37−import Data.Monoid (Monoid (..))
19+import Data.String (fromString)
38−import Data.Semigroup.Compat (Semigroup (..))
39−import Data.Scientific (Scientific)
40−import Data.String (IsString(..))
41import Data.Text (Text)
20import Data.Text (Text)
42import qualified Data.Text as Text
21import qualified Data.Text as Text
22+import Data.Traversable (Traversable)
23+import Data.Hashable (Hashable)
43import GHC.Generics (Generic)
24import GHC.Generics (Generic)
44−import Network.Socket (HostName, PortNumber)
25+import Network (HostName, PortNumber)
45import Network.HTTP.Media (MediaType)
26import Network.HTTP.Media (MediaType)
46import Text.Read (readMaybe)
27import 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
29import 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.
31-- | This is the root document object for the API specification.
77data Swagger = Swagger
32data Swagger = Swagger
78 { -- | Provides metadata about the API.
33 { -- | Provides metadata about the API.
79 -- The metadata can be used by the clients if needed.
34 -- The metadata can be used by the clients if needed.
80− _swaggerInfo :: Info
35+ swaggerInfo :: SwaggerInfo
82 -- | The host (name or ip) serving the API. It MAY include a port.
37 -- | 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).
38 -- If the host is not included, the host serving the documentation is to be used (including the port).
84− , _swaggerHost :: Maybe Host
39+ , swaggerHost :: Maybe SwaggerHost
86 -- | The base path on which the API is served, which is relative to the host.
41 -- | 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.
42 -- If it is not included, the API is served directly under the host.
88 -- The value MUST start with a leading slash (/).
43 -- The value MUST start with a leading slash (/).
89− , _swaggerBasePath :: Maybe FilePath
44+ , swaggerBasePath :: Maybe FilePath
91 -- | The transfer protocol of the API.
46 -- | 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.
47 -- 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]
48+ , swaggerSchemes :: Maybe [SwaggerScheme]
95 -- | A list of MIME types the APIs can consume.
50 -- | A list of MIME types the APIs can consume.
96 -- This is global to all APIs but can be overridden on specific API calls.
51 -- This is global to all APIs but can be overridden on specific API calls.
97− , _swaggerConsumes :: MimeList
52+ , swaggerConsumes :: SwaggerMimeList
99 -- | A list of MIME types the APIs can produce.
54 -- | A list of MIME types the APIs can produce.
100− -- This is global to all APIs but can be overridden on specific API calls.
55+ -- This is global to all APIs but can be overridden on specific API calls.
101− , _swaggerProduces :: MimeList
56+ , swaggerProduces :: SwaggerMimeList
103 -- | The available paths and operations for the API.
58 -- | The available paths and operations for the API.
104− -- Holds the relative paths to the individual endpoints.
59+ , swaggerPaths :: SwaggerPaths
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.
61 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
62+ , swaggerDefinitions :: HashMap Text SwaggerSchema
111 -- | An object to hold parameters that can be used across operations.
64 -- | An object to hold parameters that can be used across operations.
112 -- This property does not define global parameters for all operations.
65 -- This property does not define global parameters for all operations.
113− , _swaggerParameters :: Definitions Param
66+ , swaggerParameters :: HashMap Text SwaggerParameter
115 -- | An object to hold responses that can be used across operations.
68 -- | An object to hold responses that can be used across operations.
116 -- This property does not define global responses for all operations.
69 -- This property does not define global responses for all operations.
117− , _swaggerResponses :: Definitions Response
70+ , swaggerResponses :: HashMap Text SwaggerResponse
119 -- | Security scheme definitions that can be used across the specification.
72 -- | Security scheme definitions that can be used across the specification.
120− , _swaggerSecurityDefinitions :: SecurityDefinitions
73+ , swaggerSecurityDefinitions :: HashMap Text SwaggerSecurityScheme
122 -- | A declaration of which security schemes are applied for the API as a whole.
75 -- | 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
76 -- The list of values describes alternative security schemes that can be used
124 -- (that is, there is a logical OR between the security requirements).
77 -- (that is, there is a logical OR between the security requirements).
125 -- Individual operations can override this definition.
78 -- Individual operations can override this definition.
126− , _swaggerSecurity :: [SecurityRequirement]
79+ , swaggerSecurity :: [SwaggerSecurityRequirement]
128 -- | A list of tags used by the specification with additional metadata.
81 -- | 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.
82 -- 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.
83 -- 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.
84 -- 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.
85 -- Each tag name in the list MUST be unique.
133− , _swaggerTags :: InsOrdHashSet Tag
86+ , swaggerTags :: [SwaggerTag]
135 -- | Additional external documentation.
88 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
89+ , swaggerExternalDocs :: SwaggerExternalDocs
137− } deriving (Eq, Show, Generic, Data, Typeable)
90+ } deriving (Show, Generic)
139-- | The object provides metadata about the API.
92-- | The object provides metadata about the API.
140-- The metadata can be used by the clients if needed,
93-- The metadata can be used by the clients if needed,
141-- and can be presented in the Swagger-UI for convenience.
94-- and can be presented in the Swagger-UI for convenience.
142−data Info = Info
95+data SwaggerInfo = SwaggerInfo
143 { -- | The title of the application.
96 { -- | The title of the application.
144− _infoTitle :: Text
97+ swaggerInfoTitle :: Text
146 -- | A short description of the application.
99 -- | A short description of the application.
147 -- GFM syntax can be used for rich text representation.
100 -- GFM syntax can be used for rich text representation.
148− , _infoDescription :: Maybe Text
101+ , swaggerInfoDescription :: Maybe Text
150 -- | The Terms of Service for the API.
103 -- | The Terms of Service for the API.
151− , _infoTermsOfService :: Maybe Text
104+ , swaggerInfoTermsOfService :: Maybe Text
153 -- | The contact information for the exposed API.
106 -- | The contact information for the exposed API.
154− , _infoContact :: Maybe Contact
107+ , swaggerInfoContact :: Maybe SwaggerContact
156 -- | The license information for the exposed API.
109 -- | The license information for the exposed API.
157− , _infoLicense :: Maybe License
110+ , swaggerInfoLicense :: Maybe SwaggerLicense
159 -- | Provides the version of the application API
112 -- | Provides the version of the application API
160 -- (not to be confused with the specification version).
113 -- (not to be confused with the specification version).
161− , _infoVersion :: Text
114+ , swaggerInfoVersion :: Text
162− } deriving (Eq, Show, Generic, Data, Typeable)
115+ } deriving (Show)
164-- | Contact information for the exposed API.
117-- | Contact information for the exposed API.
165−data Contact = Contact
118+data SwaggerContact = SwaggerContact
166 { -- | The identifying name of the contact person/organization.
119 { -- | The identifying name of the contact person/organization.
167− _contactName :: Maybe Text
120+ swaggerContactName :: Maybe Text
169 -- | The URL pointing to the contact information.
122 -- | The URL pointing to the contact information.
170− , _contactUrl :: Maybe URL
123+ , swaggerContactUrl :: Maybe URL
172 -- | The email address of the contact person/organization.
125 -- | The email address of the contact person/organization.
173− , _contactEmail :: Maybe Text
126+ , swaggerContactEmail :: Maybe Text
174− } deriving (Eq, Show, Generic, Data, Typeable)
127+ } deriving (Show)
176-- | License information for the exposed API.
129-- | License information for the exposed API.
177−data License = License
130+data SwaggerLicense = SwaggerLicense
178 { -- | The license name used for the API.
131 { -- | The license name used for the API.
179− _licenseName :: Text
132+ swaggerLicenseName :: Text
181 -- | A URL to the license used for the API.
134 -- | A URL to the license used for the API.
182− , _licenseUrl :: Maybe URL
135+ , swaggerLicenseUrl :: Maybe URL
183− } deriving (Eq, Show, Generic, Data, Typeable)
136+ } deriving (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.
138-- | The host (name or ip) serving the API. It MAY include a port.
189−data Host = Host
139+data SwaggerHost = SwaggerHost
190− { _hostName :: HostName -- ^ Host name.
140+ { swaggerHostName :: HostName -- ^ Host name.
191− , _hostPort :: Maybe PortNumber -- ^ Optional port.
141+ , swaggerHostPort :: Maybe PortNumber -- ^ Optional port.
192− } deriving (Eq, Show, Generic, Typeable)
142+ } deriving (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.
144-- | The transfer protocol of the API.
211−data Scheme
145+data SwaggerScheme
216− deriving (Eq, Show, Generic, Data, Typeable)
150+ deriving (Show)
152+-- | The available paths and operations for the API.
153+data SwaggerPaths = SwaggerPaths
154+ { -- | Holds the relative paths to the individual endpoints.
155+ -- The path is appended to the @'swaggerBasePath'@ in order to construct the full URL.
156+ swaggerPathsMap :: HashMap FilePath SwaggerPathItem
218-- | Describes the operations available on a single path.
159-- | Describes the operations available on a single path.
219−-- A @'PathItem'@ may be empty, due to ACL constraints.
160+-- A @'SwaggerPathItem'@ may be empty, due to ACL constraints.
220-- The path itself is still exposed to the documentation viewer
161-- The path itself is still exposed to the documentation viewer
221-- but they will not know which operations and parameters are available.
162-- but they will not know which operations and parameters are available.
222−data PathItem = PathItem
163+data SwaggerPathItem = SwaggerPathItem
223 { -- | A definition of a GET operation on this path.
164 { -- | A definition of a GET operation on this path.
224− _pathItemGet :: Maybe Operation
165+ swaggerPathItemGet :: Maybe SwaggerOperation
226 -- | A definition of a PUT operation on this path.
167 -- | A definition of a PUT operation on this path.
227− , _pathItemPut :: Maybe Operation
168+ , swaggerPathItemPut :: Maybe SwaggerOperation
229 -- | A definition of a POST operation on this path.
170 -- | A definition of a POST operation on this path.
230− , _pathItemPost :: Maybe Operation
171+ , swaggerPathItemPost :: Maybe SwaggerOperation
232 -- | A definition of a DELETE operation on this path.
173 -- | A definition of a DELETE operation on this path.
233− , _pathItemDelete :: Maybe Operation
174+ , swaggerPathItemDelete :: Maybe SwaggerOperation
235 -- | A definition of a OPTIONS operation on this path.
176 -- | A definition of a OPTIONS operation on this path.
236− , _pathItemOptions :: Maybe Operation
177+ , swaggerPathItemOptions :: Maybe SwaggerOperation
238 -- | A definition of a HEAD operation on this path.
179 -- | A definition of a HEAD operation on this path.
239− , _pathItemHead :: Maybe Operation
180+ , swaggerPathItemHead :: Maybe SwaggerOperation
241 -- | A definition of a PATCH operation on this path.
182 -- | A definition of a PATCH operation on this path.
242− , _pathItemPatch :: Maybe Operation
183+ , swaggerPathItemPatch :: Maybe SwaggerOperation
244 -- | A list of parameters that are applicable for all the operations described under this path.
185 -- | A list of parameters that are applicable for all the operations described under this path.
245 -- These parameters can be overridden at the operation level, but cannot be removed there.
186 -- These parameters can be overridden at the operation level, but cannot be removed there.
246 -- The list MUST NOT include duplicated parameters.
187 -- The list MUST NOT include duplicated parameters.
247 -- A unique parameter is defined by a combination of a name and location.
188 -- A unique parameter is defined by a combination of a name and location.
248− , _pathItemParameters :: [Referenced Param]
189+ , swaggerPathItemParameters :: [SwaggerParameter]
249− } deriving (Eq, Show, Generic, Data, Typeable)
190+ } deriving (Show)
251-- | Describes a single API operation on a path.
192-- | Describes a single API operation on a path.
252−data Operation = Operation
193+data SwaggerOperation = SwaggerOperation
253 { -- | A list of tags for API documentation control.
194 { -- | A list of tags for API documentation control.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
195 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255− _operationTags :: InsOrdHashSet TagName
196+ swaggerOperationTags :: [Text]
257 -- | A short summary of what the operation does.
198 -- | A short summary of what the operation does.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
199 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
259− , _operationSummary :: Maybe Text
200+ , swaggerOperationSummary :: Maybe Text
261 -- | A verbose explanation of the operation behavior.
202 -- | A verbose explanation of the operation behavior.
262 -- GFM syntax can be used for rich text representation.
203 -- GFM syntax can be used for rich text representation.
263− , _operationDescription :: Maybe Text
204+ , swaggerOperationDescription :: Maybe Text
265 -- | Additional external documentation for this operation.
206 -- | Additional external documentation for this operation.
266− , _operationExternalDocs :: Maybe ExternalDocs
207+ , swaggerOperationExternalDocs :: Maybe SwaggerExternalDocs
268 -- | Unique string used to identify the operation.
209 -- | Unique string used to identify the operation.
269 -- The id MUST be unique among all operations described in the API.
210 -- The id MUST be unique among all operations described in the API.
270 -- Tools and libraries MAY use the it to uniquely identify an operation,
211 -- Tools and libraries MAY use the it to uniquely identify an operation,
271 -- therefore, it is recommended to follow common programming naming conventions.
212 -- therefore, it is recommended to follow common programming naming conventions.
272− , _operationOperationId :: Maybe Text
213+ , swaggerOperationOperationId :: Maybe Text
274 -- | A list of MIME types the operation can consume.
215 -- | A list of MIME types the operation can consume.
275− -- This overrides the @'consumes'@.
216+ -- This overrides the @'swaggerConsumes'@.
276 -- @Just []@ MAY be used to clear the global definition.
217 -- @Just []@ MAY be used to clear the global definition.
277− , _operationConsumes :: Maybe MimeList
218+ , swaggerOperationConsumes :: Maybe SwaggerMimeList
279 -- | A list of MIME types the operation can produce.
220 -- | A list of MIME types the operation can produce.
280− -- This overrides the @'produces'@.
221+ -- This overrides the @'swaggerProduces'@.
281 -- @Just []@ MAY be used to clear the global definition.
222 -- @Just []@ MAY be used to clear the global definition.
282− , _operationProduces :: Maybe MimeList
223+ , swaggerOperationProduces :: Maybe SwaggerMimeList
284 -- | A list of parameters that are applicable for this operation.
225 -- | A list of parameters that are applicable for this operation.
285− -- If a parameter is already defined at the @'PathItem'@,
226+ -- If a parameter is already defined at the @'SwaggerPathItem'@,
286 -- the new definition will override it, but can never remove it.
227 -- the new definition will override it, but can never remove it.
287 -- The list MUST NOT include duplicated parameters.
228 -- The list MUST NOT include duplicated parameters.
288 -- A unique parameter is defined by a combination of a name and location.
229 -- A unique parameter is defined by a combination of a name and location.
289− , _operationParameters :: [Referenced Param]
230+ , swaggerOperationParameters :: [SwaggerParameter]
291 -- | The list of possible responses as they are returned from executing this operation.
232 -- | The list of possible responses as they are returned from executing this operation.
292− , _operationResponses :: Responses
233+ , swaggerOperationResponses :: SwaggerResponses
294 -- | The transfer protocol for the operation.
235 -- | The transfer protocol for the operation.
295− -- The value overrides @'schemes'@.
236+ -- The value overrides @'swaggerSchemes'@.
296− , _operationSchemes :: Maybe [Scheme]
237+ , swaggerOperationSchemes :: Maybe [SwaggerScheme]
298 -- | Declares this operation to be deprecated.
239 -- | Declares this operation to be deprecated.
299 -- Usage of the declared operation should be refrained.
240 -- Usage of the declared operation should be refrained.
300 -- Default value is @False@.
241 -- Default value is @False@.
301− , _operationDeprecated :: Maybe Bool
242+ , swaggerOperationDeprecated :: Bool
303 -- | A declaration of which security schemes are applied for this operation.
244 -- | A declaration of which security schemes are applied for this operation.
304 -- The list of values describes alternative security schemes that can be used
245 -- The list of values describes alternative security schemes that can be used
305 -- (that is, there is a logical OR between the security requirements).
246 -- (that is, there is a logical OR between the security requirements).
306 -- This definition overrides any declared top-level security.
247 -- This definition overrides any declared top-level security.
307 -- To remove a top-level security declaration, @Just []@ can be used.
248 -- To remove a top-level security declaration, @Just []@ can be used.
308− , _operationSecurity :: [SecurityRequirement]
249+ , swaggerOperationSecurity :: [SwaggerSecurityRequirement]
309− } deriving (Eq, Show, Generic, Data, Typeable)
250+ } deriving (Show)
311−newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
314−mimeListConstr :: Constr
315−mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
317−mimeListDataType :: DataType
252+newtype SwaggerMimeList = SwaggerMimeList { getSwaggerMimeList :: [MediaType] }
318−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
253+ deriving (Show)
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.
255-- | Describes a single operation parameter.
328-- A unique parameter is defined by a combination of a name and location.
256-- A unique parameter is defined by a combination of a name and location.
329−data Param = Param
257+data SwaggerParameter = SwaggerParameter
330 { -- | The name of the parameter.
258 { -- | The name of the parameter.
331 -- Parameter names are case sensitive.
259 -- Parameter names are case sensitive.
332− _paramName :: Text
260+ swaggerParameterName :: Text
334 -- | A brief description of the parameter.
262 -- | A brief description of the parameter.
335 -- This could contain examples of use.
263 -- This could contain examples of use.
336 -- GFM syntax can be used for rich text representation.
264 -- GFM syntax can be used for rich text representation.
337− , _paramDescription :: Maybe Text
265+ , swaggerParameterDescription :: Maybe Text
339 -- | Determines whether this parameter is mandatory.
267 -- | Determines whether this parameter is mandatory.
340 -- If the parameter is in "path", this property is required and its value MUST be true.
268 -- 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@.
269 -- Otherwise, the property MAY be included and its default value is @False@.
342− , _paramRequired :: Maybe Bool
270+ , swaggerParameterRequired :: Bool
344 -- | Parameter schema.
272 -- | Parameter schema.
345− , _paramSchema :: ParamAnySchema
273+ , swaggerParameterSchema :: SwaggerParameterSchema
346− } deriving (Eq, Show, Generic, Data, Typeable)
274+ } deriving (Show, Generic)
348−data ParamAnySchema
276+data SwaggerParameterSchema
349− = ParamBody (Referenced Schema)
277+ = SwaggerParameterBody SwaggerSchema
350− | ParamOther ParamOtherSchema
278+ | SwaggerParameterOther SwaggerParameterOtherSchema
351− deriving (Eq, Show, Generic, Data, Typeable)
279+ deriving (Show)
353−data ParamOtherSchema = ParamOtherSchema
281+data SwaggerParameterOtherSchema = SwaggerParameterOtherSchema
354 { -- | The location of the parameter.
282 { -- | The location of the parameter.
355− _paramOtherSchemaIn :: ParamLocation
283+ swaggerParameterOtherSchemaIn :: SwaggerParameterLocation
285+ -- | The type of the parameter.
286+ -- Since the parameter is not located at the request body,
287+ -- it is limited to simple types (that is, not an object).
288+ -- If type is @'SwaggerParamFile'@, the @consumes@ MUST be either
289+ -- "multipart/form-data" or " application/x-www-form-urlencoded"
290+ -- and the parameter MUST be in @'SwaggerParameterFormData'@.
291+ , swaggerParameterOtherSchemaType :: SwaggerParameterType
293+ -- | The extending format for the previously mentioned type.
294+ , swaggerParameterOtherSchemaFormat :: Maybe SwaggerFormat
357 -- | Sets the ability to pass empty-valued parameters.
296 -- | Sets the ability to pass empty-valued parameters.
358− -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
297+ -- This is valid only for either @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@
359 -- and allows you to send a parameter with a name only or an empty value.
298 -- and allows you to send a parameter with a name only or an empty value.
360 -- Default value is @False@.
299 -- Default value is @False@.
361− , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
300+ , swaggerParameterOtherSchemaAllowEmptyValue :: Bool
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
302+ -- | __Required if type is @'SwaggerParamArray'@__.
364− } deriving (Eq, Show, Generic, Typeable, Data)
303+ -- Describes the type of items in the array.
365−
304+ , swaggerParameterOtherSchemaItems :: Maybe SwaggerItems
366−-- | Items for @'SwaggerArray'@ schemas.
305+
367−--
306+ -- | Determines the format of the array if @'SwaggerParamArray'@ is used.
368−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
307+ -- Default value is csv.
369−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
308+ , swaggerParameterOtherSchemaCollectionFormat :: Maybe SwaggerCollectionFormat
370−-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
309+
371−-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
310+ , swaggerParameterOtherSchemaCommon :: SwaggerSchemaCommon
372−--
311+ } deriving (Show, Generic)
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
312+
374−--
313+data SwaggerParameterType
375−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
314+ = SwaggerParamString
376−data SwaggerItems t where
315+ | SwaggerParamNumber
377− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
316+ | SwaggerParamInteger
378− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
317+ | SwaggerParamBoolean
379− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
318+ | SwaggerParamArray
380− deriving (Typeable)
319+ | SwaggerParamFile
382−deriving instance Eq (SwaggerItems t)
321+
383−deriving instance Show (SwaggerItems t)
322+data SwaggerParameterLocation
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.
323 = -- | Parameters that are appended to the URL.
500 -- For example, in @/items?id=###@, the query parameter is @id@.
324 -- For example, in @/items?id=###@, the query parameter is @id@.
501− ParamQuery
325+ SwaggerParameterQuery
502 -- | Custom headers that are expected as part of the request.
326 -- | Custom headers that are expected as part of the request.
503− | ParamHeader
327+ | SwaggerParameterHeader
504 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
328 -- | 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.
329 -- This does not include the host or base path of the API.
506 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
330 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
507− | ParamPath
331+ | SwaggerParameterPath
508 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
332 -- | 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
333 -- or @multipart/form-data@ are used as the content type of the request
510 -- (in Swagger's definition, the @consumes@ property of an operation).
334 -- (in Swagger's definition, the @consumes@ property of an operation).
511− -- This is the only parameter type that can be used to send files, thus supporting the @'ParamFile'@ type.
335+ -- This is the only parameter type that can be used to send files, thus supporting the @'SwaggerParamFile'@ type.
512 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
336 -- 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
337 -- 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>).
338 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
515− | ParamFormData
339+ | SwaggerParameterFormData
516− deriving (Eq, Show, Generic, Data, Typeable)
340+ deriving (Show)
518−type Format = Text
342+type SwaggerFormat = Text
520-- | Determines the format of the array.
344-- | Determines the format of the array.
521−data CollectionFormat t where
345+data SwaggerCollectionFormat
522− -- Comma separated values: @foo,bar@.
346+ = SwaggerCollectionCSV -- ^ Comma separated values: @foo,bar@.
523− CollectionCSV :: CollectionFormat t
524− -- Space separated values: @foo bar@.
347+ | SwaggerCollectionSSV -- ^ Space separated values: @foo bar@.
525− CollectionSSV :: CollectionFormat t
526− -- Tab separated values: @foo\\tbar@.
348+ | SwaggerCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
527− CollectionTSV :: CollectionFormat t
528− -- Pipe separated values: @foo|bar@.
349+ | SwaggerCollectionPipes -- ^ Pipe separated values: @foo|bar@.
529− CollectionPipes :: CollectionFormat t
530− -- Corresponds to multiple parameter instances
350+ | SwaggerCollectionMulti -- ^ Corresponds to multiple parameter instances
531− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
351+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532− -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
352+ -- This is valid only for parameters in @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
353+ deriving (Show)
536−deriving instance Eq (CollectionFormat t)
355+data SwaggerItemsType
537−deriving instance Show (CollectionFormat t)
356+ = SwaggerItemsString
538−
357+ | SwaggerItemsNumber
539−collectionFormatConstr :: CollectionFormat t -> Constr
358+ | SwaggerItemsInteger
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
359+ | SwaggerItemsBoolean
541−
360+ | SwaggerItemsArray
542−collectionFormatDataType :: DataType
361+ deriving (Show)
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
362+
544− map collectionFormatConstr collectionCommonFormats
363+data SwaggerSchemaType
545−
364+ = SwaggerSchemaArray
546−collectionCommonFormats :: [CollectionFormat t]
365+ | SwaggerSchemaBoolean
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
366+ | SwaggerSchemaInteger
548−
367+ | SwaggerSchemaNumber
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
368+ | SwaggerSchemaNull
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
369+ | SwaggerSchemaObject
551− toConstr = collectionFormatConstr
370+ | SwaggerSchemaString
552− dataTypeOf _ = collectionFormatDataType
371+ deriving (Show)
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
373+-- | Determines the format of the nested array.
555−
374+data SwaggerItemsCollectionFormat
556−type ParamName = Text
375+ = SwaggerItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
557−
376+ | SwaggerItemsCollectionSSV -- ^ Space separated values: @foo bar@.
558−data Schema = Schema
377+ | SwaggerItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
559− { _schemaTitle :: Maybe Text
378+ | SwaggerItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
560− , _schemaDescription :: Maybe Text
379+ deriving (Show)
561− , _schemaRequired :: [ParamName]
380+
562−
381+data SwaggerSchema = SwaggerSchema
563− , _schemaAllOf :: Maybe [Referenced Schema]
382+ { swaggerSchemaType :: SwaggerSchemaType
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
383+ , swaggerSchemaFormat :: SwaggerFormat
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
384+ , swaggerSchemaTitle :: Maybe Text
566−
385+ , swaggerSchemaDescription :: Maybe Text
567− , _schemaDiscriminator :: Maybe Text
386+ , swaggerSchemaRequired :: Maybe Bool
568− , _schemaReadOnly :: Maybe Bool
387+
569− , _schemaXml :: Maybe Xml
388+ , swaggerSchemaItems :: SwaggerSchemaItems
570− , _schemaExternalDocs :: Maybe ExternalDocs
389+ , swaggerSchemaAllOf :: [SwaggerSchema]
571− , _schemaExample :: Maybe Value
390+ , swaggerSchemaProperties :: HashMap Text SwaggerSchema
572−
391+ , swaggerSchemaAdditionalProperties :: Maybe SwaggerSchema
573− , _schemaMaxProperties :: Maybe Integer
392+
574− , _schemaMinProperties :: Maybe Integer
393+ , swaggerSchemaDiscriminator :: Maybe Text
575−
394+ , swaggerSchemaReadOnly :: Maybe Bool
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
395+ , swaggerSchemaXml :: Maybe SwaggerXml
396+ , swaggerSchemaExternalDocs :: Maybe SwaggerExternalDocs
397+ , swaggerSchemaExample :: Maybe Value
399+ , swaggerSchemaMaxProperties :: Maybe Integer
400+ , swaggerSchemaMinProperties :: Maybe Integer
402+ , swaggerSchemaCommon :: SwaggerSchemaCommon
577− } deriving (Eq, Show, Generic, Data, Typeable)
403+ } deriving (Show, Generic)
579−-- | A @'Schema'@ with an optional name.
405+data SwaggerSchemaItems
580−-- This name can be used in references.
406+ = SwaggerSchemaItemsObject SwaggerSchema
581−data NamedSchema = NamedSchema
407+ | SwaggerSchemaItemsArray [SwaggerSchema]
582− { _namedSchemaName :: Maybe Text
583− , _namedSchemaSchema :: Schema
584− } deriving (Eq, Show, Generic, Data, Typeable)
408+ deriving (Show)
586−-- | Regex pattern for @string@ type.
410+data SwaggerSchemaCommon = SwaggerSchemaCommon
589−data ParamSchema (t :: SwaggerKind *) = ParamSchema
590 { -- | Declares the value of the parameter that the server will use if none is provided,
411 { -- | 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@
412 -- 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.
413 -- if not supplied by the client in the request.
593 -- (Note: "default" has no meaning for required parameters.)
414 -- (Note: "default" has no meaning for required parameters.)
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
415 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595− _paramSchemaDefault :: Maybe Value
416+ swaggerSchemaDefault :: Maybe Value
597− , _paramSchemaType :: Maybe (SwaggerType t)
418+ , swaggerSchemaMaximum :: Maybe Integer
598− , _paramSchemaFormat :: Maybe Format
419+ , swaggerSchemaExclusiveMaximum :: Maybe Bool
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
420+ , swaggerSchemaMinimum :: Maybe Integer
600− , _paramSchemaMaximum :: Maybe Scientific
421+ , swaggerSchemaExclusiveMinimum :: Maybe Bool
601− , _paramSchemaExclusiveMaximum :: Maybe Bool
422+ , swaggerSchemaMaxLength :: Maybe Integer
602− , _paramSchemaMinimum :: Maybe Scientific
423+ , swaggerSchemaMinLength :: Maybe Integer
603− , _paramSchemaExclusiveMinimum :: Maybe Bool
424+ , swaggerSchemaPattern :: Maybe Text
604− , _paramSchemaMaxLength :: Maybe Integer
425+ , swaggerSchemaMaxItems :: Maybe Integer
605− , _paramSchemaMinLength :: Maybe Integer
426+ , swaggerSchemaMinItems :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
427+ , swaggerSchemaUniqueItems :: Maybe Bool
607− , _paramSchemaMaxItems :: Maybe Integer
428+ , swaggerSchemaEnum :: Maybe [Value]
608− , _paramSchemaMinItems :: Maybe Integer
429+ , swaggerSchemaMultipleOf :: Maybe Integer
609− , _paramSchemaUniqueItems :: Maybe Bool
610− , _paramSchemaEnum :: Maybe [Value]
611− , _paramSchemaMultipleOf :: Maybe Scientific
612− } deriving (Eq, Show, Generic, Typeable)
430+ } deriving (Show, Generic)
614−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
432+data SwaggerXml = SwaggerXml
617 { -- | Replaces the name of the element/attribute used for the described schema property.
433 { -- | 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.
434 -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
619 -- When defined alongside type being array (outside the items),
435 -- When defined alongside type being array (outside the items),
620 -- it will affect the wrapping element and only if wrapped is true.
436 -- it will affect the wrapping element and only if wrapped is true.
621 -- If wrapped is false, it will be ignored.
437 -- If wrapped is false, it will be ignored.
622− _xmlName :: Maybe Text
438+ swaggerXmlName :: Maybe Text
624 -- | The URL of the namespace definition.
440 -- | The URL of the namespace definition.
625 -- Value SHOULD be in the form of a URL.
441 -- Value SHOULD be in the form of a URL.
626− , _xmlNamespace :: Maybe Text
442+ , swaggerXmlNamespace :: Maybe Text
628 -- | The prefix to be used for the name.
444 -- | The prefix to be used for the name.
629− , _xmlPrefix :: Maybe Text
445+ , swaggerXmlPrefix :: Maybe Text
631 -- | Declares whether the property definition translates to an attribute instead of an element.
447 -- | Declares whether the property definition translates to an attribute instead of an element.
632 -- Default value is @False@.
448 -- Default value is @False@.
633− , _xmlAttribute :: Maybe Bool
449+ , swaggerXmlAttribute :: Bool
635 -- | MAY be used only for an array definition.
451 -- | MAY be used only for an array definition.
636 -- Signifies whether the array is wrapped
452 -- Signifies whether the array is wrapped
@@ -638,87 +454,103 @@ data Xml = Xml
638 -- or unwrapped (@\<book/\>\<book/\>@).
454 -- or unwrapped (@\<book/\>\<book/\>@).
639 -- Default value is @False@.
455 -- Default value is @False@.
640 -- The definition takes effect only when defined alongside type being array (outside the items).
456 -- The definition takes effect only when defined alongside type being array (outside the items).
641− , _xmlWrapped :: Maybe Bool
457+ , swaggerXmlWrapped :: Bool
460+data SwaggerItems = SwaggerItems
461+ { -- | The internal type of the array.
462+ swaggerItemsType :: SwaggerItemsType
464+ -- | The extending format for the previously mentioned type.
465+ , swaggerItemsFormat :: SwaggerFormat
467+ -- | __Required if type is @'SwaggerItemsArray'@.__
468+ -- Describes the type of items in the array.
469+ , swaggerItemsItems :: SwaggerItems
471+ -- | Determines the format of the array if type array is used.
472+ -- Default value is @'SwaggerItemsCollectionCSV'@.
473+ , swaggerItemsCollectionFormat :: SwaggerItemsCollectionFormat
475+ , swaggerItemsCommon :: SwaggerSchemaCommon
642− } deriving (Eq, Show, Generic, Data, Typeable)
476+ } deriving (Show, Generic)
644-- | A container for the expected responses of an operation.
478-- | A container for the expected responses of an operation.
645-- The container maps a HTTP response code to the expected response.
479-- The container maps a HTTP response code to the expected response.
646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
480-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
647-- since they may not be known in advance.
481-- since they may not be known in advance.
648-- However, it is expected from the documentation to cover a successful operation response and any known errors.
482-- However, it is expected from the documentation to cover a successful operation response and any known errors.
649−data Responses = Responses
483+data SwaggerResponses = SwaggerResponses
650 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
484 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
651 -- It can be used to cover undeclared responses.
485 -- It can be used to cover undeclared responses.
652− _responsesDefault :: Maybe (Referenced Response)
486+ swaggerResponsesDefault :: Maybe SwaggerResponse
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
488 -- | 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.
489 -- Describes the expected response for those HTTP status codes.
656− , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
490+ , swaggerResponsesResponses :: HashMap HttpStatusCode SwaggerResponse
657− } deriving (Eq, Show, Generic, Data, Typeable)
491+ } deriving (Show)
659type HttpStatusCode = Int
493type HttpStatusCode = Int
661-- | Describes a single response from an API Operation.
495-- | Describes a single response from an API Operation.
662−data Response = Response
496+data SwaggerResponse = SwaggerResponse
663 { -- | A short description of the response.
497 { -- | A short description of the response.
664 -- GFM syntax can be used for rich text representation.
498 -- GFM syntax can be used for rich text representation.
665− _responseDescription :: Text
499+ swaggerResponseDescription :: Text
667 -- | A definition of the response structure.
501 -- | A definition of the response structure.
668 -- It can be a primitive, an array or an object.
502 -- It can be a primitive, an array or an object.
669 -- If this field does not exist, it means no content is returned as part of the response.
503 -- If this field does not exist, it means no content is returned as part of the response.
670 -- As an extension to the Schema Object, its root type value may also be "file".
504 -- As an extension to the Schema Object, its root type value may also be "file".
671 -- This SHOULD be accompanied by a relevant produces mime-type.
505 -- This SHOULD be accompanied by a relevant produces mime-type.
672− , _responseSchema :: Maybe (Referenced Schema)
506+ , swaggerResponseSchema :: Maybe SwaggerSchema
674 -- | A list of headers that are sent with the response.
508 -- | A list of headers that are sent with the response.
675− , _responseHeaders :: InsOrdHashMap HeaderName Header
509+ , swaggerResponseHeaders :: HashMap HeaderName SwaggerHeader
677 -- | An example of the response message.
511 -- | An example of the response message.
678− , _responseExamples :: Maybe Example
512+ , swaggerResponseExamples :: Maybe SwaggerExample
679− } deriving (Eq, Show, Generic, Data, Typeable)
513+ } deriving (Show)
681−instance IsString Response where
682− fromString s = Response (fromString s) Nothing mempty Nothing
684type HeaderName = Text
515type HeaderName = Text
686−data Header = Header
517+data SwaggerHeader = SwaggerHeader
687 { -- | A short description of the header.
518 { -- | A short description of the header.
688− _headerDescription :: Maybe Text
519+ swaggerHeaderDescription :: Maybe String
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
521+ -- | The type of the object.
691− } deriving (Eq, Show, Generic, Data, Typeable)
522+ , swaggerHeaderType :: SwaggerItemsType
693−data Example = Example { getExample :: Map MediaType Value }
524+ -- | The extending format for the previously mentioned type. See Data Type Formats for further details.
694− deriving (Eq, Show, Generic, Typeable)
525+ , swaggerHeaderFormat :: Maybe SwaggerFormat
696−exampleConstr :: Constr
527+ -- | __Required if type is @'SwaggerItemsArray'@__.
697−exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
528+ -- Describes the type of items in the array.
529+ , swaggerHeaderItems :: SwaggerItems
699−exampleDataType :: DataType
531+ -- | Determines the format of the array if type array is used.
700−exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
532+ -- Default value is @'SwaggerItemsCollectionCSV'@.
533+ , swaggerHeaderCollectionFormat :: SwaggerItemsCollectionFormat
702−instance Data Example where
535+ , swaggerHeaderCommon :: SwaggerSchemaCommon
703− gunfold k z c = case constrIndex c of
536+ } deriving (Show, Generic)
704− 1 -> k (z (\m -> Example (Map.mapKeys fromString m)))
537+
705− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Example."
538+data SwaggerExample = SwaggerExample { getSwaggerExample :: Map MediaType Value }
706− toConstr (Example _) = exampleConstr
539+ deriving (Show)
707− dataTypeOf _ = exampleDataType
709-- | The location of the API key.
541-- | The location of the API key.
710−data ApiKeyLocation
542+data SwaggerApiKeyLocation
711− = ApiKeyQuery
543+ = SwaggerApiKeyQuery
712− | ApiKeyHeader
544+ | SwaggerApiKeyHeader
713− deriving (Eq, Show, Generic, Data, Typeable)
545+ deriving (Show)
715−data ApiKeyParams = ApiKeyParams
547+data SwaggerApiKeyParams = SwaggerApiKeyParams
716 { -- | The name of the header or query parameter to be used.
548 { -- | The name of the header or query parameter to be used.
717− _apiKeyName :: Text
549+ swaggerApiKeyName :: Text
719 -- | The location of the API key.
551 -- | The location of the API key.
720− , _apiKeyIn :: ApiKeyLocation
552+ , swaggerApiKeyIn :: SwaggerApiKeyLocation
721− } deriving (Eq, Show, Generic, Data, Typeable)
553+ } deriving (Show)
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
555-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
724type AuthorizationURL = Text
556type AuthorizationURL = Text
@@ -726,702 +558,295 @@ type AuthorizationURL = Text
726-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
558-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
727type TokenURL = Text
559type TokenURL = Text
729−data OAuth2Flow
561+data SwaggerOAuth2Flow
730− = OAuth2Implicit AuthorizationURL
562+ = SwaggerOAuth2Implicit AuthorizationURL
731− | OAuth2Password TokenURL
563+ | SwaggerOAuth2Password TokenURL
732− | OAuth2Application TokenURL
564+ | SwaggerOAuth2Application TokenURL
733− | OAuth2AccessCode AuthorizationURL TokenURL
565+ | SwaggerOAuth2AccessCode AuthorizationURL TokenURL
734− deriving (Eq, Show, Generic, Data, Typeable)
566+ deriving (Show)
736−data OAuth2Params = OAuth2Params
568+data SwaggerOAuth2Params = SwaggerOAuth2Params
737 { -- | The flow used by the OAuth2 security scheme.
569 { -- | The flow used by the OAuth2 security scheme.
738− _oauth2Flow :: OAuth2Flow
570+ swaggerOAuth2Flow :: SwaggerOAuth2Flow
740 -- | The available scopes for the OAuth2 security scheme.
572 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
573+ , swaggerOAuth2Scopes :: HashMap Text Text
742− } deriving (Eq, Show, Generic, Data, Typeable)
574+ } deriving (Show, Generic)
744−data SecuritySchemeType
576+data SwaggerSecuritySchemeType
745− = SecuritySchemeBasic
577+ = SwaggerSecuritySchemeBasic
746− | SecuritySchemeApiKey ApiKeyParams
578+ | SwaggerSecuritySchemeApiKey SwaggerApiKeyParams
747− | SecuritySchemeOAuth2 OAuth2Params
579+ | SwaggerSecuritySchemeOAuth2 SwaggerOAuth2Params
582+data SwaggerSecuritySchemeTypeName
583+ = SwaggerSecuritySchemeTypeBasic
584+ | SwaggerSecuritySchemeTypeApiKey
585+ | SwaggerSecuritySchemeTypeOAuth2
748− deriving (Eq, Show, Generic, Data, Typeable)
586+ deriving (Eq, Read, Show, Generic)
750−data SecurityScheme = SecurityScheme
588+swaggerSecuritySchemeTypeNameToText :: SwaggerSecuritySchemeTypeName -> Text
589+swaggerSecuritySchemeTypeNameToText SwaggerSecuritySchemeTypeBasic = "basic"
590+swaggerSecuritySchemeTypeNameToText SwaggerSecuritySchemeTypeApiKey = "apiKey"
591+swaggerSecuritySchemeTypeNameToText SwaggerSecuritySchemeTypeOAuth2 = "oauth2"
593+swaggerSecuritySchemeTypeNameFromText :: Alternative f => Text -> f SwaggerSecuritySchemeTypeName
594+swaggerSecuritySchemeTypeNameFromText "basic" = pure SwaggerSecuritySchemeTypeBasic
595+swaggerSecuritySchemeTypeNameFromText "apiKey" = pure SwaggerSecuritySchemeTypeApiKey
596+swaggerSecuritySchemeTypeNameFromText "oauth2" = pure SwaggerSecuritySchemeTypeOAuth2
597+swaggerSecuritySchemeTypeNameFromText _ = empty
599+instance Hashable SwaggerSecuritySchemeTypeName
601+data SwaggerSecurityScheme = SwaggerSecurityScheme
751 { -- | The type of the security scheme.
602 { -- | The type of the security scheme.
752− _securitySchemeType :: SecuritySchemeType
603+ swaggerSecuritySchemeType :: SwaggerSecuritySchemeType
754 -- | A short description for security scheme.
605 -- | A short description for security scheme.
755− , _securitySchemeDescription :: Maybe Text
606+ , swaggerSecuritySchemeDescription :: Maybe Text
756− } deriving (Eq, Show, Generic, Data, Typeable)
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)
607+ } deriving (Show, Generic)
774-- | Lists the required security schemes to execute this operation.
609-- | Lists the required security schemes to execute this operation.
775-- The object can have multiple security schemes declared in it which are all required
610-- 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).
611-- (that is, there is a logical AND between the schemes).
777−newtype SecurityRequirement = SecurityRequirement
612+newtype SwaggerSecurityRequirement = SwaggerSecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
613+ { getSwaggerSecurityRequirement :: HashMap SwaggerSecuritySchemeTypeName Text
779− } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
614+ } deriving (Eq, Read, Show, Monoid)
784−-- | Allows adding meta data to a single tag that is used by @Operation@.
616+-- | Allows adding meta data to a single tag that is used by @SwaggerOperation@.
785−-- It is not mandatory to have a @Tag@ per tag used there.
617+-- It is not mandatory to have a @SwaggerTag@ per tag used there.
786−data Tag = Tag
618+data SwaggerTag = SwaggerTag
787 { -- | The name of the tag.
619 { -- | The name of the tag.
788− _tagName :: TagName
620+ swaggerTagName :: Text
790 -- | A short description for the tag.
622 -- | A short description for the tag.
791 -- GFM syntax can be used for rich text representation.
623 -- GFM syntax can be used for rich text representation.
792− , _tagDescription :: Maybe Text
624+ , swaggerTagDescription :: Maybe Text
794 -- | Additional external documentation for this tag.
626 -- | Additional external documentation for this tag.
795− , _tagExternalDocs :: Maybe ExternalDocs
627+ , swaggerTagExternalDocs :: Maybe SwaggerExternalDocs
796− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
628+ } deriving (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.
630-- | Allows referencing an external resource for extended documentation.
804−data ExternalDocs = ExternalDocs
631+data SwaggerExternalDocs = SwaggerExternalDocs
805 { -- | A short description of the target documentation.
632 { -- | A short description of the target documentation.
806 -- GFM syntax can be used for rich text representation.
633 -- GFM syntax can be used for rich text representation.
807− _externalDocsDescription :: Maybe Text
634+ swaggerExternalDocsDescription :: Maybe Text
809 -- | The URL for the target documentation.
636 -- | The URL for the target documentation.
810− , _externalDocsUrl :: URL
637+ , swaggerExternalDocsUrl :: URL
811− } deriving (Eq, Ord, Show, Generic, Data, Typeable)
638+ } deriving (Show)
813−instance Hashable ExternalDocs
815−-- | 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.
817−newtype Reference = Reference { getReference :: Text }
818− deriving (Eq, Show, Data, Typeable)
823− deriving (Eq, Show, Functor, Data, Typeable)
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
831− = AdditionalPropertiesAllowed Bool
832− | AdditionalPropertiesSchema (Referenced Schema)
833− deriving (Eq, Show, Data, Typeable)
835−-- =======================================================================
837−-- =======================================================================
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841−instance Monoid Swagger where
842− mempty = genericMempty
845−instance Semigroup Info where
846− (<>) = genericMappend
847−instance Monoid Info where
848− mempty = genericMempty
851−instance Semigroup Contact where
852− (<>) = genericMappend
853−instance Monoid Contact where
854− mempty = genericMempty
857−instance Semigroup PathItem where
858− (<>) = genericMappend
859−instance Monoid PathItem where
860− mempty = genericMempty
863−instance Semigroup Schema where
864− (<>) = genericMappend
865−instance Monoid Schema where
866− mempty = genericMempty
869−instance Semigroup (ParamSchema t) where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
872− mempty = genericMempty
875−instance Semigroup Param where
876− (<>) = genericMappend
877−instance Monoid Param where
878− mempty = genericMempty
881−instance Semigroup ParamOtherSchema where
882− (<>) = genericMappend
883−instance Monoid ParamOtherSchema where
884− mempty = genericMempty
887−instance Semigroup Header where
888− (<>) = genericMappend
889−instance Monoid Header where
890− mempty = genericMempty
893−instance Semigroup Responses where
894− (<>) = genericMappend
895−instance Monoid Responses where
896− mempty = genericMempty
899−instance Semigroup Response where
900− (<>) = genericMappend
901−instance Monoid Response where
902− mempty = genericMempty
905−instance Semigroup ExternalDocs where
906− (<>) = genericMappend
907−instance Monoid ExternalDocs where
908− mempty = genericMempty
911−instance Semigroup Operation where
912− (<>) = genericMappend
913−instance Monoid Operation where
914− mempty = genericMempty
917−instance Semigroup Example where
918− (<>) = 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−-- =======================================================================
935−-- SwaggerMonoid helper instances
936−-- =======================================================================
938−instance SwaggerMonoid Info
640+newtype URL = URL { getUrl :: Text } deriving (Show, ToJSON, FromJSON)
939−instance SwaggerMonoid PathItem
940−instance SwaggerMonoid Schema
941−instance SwaggerMonoid (ParamSchema t)
942−instance SwaggerMonoid Param
943−instance SwaggerMonoid ParamOtherSchema
944−instance SwaggerMonoid Responses
945−instance SwaggerMonoid Response
946−instance SwaggerMonoid ExternalDocs
947−instance SwaggerMonoid Operation
948−instance SwaggerMonoid SecurityDefinitions
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
951−instance SwaggerMonoid MimeList
952−deriving instance SwaggerMonoid URL
954−instance SwaggerMonoid (SwaggerType t) where
955− swaggerMempty = SwaggerString
956− swaggerMappend _ y = y
958−instance SwaggerMonoid ParamLocation where
959− swaggerMempty = ParamQuery
960− swaggerMappend _ y = y
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963− swaggerMempty = InsOrdHashMap.empty
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
971−instance SwaggerMonoid ParamAnySchema where
972− swaggerMempty = ParamOther swaggerMempty
973− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975− swaggerMappend _ y = y
977-- =======================================================================
642-- =======================================================================
978−-- Simple Generic-based ToJSON instances
643+-- TH derived ToJSON and FromJSON instances
979-- =======================================================================
644-- =======================================================================
981−instance ToJSON ParamLocation where
646+deriveJSON' ''SwaggerOperation
982− toJSON = genericToJSON (jsonPrefix "Param")
647+deriveJSON (jsonPrefix "SwaggerParameter") ''SwaggerParameterLocation
983−
648+deriveJSON (jsonPrefix "SwaggerParam") ''SwaggerParameterType
984−instance ToJSON Info where
649+deriveJSON' ''SwaggerPathItem
985− toJSON = genericToJSON (jsonPrefix "Info")
650+deriveJSON' ''SwaggerInfo
986−
651+deriveJSON' ''SwaggerContact
987−instance ToJSON Contact where
652+deriveJSON' ''SwaggerLicense
988− toJSON = genericToJSON (jsonPrefix "Contact")
653+deriveJSON (jsonPrefix "SwaggerSchema") ''SwaggerSchemaType
989−
654+deriveJSON (jsonPrefix "SwaggerItems") ''SwaggerItemsType
990−instance ToJSON License where
655+deriveJSON (jsonPrefix "SwaggerItemsCollection") ''SwaggerItemsCollectionFormat
991− toJSON = genericToJSON (jsonPrefix "License")
656+deriveJSON (jsonPrefix "SwaggerCollection") ''SwaggerCollectionFormat
992−
657+deriveJSON (jsonPrefix "SwaggerSecuritySchemeType") ''SwaggerSecuritySchemeTypeName
993−instance ToJSON ApiKeyLocation where
658+deriveJSON (jsonPrefix "SwaggerApiKey") ''SwaggerApiKeyLocation
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
659+deriveJSON (jsonPrefix "swaggerApiKey") ''SwaggerApiKeyParams
995−
660+deriveJSON' ''SwaggerResponse
996−instance ToJSON ApiKeyParams where
661+deriveJSON' ''SwaggerSchemaCommon
997− toJSON = genericToJSON (jsonPrefix "apiKey")
662+deriveJSONDefault ''SwaggerScheme
998−
663+deriveJSON' ''SwaggerTag
999−instance ToJSON Scheme where
664+deriveJSON' ''SwaggerExternalDocs
1000− toJSON = genericToJSON (jsonPrefix "")
665+deriveJSON' ''SwaggerXml
1002−instance ToJSON Tag where
1003− toJSON = genericToJSON (jsonPrefix "Tag")
1005−instance ToJSON ExternalDocs where
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
1011−-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
1013−-- =======================================================================
1015−instance FromJSON ParamLocation where
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
1018−instance FromJSON Info where
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
1021−instance FromJSON Contact where
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
1024−instance FromJSON License where
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")
1033−instance FromJSON Scheme where
1034− parseJSON = genericParseJSON (jsonPrefix "")
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
1042-- =======================================================================
667-- =======================================================================
1043-- Manual ToJSON instances
668-- Manual ToJSON instances
1044-- =======================================================================
669-- =======================================================================
1046−instance ToJSON OAuth2Flow where
671+instance ToJSON SwaggerOAuth2Flow where
1047− toJSON (OAuth2Implicit authUrl) = object
672+ toJSON (SwaggerOAuth2Implicit authUrl) = object
1048 [ "flow" .= ("implicit" :: Text)
673 [ "flow" .= ("implicit" :: Text)
1049 , "authorizationUrl" .= authUrl ]
674 , "authorizationUrl" .= authUrl ]
1050− toJSON (OAuth2Password tokenUrl) = object
675+ toJSON (SwaggerOAuth2Password tokenUrl) = object
1051 [ "flow" .= ("password" :: Text)
676 [ "flow" .= ("password" :: Text)
1052 , "tokenUrl" .= tokenUrl ]
677 , "tokenUrl" .= tokenUrl ]
1053− toJSON (OAuth2Application tokenUrl) = object
678+ toJSON (SwaggerOAuth2Application tokenUrl) = object
1054 [ "flow" .= ("application" :: Text)
679 [ "flow" .= ("application" :: Text)
1055 , "tokenUrl" .= tokenUrl ]
680 , "tokenUrl" .= tokenUrl ]
1056− toJSON (OAuth2AccessCode authUrl tokenUrl) = object
681+ toJSON (SwaggerOAuth2AccessCode authUrl tokenUrl) = object
1057 [ "flow" .= ("accessCode" :: Text)
682 [ "flow" .= ("accessCode" :: Text)
1058 , "authorizationUrl" .= authUrl
683 , "authorizationUrl" .= authUrl
1059 , "tokenUrl" .= tokenUrl ]
684 , "tokenUrl" .= tokenUrl ]
1061−instance ToJSON OAuth2Params where
686+instance ToJSON SwaggerOAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
687+ toJSON = genericToJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1065−instance ToJSON SecuritySchemeType where
689+instance ToJSON SwaggerSecuritySchemeType where
1066− toJSON SecuritySchemeBasic
690+ toJSON SwaggerSecuritySchemeBasic
1067− = object [ "type" .= ("basic" :: Text) ]
691+ = object [ "type" .= SwaggerSecuritySchemeTypeBasic ]
1068− toJSON (SecuritySchemeApiKey params)
692+ toJSON (SwaggerSecuritySchemeApiKey params)
1069 = toJSON params
693 = toJSON params
1070− <+> object [ "type" .= ("apiKey" :: Text) ]
694+ <+> object [ "type" .= SwaggerSecuritySchemeTypeApiKey ]
1071− toJSON (SecuritySchemeOAuth2 params)
695+ toJSON (SwaggerSecuritySchemeOAuth2 params)
1072 = toJSON params
696 = toJSON params
1073− <+> object [ "type" .= ("oauth2" :: Text) ]
697+ <+> object [ "type" .= SwaggerSecuritySchemeTypeOAuth2 ]
1075instance ToJSON Swagger where
699instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
700+ toJSON = addVersion . genericToJSON (jsonPrefix "swagger")
1077− DEFINE_TOENCODING
701+ where
1078−
702+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
1079−instance ToJSON SecurityScheme where
703+ addVersion _ = error "impossible"
1080− toJSON = sopSwaggerGenericToJSON
1083−instance ToJSON Schema where
1084− toJSON = sopSwaggerGenericToJSON
1087−instance ToJSON Header where
1088− toJSON = sopSwaggerGenericToJSON
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
1098− toJSON (SwaggerItemsPrimitive fmt schema) = object
1099− [ "collectionFormat" .= fmt
1100− , "items" .= schema ]
1101− toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1102− toJSON (SwaggerItemsArray []) = object
1103− [ "items" .= object []
1104− , "maxItems" .= (0 :: Int)
1105− , "example" .= Array mempty
1107− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1109−instance ToJSON Host where
1110− toJSON (Host host mport) = toJSON $
1113− Just port -> host ++ ":" ++ show port
1115−instance ToJSON MimeList where
705+instance ToJSON SwaggerSecurityScheme where
1116− toJSON (MimeList xs) = toJSON (map show xs)
706+ toJSON = genericToJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
1118−instance ToJSON Param where
708+instance ToJSON SwaggerSchema where
1119− toJSON = sopSwaggerGenericToJSON
709+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerSchema")
1122−instance ToJSON ParamAnySchema where
711+instance ToJSON SwaggerHeader where
1123− toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
712+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerHeader")
1124− toJSON (ParamOther s) = toJSON s
1126−instance ToJSON ParamOtherSchema where
714+instance ToJSON SwaggerItems where
1127− toJSON = sopSwaggerGenericToJSON
715+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerItems")
1130−instance ToJSON Responses where
717+instance ToJSON SwaggerHost where
1131− toJSON = sopSwaggerGenericToJSON
718+ toJSON (SwaggerHost host mport) = toJSON $
1132− DEFINE_TOENCODING
719+ case mport of
1133−
720+ Nothing -> host
1134−instance ToJSON Response where
721+ Just port -> host ++ ":" ++ show port
1135− toJSON = sopSwaggerGenericToJSON
1138−instance ToJSON Operation where
1139− toJSON = sopSwaggerGenericToJSON
1142−instance ToJSON PathItem where
1143− toJSON = sopSwaggerGenericToJSON
1146−instance ToJSON Example where
723+instance ToJSON SwaggerPaths where
1147− toJSON = toJSON . Map.mapKeys show . getExample
724+ toJSON (SwaggerPaths m) = toJSON m
1149−instance ToJSON SecurityDefinitions where
726+instance ToJSON SwaggerMimeList where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
727+ toJSON (SwaggerMimeList xs) = toJSON (map show xs)
1152−instance ToJSON Reference where
729+instance ToJSON SwaggerParameter where
1153− toJSON (Reference ref) = object [ "$ref" .= ref ]
730+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "swaggerParameter")
1155−referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
732+instance ToJSON SwaggerParameterSchema where
1156−referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
733+ toJSON (SwaggerParameterBody s) = toJSON s <+> object [ "in" .= ("body" :: Text) ]
1157−referencedToJSON _ (Inline x) = toJSON x
734+ toJSON (SwaggerParameterOther s) = toJSON s
1159−instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
736+instance ToJSON SwaggerParameterOtherSchema where
1160−instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
737+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
1161−instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
1163−instance ToJSON (SwaggerType t) where
739+instance ToJSON SwaggerSchemaItems where
1164− toJSON SwaggerArray = "array"
740+ toJSON (SwaggerSchemaItemsObject x) = toJSON x
1165− toJSON SwaggerString = "string"
741+ toJSON (SwaggerSchemaItemsArray xs) = toJSON xs
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
743+instance ToJSON SwaggerResponses where
1174− toJSON CollectionCSV = "csv"
744+ toJSON (SwaggerResponses def rs) = object
1175− toJSON CollectionSSV = "ssv"
745+ [ "default" .= def
1176− toJSON CollectionTSV = "tsv"
746+ , "responses" .= hashMapMapKeys show rs ]
1177− toJSON CollectionPipes = "pipes"
1178− toJSON CollectionMulti = "multi"
1180−instance ToJSON (ParamSchema k) where
748+instance ToJSON SwaggerExample where
1181− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
749+ toJSON = toJSON . Map.mapKeys show . getSwaggerExample
1182− toJSON = sopSwaggerGenericToJSONWithOpts $
1183− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1185−instance ToJSON AdditionalProperties where
751+instance ToJSON SwaggerSecurityRequirement where
1186− toJSON (AdditionalPropertiesAllowed b) = toJSON b
752+ toJSON (SwaggerSecurityRequirement m) = toJSON (hashMapMapKeys swaggerSecuritySchemeTypeNameToText m)
1187− toJSON (AdditionalPropertiesSchema s) = toJSON s
1189-- =======================================================================
754-- =======================================================================
1190-- Manual FromJSON instances
755-- Manual FromJSON instances
1191-- =======================================================================
756-- =======================================================================
1193−instance FromJSON OAuth2Flow where
758+instance FromJSON SwaggerOAuth2Flow where
1194 parseJSON (Object o) = do
759 parseJSON (Object o) = do
1195 (flow :: Text) <- o .: "flow"
760 (flow :: Text) <- o .: "flow"
1196 case flow of
761 case flow of
1197− "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
762+ "implicit" -> SwaggerOAuth2Implicit <$> o .: "authorizationUrl"
1198− "password" -> OAuth2Password <$> o .: "tokenUrl"
763+ "password" -> SwaggerOAuth2Password <$> o .: "tokenUrl"
1199− "application" -> OAuth2Application <$> o .: "tokenUrl"
764+ "application" -> SwaggerOAuth2Application <$> o .: "tokenUrl"
1200− "accessCode" -> OAuth2AccessCode
765+ "accessCode" -> SwaggerOAuth2AccessCode
1201 <$> o .: "authorizationUrl"
766 <$> o .: "authorizationUrl"
1202 <*> o .: "tokenUrl"
767 <*> o .: "tokenUrl"
1203 _ -> empty
768 _ -> empty
1204 parseJSON _ = empty
769 parseJSON _ = empty
1206−instance FromJSON OAuth2Params where
771+instance FromJSON SwaggerOAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
772+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1209−instance FromJSON SecuritySchemeType where
774+instance FromJSON SwaggerSecuritySchemeType where
1210− parseJSON js@(Object o) = do
775+ parseJSON json@(Object o) = do
1211− (t :: Text) <- o .: "type"
776+ t <- o .: "type"
1212 case t of
777 case t of
1213− "basic" -> pure SecuritySchemeBasic
778+ SwaggerSecuritySchemeTypeBasic -> pure SwaggerSecuritySchemeBasic
1214− "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
779+ SwaggerSecuritySchemeTypeApiKey -> SwaggerSecuritySchemeApiKey <$> parseJSON json
1215− "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
780+ SwaggerSecuritySchemeTypeOAuth2 -> SwaggerSecuritySchemeOAuth2 <$> parseJSON json
1217 parseJSON _ = empty
781 parseJSON _ = empty
1219instance FromJSON Swagger where
783instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
784+ parseJSON json@(Object o) = do
1221−
785+ (version :: Text) <- o .: "swagger"
1222−instance FromJSON SecurityScheme where
786+ when (version /= "2.0") empty
1223− parseJSON = sopSwaggerGenericParseJSON
787+ genericParseJSON (jsonPrefix "swagger") json
1225−instance FromJSON Schema where
1226− parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1227− where nullaryCleanup :: Schema -> Schema
1228− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230− then s { _schemaExample = Nothing
1231− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1234−instance FromJSON Header where
1235− parseJSON = sopSwaggerGenericParseJSON
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
1243− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
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
788 parseJSON _ = empty
1265−instance FromJSON Host where
790+instance FromJSON SwaggerSecurityScheme where
791+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
793+instance FromJSON SwaggerSchema where
794+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerSchema")
796+instance FromJSON SwaggerHeader where
797+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerHeader")
799+instance FromJSON SwaggerItems where
800+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerItems")
802+instance FromJSON SwaggerHost where
1266− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
803+ parseJSON (String s) =
1267− [host] -> return $ Host host Nothing
804+ case fromInteger <$> readMaybe portStr of
1268− [host, port] -> case readMaybe port of
805+ Nothing | not (null portStr) -> empty
1269− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
806+ mport -> pure $ SwaggerHost host mport
1270− Just p -> return $ Host host (Just (fromInteger p))
807+ where
808+ (hostText, portText) = Text.breakOnEnd ":" s
1271− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
809+ [host, portStr] = map Text.unpack [hostText, portText]
1272 parseJSON _ = empty
810 parseJSON _ = empty
1274−instance FromJSON MimeList where
812+instance FromJSON SwaggerPaths where
813+ parseJSON json = SwaggerPaths <$> parseJSON json
815+instance FromJSON SwaggerMimeList where
1275− parseJSON js = (MimeList . map fromString) <$> parseJSON js
816+ parseJSON json = (SwaggerMimeList . map fromString) <$> parseJSON json
1277−instance FromJSON Param where
818+instance FromJSON SwaggerParameter where
1278− parseJSON = sopSwaggerGenericParseJSON
819+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "swaggerParameter")
1280−instance FromJSON ParamAnySchema where
821+instance FromJSON SwaggerParameterSchema where
1281− parseJSON js@(Object o) = do
822+ parseJSON json@(Object o) = do
1282 (i :: Text) <- o .: "in"
823 (i :: Text) <- o .: "in"
1283 case i of
824 case i of
1284− "body" -> do
825+ "body" -> SwaggerParameterBody <$> parseJSON json
1285− schema <- o .: "schema"
826+ _ -> SwaggerParameterOther <$> parseJSON json
1286− ParamBody <$> parseJSON schema
1287− _ -> ParamOther <$> parseJSON js
1288 parseJSON _ = empty
827 parseJSON _ = empty
1290−instance FromJSON ParamOtherSchema where
829+instance FromJSON SwaggerParameterOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
830+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
1293−instance FromJSON Responses where
832+instance FromJSON SwaggerSchemaItems where
1294− parseJSON (Object o) = Responses
833+ parseJSON json@(Object _) = SwaggerSchemaItemsObject <$> parseJSON json
1295− <$> o .:? "default"
834+ parseJSON json@(Array _) = SwaggerSchemaItemsArray <$> parseJSON json
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1297 parseJSON _ = empty
835 parseJSON _ = empty
1299−instance FromJSON Example where
837+instance FromJSON SwaggerResponses where
1300− parseJSON js = do
838+ parseJSON (Object o) = SwaggerResponses
1301− m <- parseJSON js
839+ <$> o .: "default"
1302− pure $ Example (Map.mapKeys fromString m)
840+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1303−
841+ parseJSON _ = empty
1304−instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1307−instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1310−instance FromJSON PathItem where
1311− parseJSON = sopSwaggerGenericParseJSON
1313−instance FromJSON SecurityDefinitions where
843+instance FromJSON SwaggerExample where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
844+ parseJSON json = do
846+ pure $ SwaggerExample (Map.mapKeys fromString m)
1316−instance FromJSON Reference where
848+instance FromJSON SwaggerSecurityRequirement where
1317− parseJSON (Object o) = Reference <$> o .: "$ref"
849+ parseJSON json = do
1318− parseJSON _ = empty
850+ m <- parseJSON json
851+ SwaggerSecurityRequirement <$> hashMapTraverseKeys swaggerSecuritySchemeTypeNameFromText m
1320−referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
1321−referencedParseJSON prefix js@(Object o) = do
1324− Nothing -> Inline <$> parseJSON js
1325− Just s -> Ref <$> parseRef s
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/"
1337−instance FromJSON Xml where
1338− 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