@@ -1,636 +1,457 @@
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+ swaggerInfo :: SwaggerInfo
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+ , swaggerHost :: Maybe SwaggerHost
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+ , swaggerBasePath :: 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+ , swaggerSchemes :: Maybe [SwaggerScheme]
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+ , swaggerConsumes :: SwaggerMimeList
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+ , swaggerProduces :: SwaggerMimeList
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+ , 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.
64 -- | An object to hold data types produced and consumed by operations.
109− , _swaggerDefinitions :: Definitions Schema
65+ , swaggerDefinitions :: HashMap Text SwaggerSchema
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+ , swaggerParameters :: HashMap Text SwaggerParameter
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+ , swaggerResponses :: HashMap Text SwaggerResponse
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+ , swaggerSecurityDefinitions :: HashMap Text SwaggerSecurityScheme
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+ , swaggerSecurity :: [SwaggerSecurityRequirement]
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+ , swaggerTags :: [SwaggerTag]
135 -- | Additional external documentation.
91 -- | Additional external documentation.
136− , _swaggerExternalDocs :: Maybe ExternalDocs
92+ , swaggerExternalDocs :: SwaggerExternalDocs
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,
141-- and can be presented in the Swagger-UI for convenience.
97-- and can be presented in the Swagger-UI for convenience.
142−data Info = Info
98+data SwaggerInfo = SwaggerInfo
143 { -- | The title of the application.
99 { -- | The title of the application.
144− _infoTitle :: Text
100+ swaggerInfoTitle :: Text
146 -- | A short description of the application.
102 -- | A short description of the application.
147 -- GFM syntax can be used for rich text representation.
103 -- GFM syntax can be used for rich text representation.
148− , _infoDescription :: Maybe Text
104+ , swaggerInfoDescription :: Maybe Text
150 -- | The Terms of Service for the API.
106 -- | The Terms of Service for the API.
151− , _infoTermsOfService :: Maybe Text
107+ , swaggerInfoTermsOfService :: Maybe Text
153 -- | The contact information for the exposed API.
109 -- | The contact information for the exposed API.
154− , _infoContact :: Maybe Contact
110+ , swaggerInfoContact :: Maybe SwaggerContact
156 -- | The license information for the exposed API.
112 -- | The license information for the exposed API.
157− , _infoLicense :: Maybe License
113+ , swaggerInfoLicense :: Maybe SwaggerLicense
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+ , swaggerInfoVersion :: 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.
165−data Contact = Contact
121+data SwaggerContact = SwaggerContact
166 { -- | The identifying name of the contact person/organization.
122 { -- | The identifying name of the contact person/organization.
167− _contactName :: Maybe Text
123+ swaggerContactName :: Maybe Text
169 -- | The URL pointing to the contact information.
125 -- | The URL pointing to the contact information.
170− , _contactUrl :: Maybe URL
126+ , swaggerContactUrl :: Maybe URL
172 -- | The email address of the contact person/organization.
128 -- | The email address of the contact person/organization.
173− , _contactEmail :: Maybe Text
129+ , swaggerContactEmail :: 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.
177−data License = License
133+data SwaggerLicense = SwaggerLicense
178 { -- | The license name used for the API.
134 { -- | The license name used for the API.
179− _licenseName :: Text
135+ swaggerLicenseName :: Text
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+ , swaggerLicenseUrl :: 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.
189−data Host = Host
142+data SwaggerHost = SwaggerHost
190− { _hostName :: HostName -- ^ Host name.
143+ { swaggerHostName :: HostName -- ^ Host name.
191− , _hostPort :: Maybe PortNumber -- ^ Optional port.
144+ , swaggerHostPort :: 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.
211−data Scheme
148+data SwaggerScheme
216− deriving (Eq, Show, Generic, Data, Typeable)
153+ deriving (Eq, Show)
155+-- | The available paths and operations for the API.
156+data SwaggerPaths = SwaggerPaths
157+ { -- | Holds the relative paths to the individual endpoints.
158+ -- The path is appended to the @'swaggerBasePath'@ in order to construct the full URL.
159+ swaggerPathsMap :: HashMap FilePath SwaggerPathItem
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 @'SwaggerPathItem'@ may be empty, due to ACL constraints.
220-- The path itself is still exposed to the documentation viewer
164-- The path itself is still exposed to the documentation viewer
221-- but they will not know which operations and parameters are available.
165-- but they will not know which operations and parameters are available.
222−data PathItem = PathItem
166+data SwaggerPathItem = SwaggerPathItem
223 { -- | A definition of a GET operation on this path.
167 { -- | A definition of a GET operation on this path.
224− _pathItemGet :: Maybe Operation
168+ swaggerPathItemGet :: Maybe SwaggerOperation
226 -- | A definition of a PUT operation on this path.
170 -- | A definition of a PUT operation on this path.
227− , _pathItemPut :: Maybe Operation
171+ , swaggerPathItemPut :: Maybe SwaggerOperation
229 -- | A definition of a POST operation on this path.
173 -- | A definition of a POST operation on this path.
230− , _pathItemPost :: Maybe Operation
174+ , swaggerPathItemPost :: Maybe SwaggerOperation
232 -- | A definition of a DELETE operation on this path.
176 -- | A definition of a DELETE operation on this path.
233− , _pathItemDelete :: Maybe Operation
177+ , swaggerPathItemDelete :: Maybe SwaggerOperation
235 -- | A definition of a OPTIONS operation on this path.
179 -- | A definition of a OPTIONS operation on this path.
236− , _pathItemOptions :: Maybe Operation
180+ , swaggerPathItemOptions :: Maybe SwaggerOperation
238 -- | A definition of a HEAD operation on this path.
182 -- | A definition of a HEAD operation on this path.
239− , _pathItemHead :: Maybe Operation
183+ , swaggerPathItemHead :: Maybe SwaggerOperation
241 -- | A definition of a PATCH operation on this path.
185 -- | A definition of a PATCH operation on this path.
242− , _pathItemPatch :: Maybe Operation
186+ , swaggerPathItemPatch :: Maybe SwaggerOperation
244 -- | A list of parameters that are applicable for all the operations described under this path.
188 -- | 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.
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+ , swaggerPathItemParameters :: [SwaggerParameter]
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.
252−data Operation = Operation
196+data SwaggerOperation = SwaggerOperation
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+ swaggerOperationTags :: [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.
259− , _operationSummary :: Maybe Text
203+ , swaggerOperationSummary :: Maybe Text
261 -- | A verbose explanation of the operation behavior.
205 -- | A verbose explanation of the operation behavior.
262 -- GFM syntax can be used for rich text representation.
206 -- GFM syntax can be used for rich text representation.
263− , _operationDescription :: Maybe Text
207+ , swaggerOperationDescription :: Maybe Text
265 -- | Additional external documentation for this operation.
209 -- | Additional external documentation for this operation.
266− , _operationExternalDocs :: Maybe ExternalDocs
210+ , swaggerOperationExternalDocs :: Maybe SwaggerExternalDocs
268 -- | Unique string used to identify the operation.
212 -- | Unique string used to identify the operation.
269 -- The id MUST be unique among all operations described in the API.
213 -- 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,
214 -- Tools and libraries MAY use the it to uniquely identify an operation,
271 -- therefore, it is recommended to follow common programming naming conventions.
215 -- therefore, it is recommended to follow common programming naming conventions.
272− , _operationOperationId :: Maybe Text
216+ , swaggerOperationOperationId :: Maybe Text
274 -- | A list of MIME types the operation can consume.
218 -- | A list of MIME types the operation can consume.
275− -- This overrides the @'consumes'@.
219+ -- This overrides the @'swaggerConsumes'@.
276 -- @Just []@ MAY be used to clear the global definition.
220 -- @Just []@ MAY be used to clear the global definition.
277− , _operationConsumes :: Maybe MimeList
221+ , swaggerOperationConsumes :: Maybe SwaggerMimeList
279 -- | A list of MIME types the operation can produce.
223 -- | A list of MIME types the operation can produce.
280− -- This overrides the @'produces'@.
224+ -- This overrides the @'swaggerProduces'@.
281 -- @Just []@ MAY be used to clear the global definition.
225 -- @Just []@ MAY be used to clear the global definition.
282− , _operationProduces :: Maybe MimeList
226+ , swaggerOperationProduces :: Maybe SwaggerMimeList
284 -- | A list of parameters that are applicable for this operation.
228 -- | A list of parameters that are applicable for this operation.
285− -- If a parameter is already defined at the @'PathItem'@,
229+ -- If a parameter is already defined at the @'SwaggerPathItem'@,
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+ , swaggerOperationParameters :: [SwaggerParameter]
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+ , swaggerOperationResponses :: SwaggerResponses
294 -- | The transfer protocol for the operation.
238 -- | The transfer protocol for the operation.
295− -- The value overrides @'schemes'@.
239+ -- The value overrides @'swaggerSchemes'@.
296− , _operationSchemes :: Maybe [Scheme]
240+ , swaggerOperationSchemes :: Maybe [SwaggerScheme]
298 -- | Declares this operation to be deprecated.
242 -- | Declares this operation to be deprecated.
299 -- Usage of the declared operation should be refrained.
243 -- Usage of the declared operation should be refrained.
300 -- Default value is @False@.
244 -- Default value is @False@.
301− , _operationDeprecated :: Maybe Bool
245+ , swaggerOperationDeprecated :: Bool
303 -- | A declaration of which security schemes are applied for this operation.
247 -- | A declaration of which security schemes are applied for this operation.
304 -- The list of values describes alternative security schemes that can be used
248 -- The list of values describes alternative security schemes that can be used
305 -- (that is, there is a logical OR between the security requirements).
249 -- (that is, there is a logical OR between the security requirements).
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+ , swaggerOperationSecurity :: [SwaggerSecurityRequirement]
309− } deriving (Eq, Show, Generic, Data, Typeable)
253+ } deriving (Eq, Show, Generic)
311−newtype MimeList = MimeList { getMimeList :: [MediaType] }
312− deriving (Eq, Show, Semigroup, Monoid, Typeable)
314−mimeListConstr :: Constr
255+newtype SwaggerMimeList = SwaggerMimeList { getSwaggerMimeList :: [MediaType] }
315−mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
256+ deriving (Eq, Show, Monoid)
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 SwaggerParameter = SwaggerParameter
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+ swaggerParameterName :: 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+ , swaggerParameterDescription :: 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+ , swaggerParameterRequired :: Bool
344 -- | Parameter schema.
275 -- | Parameter schema.
345− , _paramSchema :: ParamAnySchema
276+ , swaggerParameterSchema :: SwaggerParameterSchema
346− } deriving (Eq, Show, Generic, Data, Typeable)
277+ } deriving (Eq, Show, Generic)
348−data ParamAnySchema
279+data SwaggerParameterSchema
349− = ParamBody (Referenced Schema)
280+ = SwaggerParameterBody SwaggerSchema
350− | ParamOther ParamOtherSchema
281+ | SwaggerParameterOther SwaggerParameterOtherSchema
351− deriving (Eq, Show, Generic, Data, Typeable)
282+ deriving (Eq, Show)
353−data ParamOtherSchema = ParamOtherSchema
284+data SwaggerParameterOtherSchema = SwaggerParameterOtherSchema
354 { -- | The location of the parameter.
285 { -- | The location of the parameter.
355− _paramOtherSchemaIn :: ParamLocation
286+ swaggerParameterOtherSchemaIn :: SwaggerParameterLocation
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 @'SwaggerParamFile'@, the @consumes@ MUST be either
292+ -- "multipart/form-data" or " application/x-www-form-urlencoded"
293+ -- and the parameter MUST be in @'SwaggerParameterFormData'@.
294+ , swaggerParameterOtherSchemaType :: SwaggerParameterType
296+ -- | The extending format for the previously mentioned type.
297+ , swaggerParameterOtherSchemaFormat :: Maybe SwaggerFormat
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 @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@
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+ , swaggerParameterOtherSchemaAllowEmptyValue :: Bool
363− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
305+ -- | __Required if type is @'SwaggerParamArray'@__.
364− } deriving (Eq, Show, Generic, Typeable, Data)
306+ -- Describes the type of items in the array.
365−
307+ , swaggerParameterOtherSchemaItems :: Maybe SwaggerItems
366−-- | Items for @'SwaggerArray'@ schemas.
308+
367−--
309+ -- | Determines the format of the array if @'SwaggerParamArray'@ 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+ , swaggerParameterOtherSchemaCollectionFormat :: Maybe SwaggerCollectionFormat
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+ , swaggerParameterOtherSchemaCommon :: SwaggerSchemaCommon
372−--
314+ } deriving (Eq, Show, Generic)
373−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
315+
374−--
316+data SwaggerParameterType
375−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
317+ = SwaggerParamString
376−data SwaggerItems t where
318+ | SwaggerParamNumber
377− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
319+ | SwaggerParamInteger
378− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
320+ | SwaggerParamBoolean
379− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
321+ | SwaggerParamArray
380− deriving (Typeable)
322+ | SwaggerParamFile
381−
323+ deriving (Eq, Show)
382−deriving instance Eq (SwaggerItems t)
324+
383−deriving instance Show (SwaggerItems t)
325+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.
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+ SwaggerParameterQuery
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+ | SwaggerParameterHeader
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+ | SwaggerParameterPath
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).
511− -- This is the only parameter type that can be used to send files, thus supporting the @'ParamFile'@ type.
338+ -- 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.
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+ | SwaggerParameterFormData
516− deriving (Eq, Show, Generic, Data, Typeable)
343+ deriving (Eq, Show)
518−type Format = Text
345+type SwaggerFormat = Text
520-- | Determines the format of the array.
347-- | Determines the format of the array.
521−data CollectionFormat t where
348+data SwaggerCollectionFormat
522− -- Comma separated values: @foo,bar@.
349+ = SwaggerCollectionCSV -- ^ Comma separated values: @foo,bar@.
523− CollectionCSV :: CollectionFormat t
524− -- Space separated values: @foo bar@.
350+ | SwaggerCollectionSSV -- ^ Space separated values: @foo bar@.
525− CollectionSSV :: CollectionFormat t
526− -- Tab separated values: @foo\\tbar@.
351+ | SwaggerCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
527− CollectionTSV :: CollectionFormat t
528− -- Pipe separated values: @foo|bar@.
352+ | SwaggerCollectionPipes -- ^ Pipe separated values: @foo|bar@.
529− CollectionPipes :: CollectionFormat t
530− -- Corresponds to multiple parameter instances
353+ | SwaggerCollectionMulti -- ^ 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 @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@.
533− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534− deriving (Typeable)
356+ deriving (Eq, Show)
536−deriving instance Eq (CollectionFormat t)
358+data SwaggerItemsType
537−deriving instance Show (CollectionFormat t)
359+ = SwaggerItemsString
538−
360+ | SwaggerItemsNumber
539−collectionFormatConstr :: CollectionFormat t -> Constr
361+ | SwaggerItemsInteger
540−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
362+ | SwaggerItemsBoolean
541−
363+ | SwaggerItemsArray
542−collectionFormatDataType :: DataType
364+ deriving (Eq, Show)
543−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
365+
544− map collectionFormatConstr collectionCommonFormats
366+data SwaggerSchemaType
545−
367+ = SwaggerSchemaArray
546−collectionCommonFormats :: [CollectionFormat t]
368+ | SwaggerSchemaBoolean
547−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
369+ | SwaggerSchemaInteger
548−
370+ | SwaggerSchemaNumber
549−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
371+ | SwaggerSchemaNull
550− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
372+ | SwaggerSchemaObject
551− toConstr = collectionFormatConstr
373+ | SwaggerSchemaString
552− dataTypeOf _ = collectionFormatDataType
374+ deriving (Eq, Show)
554−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
376+-- | Determines the format of the nested array.
555−
377+data SwaggerItemsCollectionFormat
556−type ParamName = Text
378+ = SwaggerItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
557−
379+ | SwaggerItemsCollectionSSV -- ^ Space separated values: @foo bar@.
558−data Schema = Schema
380+ | SwaggerItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
559− { _schemaTitle :: Maybe Text
381+ | SwaggerItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
560− , _schemaDescription :: Maybe Text
382+ deriving (Eq, Show)
561− , _schemaRequired :: [ParamName]
383+
562−
384+type SwaggerParamName = Text
563− , _schemaAllOf :: Maybe [Referenced Schema]
385+
564− , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
386+data SwaggerSchema = SwaggerSchema
565− , _schemaAdditionalProperties :: Maybe AdditionalProperties
387+ { swaggerSchemaType :: SwaggerSchemaType
566−
388+ , swaggerSchemaFormat :: Maybe SwaggerFormat
567− , _schemaDiscriminator :: Maybe Text
389+ , swaggerSchemaTitle :: Maybe Text
568− , _schemaReadOnly :: Maybe Bool
390+ , swaggerSchemaDescription :: Maybe Text
569− , _schemaXml :: Maybe Xml
391+ , swaggerSchemaRequired :: [SwaggerParamName]
570− , _schemaExternalDocs :: Maybe ExternalDocs
392+
571− , _schemaExample :: Maybe Value
393+ , swaggerSchemaItems :: Maybe SwaggerSchemaItems
572−
394+ , swaggerSchemaAllOf :: Maybe [SwaggerSchema]
573− , _schemaMaxProperties :: Maybe Integer
395+ , swaggerSchemaProperties :: HashMap Text SwaggerSchema
574− , _schemaMinProperties :: Maybe Integer
396+ , swaggerSchemaAdditionalProperties :: Maybe SwaggerSchema
576− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
398+ , swaggerSchemaDiscriminator :: Maybe Text
399+ , swaggerSchemaReadOnly :: Maybe Bool
400+ , swaggerSchemaXml :: Maybe SwaggerXml
401+ , swaggerSchemaExternalDocs :: Maybe SwaggerExternalDocs
402+ , swaggerSchemaExample :: Maybe Value
404+ , swaggerSchemaMaxProperties :: Maybe Integer
405+ , swaggerSchemaMinProperties :: Maybe Integer
407+ , swaggerSchemaCommon :: SwaggerSchemaCommon
577− } deriving (Eq, Show, Generic, Data, Typeable)
408+ } deriving (Eq, Show, Generic)
579−-- | A @'Schema'@ with an optional name.
410+data SwaggerSchemaItems
580−-- This name can be used in references.
411+ = SwaggerSchemaItemsObject SwaggerSchema
581−data NamedSchema = NamedSchema
412+ | SwaggerSchemaItemsArray [SwaggerSchema]
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 SwaggerSchemaCommon = SwaggerSchemaCommon
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+ swaggerSchemaDefault :: Maybe Value
597− , _paramSchemaType :: Maybe (SwaggerType t)
423+ , swaggerSchemaMaximum :: Maybe Integer
598− , _paramSchemaFormat :: Maybe Format
424+ , swaggerSchemaExclusiveMaximum :: Maybe Bool
599− , _paramSchemaItems :: Maybe (SwaggerItems t)
425+ , swaggerSchemaMinimum :: Maybe Integer
600− , _paramSchemaMaximum :: Maybe Scientific
426+ , swaggerSchemaExclusiveMinimum :: Maybe Bool
601− , _paramSchemaExclusiveMaximum :: Maybe Bool
427+ , swaggerSchemaMaxLength :: Maybe Integer
602− , _paramSchemaMinimum :: Maybe Scientific
428+ , swaggerSchemaMinLength :: Maybe Integer
603− , _paramSchemaExclusiveMinimum :: Maybe Bool
429+ , swaggerSchemaPattern :: Maybe Text
604− , _paramSchemaMaxLength :: Maybe Integer
430+ , swaggerSchemaMaxItems :: Maybe Integer
605− , _paramSchemaMinLength :: Maybe Integer
431+ , swaggerSchemaMinItems :: Maybe Integer
606− , _paramSchemaPattern :: Maybe Pattern
432+ , swaggerSchemaUniqueItems :: Maybe Bool
607− , _paramSchemaMaxItems :: Maybe Integer
433+ , swaggerSchemaEnum :: Maybe [Value]
608− , _paramSchemaMinItems :: Maybe Integer
434+ , swaggerSchemaMultipleOf :: 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)
437+data SwaggerXml = SwaggerXml
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 @'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),
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.
622− _xmlName :: Maybe Text
443+ swaggerXmlName :: Maybe Text
624 -- | The URL of the namespace definition.
445 -- | The URL of the namespace definition.
625 -- Value SHOULD be in the form of a URL.
446 -- Value SHOULD be in the form of a URL.
626− , _xmlNamespace :: Maybe Text
447+ , swaggerXmlNamespace :: Maybe Text
628 -- | The prefix to be used for the name.
449 -- | The prefix to be used for the name.
629− , _xmlPrefix :: Maybe Text
450+ , swaggerXmlPrefix :: Maybe Text
631 -- | Declares whether the property definition translates to an attribute instead of an element.
452 -- | Declares whether the property definition translates to an attribute instead of an element.
632 -- Default value is @False@.
453 -- Default value is @False@.
633− , _xmlAttribute :: Maybe Bool
454+ , swaggerXmlAttribute :: Bool
635 -- | MAY be used only for an array definition.
456 -- | MAY be used only for an array definition.
636 -- Signifies whether the array is wrapped
457 -- Signifies whether the array is wrapped
@@ -638,87 +459,103 @@ data Xml = Xml
638 -- or unwrapped (@\<book/\>\<book/\>@).
459 -- or unwrapped (@\<book/\>\<book/\>@).
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+ , swaggerXmlWrapped :: Bool
642− } deriving (Eq, Show, Generic, Data, Typeable)
463+ } deriving (Eq, Show)
465+data SwaggerItems = SwaggerItems
466+ { -- | The internal type of the array.
467+ swaggerItemsType :: SwaggerItemsType
469+ -- | The extending format for the previously mentioned type.
470+ , swaggerItemsFormat :: SwaggerFormat
472+ -- | __Required if type is @'SwaggerItemsArray'@.__
473+ -- Describes the type of items in the array.
474+ , swaggerItemsItems :: SwaggerItems
476+ -- | Determines the format of the array if type array is used.
477+ -- Default value is @'SwaggerItemsCollectionCSV'@.
478+ , swaggerItemsCollectionFormat :: SwaggerItemsCollectionFormat
480+ , swaggerItemsCommon :: SwaggerSchemaCommon
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.
646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
485-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
647-- since they may not be known in advance.
486-- 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.
487-- However, it is expected from the documentation to cover a successful operation response and any known errors.
649−data Responses = Responses
488+data SwaggerResponses = SwaggerResponses
650 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
489 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
651 -- It can be used to cover undeclared responses.
490 -- It can be used to cover undeclared responses.
652− _responsesDefault :: Maybe (Referenced Response)
491+ swaggerResponsesDefault :: Maybe SwaggerResponse
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+ , swaggerResponsesResponses :: HashMap HttpStatusCode SwaggerResponse
657− } deriving (Eq, Show, Generic, Data, Typeable)
496+ } deriving (Eq, Show, Generic)
659type HttpStatusCode = Int
498type HttpStatusCode = Int
661-- | Describes a single response from an API Operation.
500-- | Describes a single response from an API Operation.
662−data Response = Response
501+data SwaggerResponse = SwaggerResponse
663 { -- | A short description of the response.
502 { -- | A short description of the response.
664 -- GFM syntax can be used for rich text representation.
503 -- GFM syntax can be used for rich text representation.
665− _responseDescription :: Text
504+ swaggerResponseDescription :: Text
667 -- | A definition of the response structure.
506 -- | A definition of the response structure.
668 -- It can be a primitive, an array or an object.
507 -- 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.
508 -- 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".
509 -- 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.
510 -- This SHOULD be accompanied by a relevant produces mime-type.
672− , _responseSchema :: Maybe (Referenced Schema)
511+ , swaggerResponseSchema :: Maybe SwaggerSchema
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+ , swaggerResponseHeaders :: HashMap HeaderName SwaggerHeader
677 -- | An example of the response message.
516 -- | An example of the response message.
678− , _responseExamples :: Maybe Example
517+ , swaggerResponseExamples :: Maybe SwaggerExample
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
686−data Header = Header
522+data SwaggerHeader = SwaggerHeader
687 { -- | A short description of the header.
523 { -- | A short description of the header.
688− _headerDescription :: Maybe Text
524+ swaggerHeaderDescription :: Maybe String
526+ -- | The type of the object.
527+ , swaggerHeaderType :: SwaggerItemsType
690− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
529+ -- | The extending format for the previously mentioned type. See Data Type Formats for further details.
691− } deriving (Eq, Show, Generic, Data, Typeable)
530+ , swaggerHeaderFormat :: Maybe SwaggerFormat
693−data Example = Example { getExample :: Map MediaType Value }
532+ -- | __Required if type is @'SwaggerItemsArray'@__.
694− deriving (Eq, Show, Generic, Typeable)
533+ -- Describes the type of items in the array.
534+ , swaggerHeaderItems :: SwaggerItems
696−exampleConstr :: Constr
536+ -- | Determines the format of the array if type array is used.
697−exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
537+ -- Default value is @'SwaggerItemsCollectionCSV'@.
538+ , swaggerHeaderCollectionFormat :: SwaggerItemsCollectionFormat
699−exampleDataType :: DataType
540+ , swaggerHeaderCommon :: SwaggerSchemaCommon
700−exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
541+ } deriving (Eq, Show, Generic)
702−instance Data Example where
543+data SwaggerExample = SwaggerExample { getSwaggerExample :: Map MediaType Value }
703− gunfold k z c = case constrIndex c of
544+ deriving (Eq, Show)
704− 1 -> k (z (\m -> Example (Map.mapKeys fromString m)))
705− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Example."
706− toConstr (Example _) = exampleConstr
707− dataTypeOf _ = exampleDataType
709-- | The location of the API key.
546-- | The location of the API key.
710−data ApiKeyLocation
547+data SwaggerApiKeyLocation
711− = ApiKeyQuery
548+ = SwaggerApiKeyQuery
712− | ApiKeyHeader
549+ | SwaggerApiKeyHeader
713− deriving (Eq, Show, Generic, Data, Typeable)
550+ deriving (Eq, Show)
715−data ApiKeyParams = ApiKeyParams
552+data SwaggerApiKeyParams = SwaggerApiKeyParams
716 { -- | The name of the header or query parameter to be used.
553 { -- | The name of the header or query parameter to be used.
717− _apiKeyName :: Text
554+ swaggerApiKeyName :: Text
719 -- | The location of the API key.
556 -- | The location of the API key.
720− , _apiKeyIn :: ApiKeyLocation
557+ , swaggerApiKeyIn :: SwaggerApiKeyLocation
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
@@ -726,702 +563,396 @@ type AuthorizationURL = Text
726-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
563-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
727type TokenURL = Text
564type TokenURL = Text
729−data OAuth2Flow
566+data SwaggerOAuth2Flow
730− = OAuth2Implicit AuthorizationURL
567+ = SwaggerOAuth2Implicit AuthorizationURL
731− | OAuth2Password TokenURL
568+ | SwaggerOAuth2Password TokenURL
732− | OAuth2Application TokenURL
569+ | SwaggerOAuth2Application TokenURL
733− | OAuth2AccessCode AuthorizationURL TokenURL
570+ | SwaggerOAuth2AccessCode AuthorizationURL TokenURL
734− deriving (Eq, Show, Generic, Data, Typeable)
571+ deriving (Eq, Show)
736−data OAuth2Params = OAuth2Params
573+data SwaggerOAuth2Params = SwaggerOAuth2Params
737 { -- | The flow used by the OAuth2 security scheme.
574 { -- | The flow used by the OAuth2 security scheme.
738− _oauth2Flow :: OAuth2Flow
575+ swaggerOAuth2Flow :: SwaggerOAuth2Flow
740 -- | The available scopes for the OAuth2 security scheme.
577 -- | The available scopes for the OAuth2 security scheme.
741− , _oauth2Scopes :: InsOrdHashMap Text Text
578+ , swaggerOAuth2Scopes :: HashMap Text Text
742− } deriving (Eq, Show, Generic, Data, Typeable)
579+ } deriving (Eq, Show, Generic)
744−data SecuritySchemeType
581+data SwaggerSecuritySchemeType
745− = SecuritySchemeBasic
582+ = SwaggerSecuritySchemeBasic
746− | SecuritySchemeApiKey ApiKeyParams
583+ | SwaggerSecuritySchemeApiKey SwaggerApiKeyParams
747− | SecuritySchemeOAuth2 OAuth2Params
584+ | SwaggerSecuritySchemeOAuth2 SwaggerOAuth2Params
748− deriving (Eq, Show, Generic, Data, Typeable)
585+ deriving (Eq, Show)
750−data SecurityScheme = SecurityScheme
587+data SwaggerSecurityScheme = SwaggerSecurityScheme
751 { -- | The type of the security scheme.
588 { -- | The type of the security scheme.
752− _securitySchemeType :: SecuritySchemeType
589+ swaggerSecuritySchemeType :: SwaggerSecuritySchemeType
754 -- | A short description for security scheme.
591 -- | A short description for security scheme.
755− , _securitySchemeDescription :: Maybe Text
592+ , swaggerSecuritySchemeDescription :: 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).
777−newtype SecurityRequirement = SecurityRequirement
598+newtype SwaggerSecurityRequirement = SwaggerSecurityRequirement
778− { getSecurityRequirement :: InsOrdHashMap Text [Text]
599+ { getSwaggerSecurityRequirement :: 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 @SwaggerOperation@.
785−-- It is not mandatory to have a @Tag@ per tag used there.
603+-- It is not mandatory to have a @SwaggerTag@ per tag used there.
786−data Tag = Tag
604+data SwaggerTag = SwaggerTag
787 { -- | The name of the tag.
605 { -- | The name of the tag.
788− _tagName :: TagName
606+ swaggerTagName :: 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.
792− , _tagDescription :: Maybe Text
610+ , swaggerTagDescription :: Maybe Text
794 -- | Additional external documentation for this tag.
612 -- | Additional external documentation for this tag.
795− , _tagExternalDocs :: Maybe ExternalDocs
613+ , swaggerTagExternalDocs :: Maybe SwaggerExternalDocs
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.
804−data ExternalDocs = ExternalDocs
617+data SwaggerExternalDocs = SwaggerExternalDocs
805 { -- | A short description of the target documentation.
618 { -- | A short description of the target documentation.
806 -- GFM syntax can be used for rich text representation.
619 -- GFM syntax can be used for rich text representation.
807− _externalDocsDescription :: Maybe Text
620+ swaggerExternalDocsDescription :: Maybe Text
809 -- | The URL for the target documentation.
622 -- | The URL for the target documentation.
810− , _externalDocsUrl :: URL
623+ , swaggerExternalDocsUrl :: 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.
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)
626+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-- =======================================================================
628-- =======================================================================
836-- Monoid instances
629-- Monoid instances
837-- =======================================================================
630-- =======================================================================
839−instance Semigroup Swagger where
840− (<>) = genericMappend
841instance Monoid Swagger where
632instance Monoid Swagger where
842 mempty = genericMempty
633 mempty = genericMempty
845−instance Semigroup Info where
846− (<>) = genericMappend
634+ mappend = genericMappend
847−instance Monoid Info where
848− mempty = genericMempty
851−instance Semigroup Contact where
636+instance Monoid SwaggerInfo where
852− (<>) = genericMappend
853−instance Monoid Contact where
854 mempty = genericMempty
637 mempty = genericMempty
855− mappend = (<>)
638+ mappend = genericMappend
857−instance Semigroup PathItem where
640+instance Monoid SwaggerPaths where
858− (<>) = genericMappend
859−instance Monoid PathItem where
860 mempty = genericMempty
641 mempty = genericMempty
861− mappend = (<>)
642+ mappend = genericMappend
863−instance Semigroup Schema where
644+instance Monoid SwaggerPathItem where
864− (<>) = genericMappend
865−instance Monoid Schema where
866 mempty = genericMempty
645 mempty = genericMempty
867− mappend = (<>)
646+ mappend = genericMappend
869−instance Semigroup (ParamSchema t) where
648+instance Monoid SwaggerSchema where
870− (<>) = genericMappend
871−instance Monoid (ParamSchema t) where
872 mempty = genericMempty
649 mempty = genericMempty
873− mappend = (<>)
650+ mappend = genericMappend
875−instance Semigroup Param where
652+instance Monoid SwaggerSchemaCommon where
876− (<>) = genericMappend
877−instance Monoid Param where
878 mempty = genericMempty
653 mempty = genericMempty
879− mappend = (<>)
654+ mappend = genericMappend
881−instance Semigroup ParamOtherSchema where
656+instance Monoid SwaggerParameter where
882− (<>) = genericMappend
883−instance Monoid ParamOtherSchema where
884 mempty = genericMempty
657 mempty = genericMempty
885− mappend = (<>)
658+ mappend = genericMappend
887−instance Semigroup Header where
660+instance Monoid SwaggerParameterOtherSchema where
888− (<>) = genericMappend
889−instance Monoid Header where
890 mempty = genericMempty
661 mempty = genericMempty
891− mappend = (<>)
662+ mappend = genericMappend
893−instance Semigroup Responses where
664+instance Monoid SwaggerResponses where
894− (<>) = genericMappend
895−instance Monoid Responses where
896 mempty = genericMempty
665 mempty = genericMempty
897− mappend = (<>)
666+ mappend = genericMappend
899−instance Semigroup Response where
668+instance Monoid SwaggerResponse where
900− (<>) = genericMappend
901−instance Monoid Response where
902 mempty = genericMempty
669 mempty = genericMempty
903− mappend = (<>)
670+ mappend = genericMappend
905−instance Semigroup ExternalDocs where
672+instance Monoid SwaggerExternalDocs where
906− (<>) = genericMappend
907−instance Monoid ExternalDocs where
908 mempty = genericMempty
673 mempty = genericMempty
909− mappend = (<>)
674+ mappend = genericMappend
911−instance Semigroup Operation where
676+instance Monoid SwaggerOperation where
912− (<>) = genericMappend
913−instance Monoid Operation where
914 mempty = genericMempty
677 mempty = genericMempty
917−instance Semigroup Example where
918− (<>) = genericMappend
678+ 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-- =======================================================================
680-- =======================================================================
935-- SwaggerMonoid helper instances
681-- SwaggerMonoid helper instances
936-- =======================================================================
682-- =======================================================================
938−instance SwaggerMonoid Info
684+instance SwaggerMonoid SwaggerInfo
939−instance SwaggerMonoid PathItem
685+instance SwaggerMonoid SwaggerPaths
940−instance SwaggerMonoid Schema
686+instance SwaggerMonoid SwaggerPathItem
941−instance SwaggerMonoid (ParamSchema t)
687+instance SwaggerMonoid SwaggerSchema
942−instance SwaggerMonoid Param
688+instance SwaggerMonoid SwaggerSchemaCommon
943−instance SwaggerMonoid ParamOtherSchema
944−instance SwaggerMonoid Responses
689+instance SwaggerMonoid SwaggerParameter
945−instance SwaggerMonoid Response
690+instance SwaggerMonoid SwaggerParameterOtherSchema
946−instance SwaggerMonoid ExternalDocs
691+instance SwaggerMonoid SwaggerResponses
947−instance SwaggerMonoid Operation
692+instance SwaggerMonoid SwaggerResponse
948−instance SwaggerMonoid SecurityDefinitions
693+instance SwaggerMonoid SwaggerExternalDocs
949−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
694+instance SwaggerMonoid SwaggerOperation
951−instance SwaggerMonoid MimeList
696+instance SwaggerMonoid SwaggerMimeList
952deriving instance SwaggerMonoid URL
697deriving instance SwaggerMonoid URL
954−instance SwaggerMonoid (SwaggerType t) where
699+instance SwaggerMonoid SwaggerSchemaType where
955− swaggerMempty = SwaggerString
700+ swaggerMempty = SwaggerSchemaNull
956 swaggerMappend _ y = y
701 swaggerMappend _ y = y
958−instance SwaggerMonoid ParamLocation where
703+instance SwaggerMonoid SwaggerParameterType where
959− swaggerMempty = ParamQuery
704+ swaggerMempty = SwaggerParamString
960 swaggerMappend _ y = y
705 swaggerMappend _ y = y
962−instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
707+instance SwaggerMonoid SwaggerParameterLocation where
963− swaggerMempty = InsOrdHashMap.empty
708+ swaggerMempty = SwaggerParameterQuery
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
709 swaggerMappend _ y = y
971−instance SwaggerMonoid ParamAnySchema where
711+instance SwaggerMonoid (HashMap Text SwaggerSchema) where
972− swaggerMempty = ParamOther swaggerMempty
712+ 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
713+ 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
715+instance SwaggerMonoid (HashMap Text SwaggerParameter) where
985− toJSON = genericToJSON (jsonPrefix "Info")
716+ swaggerMempty = HashMap.empty
717+ swaggerMappend = HashMap.unionWith mappend
987−instance ToJSON Contact where
719+instance SwaggerMonoid (HashMap Text SwaggerResponse) where
988− toJSON = genericToJSON (jsonPrefix "Contact")
720+ swaggerMempty = HashMap.empty
721+ swaggerMappend = flip HashMap.union
990−instance ToJSON License where
723+instance SwaggerMonoid (HashMap Text SwaggerSecurityScheme) where
991− toJSON = genericToJSON (jsonPrefix "License")
724+ swaggerMempty = HashMap.empty
725+ swaggerMappend = flip HashMap.union
993−instance ToJSON ApiKeyLocation where
727+instance SwaggerMonoid (HashMap FilePath SwaggerPathItem) where
994− toJSON = genericToJSON (jsonPrefix "ApiKey")
728+ swaggerMempty = HashMap.empty
729+ swaggerMappend = HashMap.unionWith mappend
996−instance ToJSON ApiKeyParams where
731+instance SwaggerMonoid (HashMap HeaderName SwaggerHeader) where
997− toJSON = genericToJSON (jsonPrefix "apiKey")
732+ swaggerMempty = HashMap.empty
733+ swaggerMappend = flip HashMap.union
999−instance ToJSON Scheme where
735+instance SwaggerMonoid (HashMap HttpStatusCode SwaggerResponse) where
1000− toJSON = genericToJSON (jsonPrefix "")
736+ swaggerMempty = HashMap.empty
737+ swaggerMappend = flip HashMap.union
1002−instance ToJSON Tag where
739+instance SwaggerMonoid SwaggerParameterSchema where
1003− toJSON = genericToJSON (jsonPrefix "Tag")
740+ swaggerMempty = SwaggerParameterOther swaggerMempty
1004−
741+ swaggerMappend (SwaggerParameterBody x) (SwaggerParameterBody y) = SwaggerParameterBody (swaggerMappend x y)
1005−instance ToJSON ExternalDocs where
742+ swaggerMappend (SwaggerParameterOther x) (SwaggerParameterOther y) = SwaggerParameterOther (swaggerMappend x y)
1006− toJSON = genericToJSON (jsonPrefix "ExternalDocs")
743+ swaggerMappend _ y = y
1008−instance ToJSON Xml where
1009− toJSON = genericToJSON (jsonPrefix "Xml")
1011-- =======================================================================
745-- =======================================================================
1012−-- Simple Generic-based FromJSON instances
746+-- TH derived ToJSON and FromJSON instances
1013-- =======================================================================
747-- =======================================================================
1015−instance FromJSON ParamLocation where
749+deriveJSON (jsonPrefix "SwaggerParameter") ''SwaggerParameterLocation
1016− parseJSON = genericParseJSON (jsonPrefix "Param")
750+deriveJSON (jsonPrefix "SwaggerParam") ''SwaggerParameterType
1017−
751+deriveJSON' ''SwaggerPathItem
1018−instance FromJSON Info where
752+deriveJSON' ''SwaggerInfo
1019− parseJSON = genericParseJSON (jsonPrefix "Info")
753+deriveJSON' ''SwaggerContact
1020−
754+deriveJSON' ''SwaggerLicense
1021−instance FromJSON Contact where
755+deriveJSON (jsonPrefix "SwaggerSchema") ''SwaggerSchemaType
1022− parseJSON = genericParseJSON (jsonPrefix "Contact")
756+deriveJSON (jsonPrefix "SwaggerItems") ''SwaggerItemsType
1023−
757+deriveJSON (jsonPrefix "SwaggerItemsCollection") ''SwaggerItemsCollectionFormat
1024−instance FromJSON License where
758+deriveJSON (jsonPrefix "SwaggerCollection") ''SwaggerCollectionFormat
1025− parseJSON = genericParseJSON (jsonPrefix "License")
759+deriveJSON (jsonPrefix "SwaggerApiKey") ''SwaggerApiKeyLocation
1026−
760+deriveJSON (jsonPrefix "swaggerApiKey") ''SwaggerApiKeyParams
1027−instance FromJSON ApiKeyLocation where
761+deriveJSON (jsonPrefix "swaggerSchema") ''SwaggerSchemaCommon
1028− parseJSON = genericParseJSON (jsonPrefix "ApiKey")
762+deriveJSONDefault ''SwaggerScheme
1029−
763+deriveJSON' ''SwaggerTag
1030−instance FromJSON ApiKeyParams where
764+deriveJSON' ''SwaggerExternalDocs
1031− parseJSON = genericParseJSON (jsonPrefix "apiKey")
765+deriveJSON' ''SwaggerXml
1033−instance FromJSON Scheme where
767+deriveToJSON' ''SwaggerOperation
1034− parseJSON = genericParseJSON (jsonPrefix "")
768+deriveToJSON' ''SwaggerResponse
1036−instance FromJSON Tag where
1037− parseJSON = genericParseJSON (jsonPrefix "Tag")
1039−instance FromJSON ExternalDocs where
1040− parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
1042-- =======================================================================
770-- =======================================================================
1043-- Manual ToJSON instances
771-- Manual ToJSON instances
1044-- =======================================================================
772-- =======================================================================
1046−instance ToJSON OAuth2Flow where
774+instance ToJSON SwaggerOAuth2Flow where
1047− toJSON (OAuth2Implicit authUrl) = object
775+ toJSON (SwaggerOAuth2Implicit authUrl) = object
1048 [ "flow" .= ("implicit" :: Text)
776 [ "flow" .= ("implicit" :: Text)
1049 , "authorizationUrl" .= authUrl ]
777 , "authorizationUrl" .= authUrl ]
1050− toJSON (OAuth2Password tokenUrl) = object
778+ toJSON (SwaggerOAuth2Password tokenUrl) = object
1051 [ "flow" .= ("password" :: Text)
779 [ "flow" .= ("password" :: Text)
1052 , "tokenUrl" .= tokenUrl ]
780 , "tokenUrl" .= tokenUrl ]
1053− toJSON (OAuth2Application tokenUrl) = object
781+ toJSON (SwaggerOAuth2Application tokenUrl) = object
1054 [ "flow" .= ("application" :: Text)
782 [ "flow" .= ("application" :: Text)
1055 , "tokenUrl" .= tokenUrl ]
783 , "tokenUrl" .= tokenUrl ]
1056− toJSON (OAuth2AccessCode authUrl tokenUrl) = object
784+ toJSON (SwaggerOAuth2AccessCode authUrl tokenUrl) = object
1057 [ "flow" .= ("accessCode" :: Text)
785 [ "flow" .= ("accessCode" :: Text)
1058 , "authorizationUrl" .= authUrl
786 , "authorizationUrl" .= authUrl
1059 , "tokenUrl" .= tokenUrl ]
787 , "tokenUrl" .= tokenUrl ]
1061−instance ToJSON OAuth2Params where
789+instance ToJSON SwaggerOAuth2Params where
1062− toJSON = sopSwaggerGenericToJSON
790+ toJSON = genericToJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1065−instance ToJSON SecuritySchemeType where
792+instance ToJSON SwaggerSecuritySchemeType where
1066− toJSON SecuritySchemeBasic
793+ toJSON SwaggerSecuritySchemeBasic
1067 = object [ "type" .= ("basic" :: Text) ]
794 = object [ "type" .= ("basic" :: Text) ]
1068− toJSON (SecuritySchemeApiKey params)
795+ toJSON (SwaggerSecuritySchemeApiKey params)
1069 = toJSON params
796 = toJSON params
1070 <+> object [ "type" .= ("apiKey" :: Text) ]
797 <+> object [ "type" .= ("apiKey" :: Text) ]
1071− toJSON (SecuritySchemeOAuth2 params)
798+ toJSON (SwaggerSecuritySchemeOAuth2 params)
1072 = toJSON params
799 = toJSON params
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
800 <+> object [ "type" .= ("oauth2" :: Text) ]
1075instance ToJSON Swagger where
802instance ToJSON Swagger where
1076− toJSON = sopSwaggerGenericToJSON
803+ toJSON = addVersion . genericToJSON (jsonPrefix "swagger")
1077− DEFINE_TOENCODING
804+ where
1078−
805+ addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
1079−instance ToJSON SecurityScheme where
806+ 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
1116− toJSON (MimeList xs) = toJSON (map show xs)
1118−instance ToJSON Param where
1119− toJSON = sopSwaggerGenericToJSON
1122−instance ToJSON ParamAnySchema where
1123− toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124− toJSON (ParamOther s) = toJSON s
1126−instance ToJSON ParamOtherSchema where
808+instance ToJSON SwaggerSecurityScheme where
1127− toJSON = sopSwaggerGenericToJSON
809+ toJSON = genericToJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
1130−instance ToJSON Responses where
811+instance ToJSON SwaggerSchema where
1131− toJSON = sopSwaggerGenericToJSON
812+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerSchema")
1134−instance ToJSON Response where
814+instance ToJSON SwaggerHeader where
1135− toJSON = sopSwaggerGenericToJSON
815+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerHeader")
1138−instance ToJSON Operation where
817+instance ToJSON SwaggerItems where
1139− toJSON = sopSwaggerGenericToJSON
818+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerItems")
1142−instance ToJSON PathItem where
820+instance ToJSON SwaggerHost where
1143− toJSON = sopSwaggerGenericToJSON
821+ toJSON (SwaggerHost host mport) = toJSON $
1144− DEFINE_TOENCODING
822+ case mport of
1145−
823+ Nothing -> host
1146−instance ToJSON Example where
824+ Just port -> host ++ ":" ++ show port
1147− toJSON = toJSON . Map.mapKeys show . getExample
1149−instance ToJSON SecurityDefinitions where
826+instance ToJSON SwaggerPaths where
1150− toJSON (SecurityDefinitions sd) = toJSON sd
827+ toJSON (SwaggerPaths m) = toJSON m
1152−instance ToJSON Reference where
829+instance ToJSON SwaggerMimeList where
1153− toJSON (Reference ref) = object [ "$ref" .= ref ]
830+ toJSON (SwaggerMimeList xs) = toJSON (map show xs)
1155−referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
832+instance ToJSON SwaggerParameter where
1156−referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
833+ toJSON = genericToJSONWithSub "schema" (jsonPrefix "swaggerParameter")
1157−referencedToJSON _ (Inline x) = toJSON x
1159−instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
835+instance ToJSON SwaggerParameterSchema where
1160−instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
836+ toJSON (SwaggerParameterBody s) = toJSON s <+> object [ "in" .= ("body" :: Text) ]
1161−instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
837+ toJSON (SwaggerParameterOther s) = toJSON s
1163−instance ToJSON (SwaggerType t) where
839+instance ToJSON SwaggerParameterOtherSchema where
1164− toJSON SwaggerArray = "array"
840+ toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
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
842+instance ToJSON SwaggerSchemaItems where
1174− toJSON CollectionCSV = "csv"
843+ toJSON (SwaggerSchemaItemsObject x) = toJSON x
1175− toJSON CollectionSSV = "ssv"
844+ toJSON (SwaggerSchemaItemsArray xs) = toJSON xs
1176− toJSON CollectionTSV = "tsv"
1177− toJSON CollectionPipes = "pipes"
1178− toJSON CollectionMulti = "multi"
1180−instance ToJSON (ParamSchema k) where
846+instance ToJSON SwaggerResponses where
1181− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
847+ toJSON (SwaggerResponses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1182− toJSON = sopSwaggerGenericToJSONWithOpts $
1183− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1185−instance ToJSON AdditionalProperties where
849+instance ToJSON SwaggerExample where
1186− toJSON (AdditionalPropertiesAllowed b) = toJSON b
850+ toJSON = toJSON . Map.mapKeys show . getSwaggerExample
1187− toJSON (AdditionalPropertiesSchema s) = toJSON s
1189-- =======================================================================
852-- =======================================================================
1190-- Manual FromJSON instances
853-- Manual FromJSON instances
1191-- =======================================================================
854-- =======================================================================
1193−instance FromJSON OAuth2Flow where
856+instance FromJSON SwaggerOAuth2Flow where
1194 parseJSON (Object o) = do
857 parseJSON (Object o) = do
1195 (flow :: Text) <- o .: "flow"
858 (flow :: Text) <- o .: "flow"
1196 case flow of
859 case flow of
1197− "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
860+ "implicit" -> SwaggerOAuth2Implicit <$> o .: "authorizationUrl"
1198− "password" -> OAuth2Password <$> o .: "tokenUrl"
861+ "password" -> SwaggerOAuth2Password <$> o .: "tokenUrl"
1199− "application" -> OAuth2Application <$> o .: "tokenUrl"
862+ "application" -> SwaggerOAuth2Application <$> o .: "tokenUrl"
1200− "accessCode" -> OAuth2AccessCode
863+ "accessCode" -> SwaggerOAuth2AccessCode
1201 <$> o .: "authorizationUrl"
864 <$> o .: "authorizationUrl"
1202 <*> o .: "tokenUrl"
865 <*> o .: "tokenUrl"
1203 _ -> empty
866 _ -> empty
1204 parseJSON _ = empty
867 parseJSON _ = empty
1206−instance FromJSON OAuth2Params where
869+instance FromJSON SwaggerOAuth2Params where
1207− parseJSON = sopSwaggerGenericParseJSON
870+ parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1209−instance FromJSON SecuritySchemeType where
872+instance FromJSON SwaggerSecuritySchemeType where
1210− parseJSON js@(Object o) = do
873+ parseJSON json@(Object o) = do
1211 (t :: Text) <- o .: "type"
874 (t :: Text) <- o .: "type"
1212 case t of
875 case t of
1213− "basic" -> pure SecuritySchemeBasic
876+ "basic" -> pure SwaggerSecuritySchemeBasic
1214− "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
877+ "apiKey" -> SwaggerSecuritySchemeApiKey <$> parseJSON json
1215− "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
878+ "oauth2" -> SwaggerSecuritySchemeOAuth2 <$> parseJSON json
1216 _ -> empty
879 _ -> empty
1217 parseJSON _ = empty
880 parseJSON _ = empty
1219instance FromJSON Swagger where
882instance FromJSON Swagger where
1220− parseJSON = sopSwaggerGenericParseJSON
883+ parseJSON json@(Object o) = do
1221−
884+ (version :: Text) <- o .: "swagger"
1222−instance FromJSON SecurityScheme where
885+ when (version /= "2.0") empty
1223− parseJSON = sopSwaggerGenericParseJSON
886+ 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
887 parseJSON _ = empty
1265−instance FromJSON Host where
889+instance FromJSON SwaggerSecurityScheme where
890+ parseJSON = genericParseJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
892+instance FromJSON SwaggerSchema where
893+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerSchema")
894+ `withDefaults` [ "properties" .= (mempty :: HashMap Text SwaggerSchema)
895+ , "required" .= ([] :: [SwaggerParamName]) ]
897+instance FromJSON SwaggerHeader where
898+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerHeader")
900+instance FromJSON SwaggerItems where
901+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerItems")
903+instance FromJSON SwaggerHost where
1266− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
904+ parseJSON (String s) =
1267− [host] -> return $ Host host Nothing
905+ case fromInteger <$> readMaybe portStr of
1268− [host, port] -> case readMaybe port of
906+ Nothing | not (null portStr) -> empty
1269− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
907+ mport -> pure $ SwaggerHost host mport
1270− Just p -> return $ Host host (Just (fromInteger p))
908+ where
1271− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
909+ (hostText, portText) = Text.breakOnEnd ":" s
910+ [host, portStr] = map Text.unpack [hostText, portText]
1272 parseJSON _ = empty
911 parseJSON _ = empty
1274−instance FromJSON MimeList where
913+instance FromJSON SwaggerPaths where
1275− parseJSON js = (MimeList . map fromString) <$> parseJSON js
914+ parseJSON json = SwaggerPaths <$> parseJSON json
1277−instance FromJSON Param where
916+instance FromJSON SwaggerMimeList where
1278− parseJSON = sopSwaggerGenericParseJSON
917+ parseJSON json = (SwaggerMimeList . map fromString) <$> parseJSON json
1280−instance FromJSON ParamAnySchema where
919+instance FromJSON SwaggerParameter where
920+ parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "swaggerParameter")
921+ `withDefaults` [ "required" .= False ]
923+instance FromJSON SwaggerParameterSchema where
1281− parseJSON js@(Object o) = do
924+ parseJSON json@(Object o) = do
1282 (i :: Text) <- o .: "in"
925 (i :: Text) <- o .: "in"
1283 case i of
926 case i of
1284− "body" -> do
927+ "body" -> SwaggerParameterBody <$> parseJSON json
1285− schema <- o .: "schema"
928+ _ -> SwaggerParameterOther <$> parseJSON json
1286− ParamBody <$> parseJSON schema
1287− _ -> ParamOther <$> parseJSON js
1288 parseJSON _ = empty
929 parseJSON _ = empty
1290−instance FromJSON ParamOtherSchema where
931+instance FromJSON SwaggerParameterOtherSchema where
1291− parseJSON = sopSwaggerGenericParseJSON
932+ parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
933+ `withDefaults` [ "allowEmptyValue" .= False ]
1293−instance FromJSON Responses where
935+instance FromJSON SwaggerSchemaItems where
1294− parseJSON (Object o) = Responses
936+ parseJSON json@(Object _) = SwaggerSchemaItemsObject <$> parseJSON json
1295− <$> o .:? "default"
937+ parseJSON json@(Array _) = SwaggerSchemaItemsArray <$> parseJSON json
1296− <*> (parseJSON (Object (HashMap.delete "default" o)))
1297 parseJSON _ = empty
938 parseJSON _ = empty
1299−instance FromJSON Example where
940+instance FromJSON SwaggerResponses where
1300− parseJSON js = do
941+ parseJSON (Object o) = SwaggerResponses
1301− m <- parseJSON js
942+ <$> o .:? "default"
1302− pure $ Example (Map.mapKeys fromString m)
943+ <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1303−
944+ parseJSON _ = empty
1304−instance FromJSON Response where
1305− parseJSON = sopSwaggerGenericParseJSON
1307−instance FromJSON Operation where
1308− parseJSON = sopSwaggerGenericParseJSON
1310−instance FromJSON PathItem where
946+instance FromJSON SwaggerExample where
1311− parseJSON = sopSwaggerGenericParseJSON
947+ parseJSON json = do
949+ pure $ SwaggerExample (Map.mapKeys fromString m)
1313−instance FromJSON SecurityDefinitions where
951+instance FromJSON SwaggerResponse where
1314− parseJSON js = SecurityDefinitions <$> parseJSON js
952+ parseJSON = genericParseJSON (jsonPrefix "swaggerResponse")
953+ `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName SwaggerHeader) ]
1316−instance FromJSON Reference where
955+instance FromJSON SwaggerOperation where
1317− parseJSON (Object o) = Reference <$> o .: "$ref"
956+ parseJSON = genericParseJSON (jsonPrefix "swaggerOperation")
1318− parseJSON _ = empty
957+ `withDefaults` [ "deprecated" .= False ]
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