@@ -1,45 +1,87 @@
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
1{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveGeneric #-}
2{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE DeriveTraversable #-}
7+{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5{-# LANGUAGE OverloadedStrings #-}
11{-# LANGUAGE OverloadedStrings #-}
6{-# LANGUAGE RecordWildCards #-}
12{-# LANGUAGE RecordWildCards #-}
7{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE ScopedTypeVariables #-}
8{-# LANGUAGE StandaloneDeriving #-}
14{-# LANGUAGE StandaloneDeriving #-}
9{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
21+#include "overlapping-compat.h"
10module Data.Swagger.Internal where
22module Data.Swagger.Internal where
27+import Control.Lens ((&), (.~), (?~))
12import Control.Applicative
28import Control.Applicative
14import Data.Aeson
29import Data.Aeson
15−import Data.Aeson.TH (deriveJSON)
30+import qualified Data.Aeson.Types as JSON
16−import Data.Foldable (Foldable)
31+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
17−import Data.HashMap.Strict (HashMap)
32+import Data.Hashable (Hashable)
18import qualified Data.HashMap.Strict as HashMap
33import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
19import Data.Map (Map)
35import Data.Map (Map)
20import qualified Data.Map as Map
36import qualified Data.Map as Map
21−import Data.Monoid
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
39+import Data.Scientific (Scientific)
22−import Data.String (fromString)
40+import Data.String (IsString(..))
23import Data.Text (Text)
41import Data.Text (Text)
24import qualified Data.Text as Text
42import qualified Data.Text as Text
25−import Data.Traversable (Traversable)
26−import Data.Hashable (Hashable)
27import GHC.Generics (Generic)
43import GHC.Generics (Generic)
28−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
29import Network.HTTP.Media (MediaType)
45import Network.HTTP.Media (MediaType)
30import Text.Read (readMaybe)
46import 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
32import Data.Swagger.Internal.Utils
60import 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
34-- | This is the root document object for the API specification.
76-- | This is the root document object for the API specification.
35data Swagger = Swagger
77data Swagger = Swagger
36 { -- | Provides metadata about the API.
78 { -- | Provides metadata about the API.
37 -- The metadata can be used by the clients if needed.
79 -- The metadata can be used by the clients if needed.
38− _swaggerInfo :: SwaggerInfo
80+ _swaggerInfo :: Info
40 -- | The host (name or ip) serving the API. It MAY include a port.
82 -- | The host (name or ip) serving the API. It MAY include a port.
41 -- If the host is not included, the host serving the documentation is to be used (including the port).
83 -- If the host is not included, the host serving the documentation is to be used (including the port).
42− , _swaggerHost :: Maybe SwaggerHost
84+ , _swaggerHost :: Maybe Host
44 -- | The base path on which the API is served, which is relative to the host.
86 -- | The base path on which the API is served, which is relative to the host.
45 -- If it is not included, the API is served directly under the host.
87 -- If it is not included, the API is served directly under the host.
@@ -48,410 +90,547 @@ data Swagger = Swagger
49 -- | The transfer protocol of the API.
91 -- | The transfer protocol of the API.
50 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
92 -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
51− , _swaggerSchemes :: Maybe [SwaggerScheme]
93+ , _swaggerSchemes :: Maybe [Scheme]
53 -- | A list of MIME types the APIs can consume.
95 -- | A list of MIME types the APIs can consume.
54 -- This is global to all APIs but can be overridden on specific API calls.
96 -- This is global to all APIs but can be overridden on specific API calls.
55− , _swaggerConsumes :: SwaggerMimeList
97+ , _swaggerConsumes :: MimeList
57 -- | A list of MIME types the APIs can produce.
99 -- | A list of MIME types the APIs can produce.
58− -- This is global to all APIs but can be overridden on specific API calls.
100+ -- This is global to all APIs but can be overridden on specific API calls.
59− , _swaggerProduces :: SwaggerMimeList
101+ , _swaggerProduces :: MimeList
61 -- | The available paths and operations for the API.
103 -- | The available paths and operations for the API.
62− , _swaggerPaths :: SwaggerPaths
104+ -- Holds the relative paths to the individual endpoints.
105+ -- The path is appended to the @'basePath'@ in order to construct the full URL.
106+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
64 -- | An object to hold data types produced and consumed by operations.
108 -- | An object to hold data types produced and consumed by operations.
65− , _swaggerDefinitions :: HashMap Text SwaggerSchema
109+ , _swaggerDefinitions :: Definitions Schema
67 -- | An object to hold parameters that can be used across operations.
111 -- | An object to hold parameters that can be used across operations.
68 -- This property does not define global parameters for all operations.
112 -- This property does not define global parameters for all operations.
69− , _swaggerParameters :: HashMap Text SwaggerParameter
113+ , _swaggerParameters :: Definitions Param
71 -- | An object to hold responses that can be used across operations.
115 -- | An object to hold responses that can be used across operations.
72 -- This property does not define global responses for all operations.
116 -- This property does not define global responses for all operations.
73− , _swaggerResponses :: HashMap Text SwaggerResponse
117+ , _swaggerResponses :: Definitions Response
75 -- | Security scheme definitions that can be used across the specification.
119 -- | Security scheme definitions that can be used across the specification.
76− , _swaggerSecurityDefinitions :: HashMap Text SwaggerSecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
78 -- | A declaration of which security schemes are applied for the API as a whole.
122 -- | A declaration of which security schemes are applied for the API as a whole.
79 -- The list of values describes alternative security schemes that can be used
123 -- The list of values describes alternative security schemes that can be used
80 -- (that is, there is a logical OR between the security requirements).
124 -- (that is, there is a logical OR between the security requirements).
81 -- Individual operations can override this definition.
125 -- Individual operations can override this definition.
82− , _swaggerSecurity :: [SwaggerSecurityRequirement]
126+ , _swaggerSecurity :: [SecurityRequirement]
84 -- | A list of tags used by the specification with additional metadata.
128 -- | A list of tags used by the specification with additional metadata.
85 -- The order of the tags can be used to reflect on their order by the parsing tools.
129 -- The order of the tags can be used to reflect on their order by the parsing tools.
86 -- Not all tags that are used by the Operation Object must be declared.
130 -- Not all tags that are used by the Operation Object must be declared.
87 -- The tags that are not declared may be organized randomly or based on the tools' logic.
131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
88 -- Each tag name in the list MUST be unique.
132 -- Each tag name in the list MUST be unique.
89− , _swaggerTags :: [SwaggerTag]
133+ , _swaggerTags :: InsOrdHashSet Tag
91 -- | Additional external documentation.
135 -- | Additional external documentation.
92− , _swaggerExternalDocs :: Maybe SwaggerExternalDocs
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
93− } deriving (Eq, Show, Generic)
137+ } deriving (Eq, Show, Generic, Data, Typeable)
95-- | The object provides metadata about the API.
139-- | The object provides metadata about the API.
96-- The metadata can be used by the clients if needed,
140-- The metadata can be used by the clients if needed,
97-- and can be presented in the Swagger-UI for convenience.
141-- and can be presented in the Swagger-UI for convenience.
98−data SwaggerInfo = SwaggerInfo
142+data Info = Info
99 { -- | The title of the application.
143 { -- | The title of the application.
100− _swaggerInfoTitle :: Text
144+ _infoTitle :: Text
102 -- | A short description of the application.
146 -- | A short description of the application.
103 -- GFM syntax can be used for rich text representation.
147 -- GFM syntax can be used for rich text representation.
104− , _swaggerInfoDescription :: Maybe Text
148+ , _infoDescription :: Maybe Text
106 -- | The Terms of Service for the API.
150 -- | The Terms of Service for the API.
107− , _swaggerInfoTermsOfService :: Maybe Text
151+ , _infoTermsOfService :: Maybe Text
109 -- | The contact information for the exposed API.
153 -- | The contact information for the exposed API.
110− , _swaggerInfoContact :: Maybe SwaggerContact
154+ , _infoContact :: Maybe Contact
112 -- | The license information for the exposed API.
156 -- | The license information for the exposed API.
113− , _swaggerInfoLicense :: Maybe SwaggerLicense
157+ , _infoLicense :: Maybe License
115 -- | Provides the version of the application API
159 -- | Provides the version of the application API
116 -- (not to be confused with the specification version).
160 -- (not to be confused with the specification version).
117− , _swaggerInfoVersion :: Text
161+ , _infoVersion :: Text
118− } deriving (Eq, Show, Generic)
162+ } deriving (Eq, Show, Generic, Data, Typeable)
120-- | Contact information for the exposed API.
164-- | Contact information for the exposed API.
121−data SwaggerContact = SwaggerContact
165+data Contact = Contact
122 { -- | The identifying name of the contact person/organization.
166 { -- | The identifying name of the contact person/organization.
123− _swaggerContactName :: Maybe Text
167+ _contactName :: Maybe Text
125 -- | The URL pointing to the contact information.
169 -- | The URL pointing to the contact information.
126− , _swaggerContactUrl :: Maybe URL
170+ , _contactUrl :: Maybe URL
128 -- | The email address of the contact person/organization.
172 -- | The email address of the contact person/organization.
129− , _swaggerContactEmail :: Maybe Text
173+ , _contactEmail :: Maybe Text
130− } deriving (Eq, Show)
174+ } deriving (Eq, Show, Generic, Data, Typeable)
132-- | License information for the exposed API.
176-- | License information for the exposed API.
133−data SwaggerLicense = SwaggerLicense
177+data License = License
134 { -- | The license name used for the API.
178 { -- | The license name used for the API.
135− _swaggerLicenseName :: Text
179+ _licenseName :: Text
137 -- | A URL to the license used for the API.
181 -- | A URL to the license used for the API.
138− , _swaggerLicenseUrl :: Maybe URL
182+ , _licenseUrl :: Maybe URL
139− } deriving (Eq, Show)
183+ } deriving (Eq, Show, Generic, Data, Typeable)
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
141-- | The host (name or ip) serving the API. It MAY include a port.
188-- | The host (name or ip) serving the API. It MAY include a port.
142−data SwaggerHost = SwaggerHost
189+data Host = Host
143− { _swaggerHostName :: HostName -- ^ Host name.
190+ { _hostName :: HostName -- ^ Host name.
144− , _swaggerHostPort :: Maybe PortNumber -- ^ Optional port.
191+ , _hostPort :: Maybe PortNumber -- ^ Optional port.
145− } deriving (Eq, Show)
192+ } deriving (Eq, Show, Generic, Typeable)
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
147-- | The transfer protocol of the API.
210-- | The transfer protocol of the API.
148−data SwaggerScheme
211+data Scheme
153− deriving (Eq, Show)
216+ deriving (Eq, Show, Generic, Data, Typeable)
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)
162-- | Describes the operations available on a single path.
218-- | Describes the operations available on a single path.
163−-- A @'SwaggerPathItem'@ may be empty, due to ACL constraints.
219+-- A @'PathItem'@ may be empty, due to ACL constraints.
164-- The path itself is still exposed to the documentation viewer
220-- The path itself is still exposed to the documentation viewer
165-- but they will not know which operations and parameters are available.
221-- but they will not know which operations and parameters are available.
166−data SwaggerPathItem = SwaggerPathItem
222+data PathItem = PathItem
167 { -- | A definition of a GET operation on this path.
223 { -- | A definition of a GET operation on this path.
168− _swaggerPathItemGet :: Maybe SwaggerOperation
224+ _pathItemGet :: Maybe Operation
170 -- | A definition of a PUT operation on this path.
226 -- | A definition of a PUT operation on this path.
171− , _swaggerPathItemPut :: Maybe SwaggerOperation
227+ , _pathItemPut :: Maybe Operation
173 -- | A definition of a POST operation on this path.
229 -- | A definition of a POST operation on this path.
174− , _swaggerPathItemPost :: Maybe SwaggerOperation
230+ , _pathItemPost :: Maybe Operation
176 -- | A definition of a DELETE operation on this path.
232 -- | A definition of a DELETE operation on this path.
177− , _swaggerPathItemDelete :: Maybe SwaggerOperation
233+ , _pathItemDelete :: Maybe Operation
179 -- | A definition of a OPTIONS operation on this path.
235 -- | A definition of a OPTIONS operation on this path.
180− , _swaggerPathItemOptions :: Maybe SwaggerOperation
236+ , _pathItemOptions :: Maybe Operation
182 -- | A definition of a HEAD operation on this path.
238 -- | A definition of a HEAD operation on this path.
183− , _swaggerPathItemHead :: Maybe SwaggerOperation
239+ , _pathItemHead :: Maybe Operation
185 -- | A definition of a PATCH operation on this path.
241 -- | A definition of a PATCH operation on this path.
186− , _swaggerPathItemPatch :: Maybe SwaggerOperation
242+ , _pathItemPatch :: Maybe Operation
188 -- | A list of parameters that are applicable for all the operations described under this path.
244 -- | A list of parameters that are applicable for all the operations described under this path.
189 -- These parameters can be overridden at the operation level, but cannot be removed there.
245 -- These parameters can be overridden at the operation level, but cannot be removed there.
190 -- The list MUST NOT include duplicated parameters.
246 -- The list MUST NOT include duplicated parameters.
191 -- A unique parameter is defined by a combination of a name and location.
247 -- A unique parameter is defined by a combination of a name and location.
192− , _swaggerPathItemParameters :: [SwaggerReferenced SwaggerParameter]
248+ , _pathItemParameters :: [Referenced Param]
193− } deriving (Eq, Show, Generic)
249+ } deriving (Eq, Show, Generic, Data, Typeable)
195-- | Describes a single API operation on a path.
251-- | Describes a single API operation on a path.
196−data SwaggerOperation = SwaggerOperation
252+data Operation = Operation
197 { -- | A list of tags for API documentation control.
253 { -- | A list of tags for API documentation control.
198 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
199− _swaggerOperationTags :: [Text]
255+ _operationTags :: InsOrdHashSet TagName
201 -- | A short summary of what the operation does.
257 -- | A short summary of what the operation does.
202 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
203− , _swaggerOperationSummary :: Maybe Text
259+ , _operationSummary :: Maybe Text
205 -- | A verbose explanation of the operation behavior.
261 -- | A verbose explanation of the operation behavior.
206 -- GFM syntax can be used for rich text representation.
262 -- GFM syntax can be used for rich text representation.
207− , _swaggerOperationDescription :: Maybe Text
263+ , _operationDescription :: Maybe Text
209 -- | Additional external documentation for this operation.
265 -- | Additional external documentation for this operation.
210− , _swaggerOperationExternalDocs :: Maybe SwaggerExternalDocs
266+ , _operationExternalDocs :: Maybe ExternalDocs
212 -- | Unique string used to identify the operation.
268 -- | Unique string used to identify the operation.
213 -- The id MUST be unique among all operations described in the API.
269 -- The id MUST be unique among all operations described in the API.
214 -- Tools and libraries MAY use the it to uniquely identify an operation,
270 -- Tools and libraries MAY use the it to uniquely identify an operation,
215 -- therefore, it is recommended to follow common programming naming conventions.
271 -- therefore, it is recommended to follow common programming naming conventions.
216− , _swaggerOperationOperationId :: Maybe Text
272+ , _operationOperationId :: Maybe Text
218 -- | A list of MIME types the operation can consume.
274 -- | A list of MIME types the operation can consume.
219− -- This overrides the @'swaggerConsumes'@.
275+ -- This overrides the @'consumes'@.
220 -- @Just []@ MAY be used to clear the global definition.
276 -- @Just []@ MAY be used to clear the global definition.
221− , _swaggerOperationConsumes :: Maybe SwaggerMimeList
277+ , _operationConsumes :: Maybe MimeList
223 -- | A list of MIME types the operation can produce.
279 -- | A list of MIME types the operation can produce.
224− -- This overrides the @'swaggerProduces'@.
280+ -- This overrides the @'produces'@.
225 -- @Just []@ MAY be used to clear the global definition.
281 -- @Just []@ MAY be used to clear the global definition.
226− , _swaggerOperationProduces :: Maybe SwaggerMimeList
282+ , _operationProduces :: Maybe MimeList
228 -- | A list of parameters that are applicable for this operation.
284 -- | A list of parameters that are applicable for this operation.
229− -- If a parameter is already defined at the @'SwaggerPathItem'@,
285+ -- If a parameter is already defined at the @'PathItem'@,
230 -- the new definition will override it, but can never remove it.
286 -- the new definition will override it, but can never remove it.
231 -- The list MUST NOT include duplicated parameters.
287 -- The list MUST NOT include duplicated parameters.
232 -- A unique parameter is defined by a combination of a name and location.
288 -- A unique parameter is defined by a combination of a name and location.
233− , _swaggerOperationParameters :: [SwaggerReferenced SwaggerParameter]
289+ , _operationParameters :: [Referenced Param]
235 -- | The list of possible responses as they are returned from executing this operation.
291 -- | The list of possible responses as they are returned from executing this operation.
236− , _swaggerOperationResponses :: SwaggerResponses
292+ , _operationResponses :: Responses
238 -- | The transfer protocol for the operation.
294 -- | The transfer protocol for the operation.
239− -- The value overrides @'swaggerSchemes'@.
295+ -- The value overrides @'schemes'@.
240− , _swaggerOperationSchemes :: Maybe [SwaggerScheme]
296+ , _operationSchemes :: Maybe [Scheme]
242 -- | Declares this operation to be deprecated.
298 -- | Declares this operation to be deprecated.
243 -- Usage of the declared operation should be refrained.
299 -- Usage of the declared operation should be refrained.
244 -- Default value is @False@.
300 -- Default value is @False@.
245− , _swaggerOperationDeprecated :: Maybe Bool
301+ , _operationDeprecated :: Maybe Bool
247 -- | A declaration of which security schemes are applied for this operation.
303 -- | A declaration of which security schemes are applied for this operation.
248 -- The list of values describes alternative security schemes that can be used
304 -- The list of values describes alternative security schemes that can be used
249 -- (that is, there is a logical OR between the security requirements).
305 -- (that is, there is a logical OR between the security requirements).
250 -- This definition overrides any declared top-level security.
306 -- This definition overrides any declared top-level security.
251 -- To remove a top-level security declaration, @Just []@ can be used.
307 -- To remove a top-level security declaration, @Just []@ can be used.
252− , _swaggerOperationSecurity :: [SwaggerSecurityRequirement]
308+ , _operationSecurity :: [SecurityRequirement]
253− } deriving (Eq, Show, Generic)
309+ } deriving (Eq, Show, Generic, Data, Typeable)
311+newtype MimeList = MimeList { getMimeList :: [MediaType] }
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
314+mimeListConstr :: Constr
315+mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
255−newtype SwaggerMimeList = SwaggerMimeList { getSwaggerMimeList :: [MediaType] }
317+mimeListDataType :: DataType
256− deriving (Eq, Show, Monoid)
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
258-- | Describes a single operation parameter.
327-- | Describes a single operation parameter.
259-- A unique parameter is defined by a combination of a name and location.
328-- A unique parameter is defined by a combination of a name and location.
260−data SwaggerParameter = SwaggerParameter
329+data Param = Param
261 { -- | The name of the parameter.
330 { -- | The name of the parameter.
262 -- Parameter names are case sensitive.
331 -- Parameter names are case sensitive.
263− _swaggerParameterName :: Text
332+ _paramName :: Text
265 -- | A brief description of the parameter.
334 -- | A brief description of the parameter.
266 -- This could contain examples of use.
335 -- This could contain examples of use.
267 -- GFM syntax can be used for rich text representation.
336 -- GFM syntax can be used for rich text representation.
268− , _swaggerParameterDescription :: Maybe Text
337+ , _paramDescription :: Maybe Text
270 -- | Determines whether this parameter is mandatory.
339 -- | Determines whether this parameter is mandatory.
271 -- If the parameter is in "path", this property is required and its value MUST be true.
340 -- If the parameter is in "path", this property is required and its value MUST be true.
272 -- Otherwise, the property MAY be included and its default value is @False@.
341 -- Otherwise, the property MAY be included and its default value is @False@.
273− , _swaggerParameterRequired :: Maybe Bool
342+ , _paramRequired :: Maybe Bool
275 -- | Parameter schema.
344 -- | Parameter schema.
276− , _swaggerParameterSchema :: SwaggerParameterSchema
345+ , _paramSchema :: ParamAnySchema
277− } deriving (Eq, Show, Generic)
346+ } deriving (Eq, Show, Generic, Data, Typeable)
279−data SwaggerParameterSchema
348+data ParamAnySchema
280− = SwaggerParameterBody (SwaggerReferenced SwaggerSchema)
349+ = ParamBody (Referenced Schema)
281− | SwaggerParameterOther SwaggerParameterOtherSchema
350+ | ParamOther ParamOtherSchema
282− deriving (Eq, Show)
351+ deriving (Eq, Show, Generic, Data, Typeable)
284−data SwaggerParameterOtherSchema = SwaggerParameterOtherSchema
353+data ParamOtherSchema = ParamOtherSchema
285 { -- | The location of the parameter.
354 { -- | The location of the parameter.
286− _swaggerParameterOtherSchemaIn :: SwaggerParameterLocation
355+ _paramOtherSchemaIn :: ParamLocation
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
299 -- | Sets the ability to pass empty-valued parameters.
357 -- | Sets the ability to pass empty-valued parameters.
300− -- This is valid only for either @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@
358+ -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
301 -- and allows you to send a parameter with a name only or an empty value.
359 -- and allows you to send a parameter with a name only or an empty value.
302 -- Default value is @False@.
360 -- Default value is @False@.
303− , _swaggerParameterOtherSchemaAllowEmptyValue :: Maybe Bool
361+ , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
305− -- | __Required if type is @'SwaggerParamArray'@__.
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
306− -- Describes the type of items in the array.
364+ } deriving (Eq, Show, Generic, Typeable, Data)
307− , _swaggerParameterOtherSchemaItems :: Maybe SwaggerItems
365+
308−
366+-- | Items for @'SwaggerArray'@ schemas.
309− -- | Determines the format of the array if @'SwaggerParamArray'@ is used.
367+--
310− -- Default value is csv.
368+-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
311− , _swaggerParameterOtherSchemaCollectionFormat :: Maybe SwaggerCollectionFormat
369+-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
312−
370+-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
313− , _swaggerParameterOtherSchemaCommon :: SwaggerSchemaCommon
371+-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
314− } deriving (Eq, Show, Generic)
372+--
315−
373+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
316−data SwaggerParameterType
374+--
317− = SwaggerParamString
375+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
318− | SwaggerParamNumber
376+data SwaggerItems t where
319− | SwaggerParamInteger
377+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
320− | SwaggerParamBoolean
378+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
321− | SwaggerParamArray
379+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
322− | SwaggerParamFile
380+ deriving (Typeable)
323− deriving (Eq, Show)
381+
324−
382+deriving instance Eq (SwaggerItems t)
325−data SwaggerParameterLocation
383+deriving instance Show (SwaggerItems t)
384+--deriving instance Typeable (SwaggerItems t)
386+swaggerItemsPrimitiveConstr :: Constr
387+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
395+swaggerItemsDataType :: DataType
396+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
398+-- Note: unfortunately we have to write these Data instances by hand,
399+-- to get better contexts / avoid duplicate name when using standalone deriving
401+instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
402+ -- TODO: define gfoldl
403+ gunfold k z c = case constrIndex c of
404+ 1 -> k (k (z SwaggerItemsPrimitive))
405+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
406+ toConstr _ = swaggerItemsPrimitiveConstr
407+ dataTypeOf _ = swaggerItemsDataType
409+-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
410+instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411+ -- TODO: define gfoldl
412+ gunfold k z c = case constrIndex c of
413+ 1 -> k (k (z SwaggerItemsPrimitive))
414+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415+ toConstr _ = swaggerItemsPrimitiveConstr
416+ dataTypeOf _ = swaggerItemsDataType
418+instance Data (SwaggerItems 'SwaggerKindSchema) where
419+ gfoldl _ _ (SwaggerItemsPrimitive _ _) = error $ " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
420+ gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
421+ gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
423+ gunfold k z c = case constrIndex c of
424+ 2 -> k (z SwaggerItemsObject)
425+ 3 -> k (z SwaggerItemsArray)
426+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
428+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
432+ dataTypeOf _ = swaggerItemsDataType
434+-- | Type used as a kind to avoid overlapping instances.
436+ = SwaggerKindNormal t
437+ | SwaggerKindParamOtherSchema
441+deriving instance Typeable 'SwaggerKindNormal
442+deriving instance Typeable 'SwaggerKindParamOtherSchema
443+deriving instance Typeable 'SwaggerKindSchema
445+type family SwaggerKindType (k :: SwaggerKind *) :: *
446+type instance SwaggerKindType ('SwaggerKindNormal t) = t
447+type instance SwaggerKindType 'SwaggerKindSchema = Schema
448+type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
450+data SwaggerType t where
451+ SwaggerString :: SwaggerType t
452+ SwaggerNumber :: SwaggerType t
453+ SwaggerInteger :: SwaggerType t
454+ SwaggerBoolean :: SwaggerType t
455+ SwaggerArray :: SwaggerType t
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
461+deriving instance Eq (SwaggerType t)
462+deriving instance Show (SwaggerType t)
464+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
470+swaggerCommonTypes :: [SwaggerType k]
471+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
479+swaggerTypeConstrs :: [Constr]
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485+ toConstr = swaggerTypeConstr
486+ dataTypeOf = swaggerTypeDataType
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490+ toConstr = swaggerTypeConstr
491+ dataTypeOf = swaggerTypeDataType
493+instance Data (SwaggerType 'SwaggerKindSchema) where
494+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495+ toConstr = swaggerTypeConstr
496+ dataTypeOf = swaggerTypeDataType
326 = -- | Parameters that are appended to the URL.
499 = -- | Parameters that are appended to the URL.
327 -- For example, in @/items?id=###@, the query parameter is @id@.
500 -- For example, in @/items?id=###@, the query parameter is @id@.
328− SwaggerParameterQuery
501+ ParamQuery
329 -- | Custom headers that are expected as part of the request.
502 -- | Custom headers that are expected as part of the request.
330− | SwaggerParameterHeader
503+ | ParamHeader
331 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
504 -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
332 -- This does not include the host or base path of the API.
505 -- This does not include the host or base path of the API.
333 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
506 -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
334− | SwaggerParameterPath
507+ | ParamPath
335 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
508 -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
336 -- or @multipart/form-data@ are used as the content type of the request
509 -- or @multipart/form-data@ are used as the content type of the request
337 -- (in Swagger's definition, the @consumes@ property of an operation).
510 -- (in Swagger's definition, the @consumes@ property of an operation).
338− -- This is the only parameter type that can be used to send files, thus supporting the @'SwaggerParamFile'@ type.
511+ -- This is the only parameter type that can be used to send files, thus supporting the @'ParamFile'@ type.
339 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
512 -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
340 -- Form parameters have a different format based on the content-type used
513 -- Form parameters have a different format based on the content-type used
341 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
514 -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
342− | SwaggerParameterFormData
515+ | ParamFormData
343− deriving (Eq, Show)
516+ deriving (Eq, Show, Generic, Data, Typeable)
345−type SwaggerFormat = Text
518+type Format = Text
347-- | Determines the format of the array.
520-- | Determines the format of the array.
348−data SwaggerCollectionFormat
521+data CollectionFormat t where
349− = SwaggerCollectionCSV -- ^ Comma separated values: @foo,bar@.
522+ -- Comma separated values: @foo,bar@.
350− | SwaggerCollectionSSV -- ^ Space separated values: @foo bar@.
523+ CollectionCSV :: CollectionFormat t
351− | SwaggerCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
524+ -- Space separated values: @foo bar@.
352− | SwaggerCollectionPipes -- ^ Pipe separated values: @foo|bar@.
525+ CollectionSSV :: CollectionFormat t
353− | SwaggerCollectionMulti -- ^ Corresponds to multiple parameter instances
526+ -- Tab separated values: @foo\\tbar@.
354− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
527+ CollectionTSV :: CollectionFormat t
355− -- This is valid only for parameters in @'SwaggerParameterQuery'@ or @'SwaggerParameterFormData'@.
528+ -- Pipe separated values: @foo|bar@.
356− deriving (Eq, Show)
529+ CollectionPipes :: CollectionFormat t
357−
530+ -- Corresponds to multiple parameter instances
358−data SwaggerItemsType
531+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
359− = SwaggerItemsString
532+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
360− | SwaggerItemsNumber
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
361− | SwaggerItemsInteger
534+ deriving (Typeable)
362− | SwaggerItemsBoolean
535+
363− | SwaggerItemsArray
536+deriving instance Eq (CollectionFormat t)
364− deriving (Eq, Show)
537+deriving instance Show (CollectionFormat t)
366−data SwaggerSchemaType
539+collectionFormatConstr :: CollectionFormat t -> Constr
367− = SwaggerSchemaArray
540+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
368− | SwaggerSchemaBoolean
541+
369− | SwaggerSchemaInteger
542+collectionFormatDataType :: DataType
370− | SwaggerSchemaNumber
543+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
371− | SwaggerSchemaNull
544+ map collectionFormatConstr collectionCommonFormats
372− | SwaggerSchemaObject
545+
373− | SwaggerSchemaString
546+collectionCommonFormats :: [CollectionFormat t]
374− deriving (Eq, Show)
547+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
376−-- | Determines the format of the nested array.
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
377−data SwaggerItemsCollectionFormat
550+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
378− = SwaggerItemsCollectionCSV -- ^ Comma separated values: @foo,bar@.
551+ toConstr = collectionFormatConstr
379− | SwaggerItemsCollectionSSV -- ^ Space separated values: @foo bar@.
552+ dataTypeOf _ = collectionFormatDataType
380− | SwaggerItemsCollectionTSV -- ^ Tab separated values: @foo\\tbar@.
553+
381− | SwaggerItemsCollectionPipes -- ^ Pipe separated values: @foo|bar@.
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
382− deriving (Eq, Show)
555+
383−
556+type ParamName = Text
384−type SwaggerParamName = Text
557+
385−
558+data Schema = Schema
386−data SwaggerSchema = SwaggerSchema
559+ { _schemaTitle :: Maybe Text
387− { _swaggerSchemaType :: SwaggerSchemaType
560+ , _schemaDescription :: Maybe Text
388− , _swaggerSchemaFormat :: Maybe SwaggerFormat
561+ , _schemaRequired :: [ParamName]
389− , _swaggerSchemaTitle :: Maybe Text
562+
390− , _swaggerSchemaDescription :: Maybe Text
563+ , _schemaAllOf :: Maybe [Referenced Schema]
391− , _swaggerSchemaRequired :: [SwaggerParamName]
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
392−
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
393− , _swaggerSchemaItems :: Maybe SwaggerSchemaItems
566+
394− , _swaggerSchemaAllOf :: Maybe [SwaggerSchema]
567+ , _schemaDiscriminator :: Maybe Text
395− , _swaggerSchemaProperties :: HashMap Text (SwaggerReferenced SwaggerSchema)
568+ , _schemaReadOnly :: Maybe Bool
396− , _swaggerSchemaAdditionalProperties :: Maybe SwaggerSchema
569+ , _schemaXml :: Maybe Xml
397−
570+ , _schemaExternalDocs :: Maybe ExternalDocs
398− , _swaggerSchemaDiscriminator :: Maybe Text
571+ , _schemaExample :: Maybe Value
399− , _swaggerSchemaReadOnly :: Maybe Bool
572+
400− , _swaggerSchemaXml :: Maybe SwaggerXml
573+ , _schemaMaxProperties :: Maybe Integer
401− , _swaggerSchemaExternalDocs :: Maybe SwaggerExternalDocs
574+ , _schemaMinProperties :: Maybe Integer
402− , _swaggerSchemaExample :: Maybe Value
575+
403−
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
404− , _swaggerSchemaMaxProperties :: Maybe Integer
577+ } deriving (Eq, Show, Generic, Data, Typeable)
405− , _swaggerSchemaMinProperties :: Maybe Integer
578+
406−
579+-- | A @'Schema'@ with an optional name.
407− , _swaggerSchemaCommon :: SwaggerSchemaCommon
580+-- This name can be used in references.
408− } deriving (Eq, Show, Generic)
581+data NamedSchema = NamedSchema
409−
582+ { _namedSchemaName :: Maybe Text
410−data SwaggerSchemaItems
583+ , _namedSchemaSchema :: Schema
411− = SwaggerSchemaItemsObject (SwaggerReferenced SwaggerSchema)
584+ } deriving (Eq, Show, Generic, Data, Typeable)
412− | SwaggerSchemaItemsArray [SwaggerReferenced SwaggerSchema]
585+
413− deriving (Eq, Show)
586+-- | Regex pattern for @string@ type.
414−
587+type Pattern = Text
415−data SwaggerSchemaCommon = SwaggerSchemaCommon
588+
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
416 { -- | Declares the value of the parameter that the server will use if none is provided,
590 { -- | Declares the value of the parameter that the server will use if none is provided,
417 -- for example a @"count"@ to control the number of results per page might default to @100@
591 -- for example a @"count"@ to control the number of results per page might default to @100@
418 -- if not supplied by the client in the request.
592 -- if not supplied by the client in the request.
419 -- (Note: "default" has no meaning for required parameters.)
593 -- (Note: "default" has no meaning for required parameters.)
420 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
421− _swaggerSchemaDefault :: Maybe Value
595+ _paramSchemaDefault :: Maybe Value
423− , _swaggerSchemaMaximum :: Maybe Integer
597+ , _paramSchemaType :: Maybe (SwaggerType t)
424− , _swaggerSchemaExclusiveMaximum :: Maybe Bool
598+ , _paramSchemaFormat :: Maybe Format
425− , _swaggerSchemaMinimum :: Maybe Integer
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
426− , _swaggerSchemaExclusiveMinimum :: Maybe Bool
600+ , _paramSchemaMaximum :: Maybe Scientific
427− , _swaggerSchemaMaxLength :: Maybe Integer
601+ , _paramSchemaExclusiveMaximum :: Maybe Bool
428− , _swaggerSchemaMinLength :: Maybe Integer
602+ , _paramSchemaMinimum :: Maybe Scientific
429− , _swaggerSchemaPattern :: Maybe Text
603+ , _paramSchemaExclusiveMinimum :: Maybe Bool
430− , _swaggerSchemaMaxItems :: Maybe Integer
604+ , _paramSchemaMaxLength :: Maybe Integer
431− , _swaggerSchemaMinItems :: Maybe Integer
605+ , _paramSchemaMinLength :: Maybe Integer
432− , _swaggerSchemaUniqueItems :: Maybe Bool
606+ , _paramSchemaPattern :: Maybe Pattern
433− , _swaggerSchemaEnum :: Maybe [Value]
607+ , _paramSchemaMaxItems :: Maybe Integer
434− , _swaggerSchemaMultipleOf :: Maybe Integer
608+ , _paramSchemaMinItems :: Maybe Integer
435− } deriving (Eq, Show, Generic)
609+ , _paramSchemaUniqueItems :: Maybe Bool
436−
610+ , _paramSchemaEnum :: Maybe [Value]
437−data SwaggerXml = SwaggerXml
611+ , _paramSchemaMultipleOf :: Maybe Scientific
612+ } deriving (Eq, Show, Generic, Typeable)
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
438 { -- | Replaces the name of the element/attribute used for the described schema property.
617 { -- | Replaces the name of the element/attribute used for the described schema property.
439 -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
618 -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
440 -- When defined alongside type being array (outside the items),
619 -- When defined alongside type being array (outside the items),
441 -- it will affect the wrapping element and only if wrapped is true.
620 -- it will affect the wrapping element and only if wrapped is true.
442 -- If wrapped is false, it will be ignored.
621 -- If wrapped is false, it will be ignored.
443− _swaggerXmlName :: Maybe Text
622+ _xmlName :: Maybe Text
445 -- | The URL of the namespace definition.
624 -- | The URL of the namespace definition.
446 -- Value SHOULD be in the form of a URL.
625 -- Value SHOULD be in the form of a URL.
447− , _swaggerXmlNamespace :: Maybe Text
626+ , _xmlNamespace :: Maybe Text
449 -- | The prefix to be used for the name.
628 -- | The prefix to be used for the name.
450− , _swaggerXmlPrefix :: Maybe Text
629+ , _xmlPrefix :: Maybe Text
452 -- | Declares whether the property definition translates to an attribute instead of an element.
631 -- | Declares whether the property definition translates to an attribute instead of an element.
453 -- Default value is @False@.
632 -- Default value is @False@.
454− , _swaggerXmlAttribute :: Maybe Bool
633+ , _xmlAttribute :: Maybe Bool
456 -- | MAY be used only for an array definition.
635 -- | MAY be used only for an array definition.
457 -- Signifies whether the array is wrapped
636 -- Signifies whether the array is wrapped
@@ -459,103 +638,87 @@ data SwaggerXml = SwaggerXml
459 -- or unwrapped (@\<book/\>\<book/\>@).
638 -- or unwrapped (@\<book/\>\<book/\>@).
460 -- Default value is @False@.
639 -- Default value is @False@.
461 -- The definition takes effect only when defined alongside type being array (outside the items).
640 -- The definition takes effect only when defined alongside type being array (outside the items).
462− , _swaggerXmlWrapped :: Maybe Bool
641+ , _xmlWrapped :: Maybe Bool
463− } deriving (Eq, Show, Generic)
642+ } deriving (Eq, Show, Generic, Data, Typeable)
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 :: Maybe SwaggerFormat
472− -- | __Required if type is @'SwaggerItemsArray'@.__
473− -- Describes the type of items in the array.
474− , _swaggerItemsItems :: Maybe SwaggerItems
476− -- | Determines the format of the array if type array is used.
477− -- Default value is @'SwaggerItemsCollectionCSV'@.
478− , _swaggerItemsCollectionFormat :: Maybe SwaggerItemsCollectionFormat
480− , _swaggerItemsCommon :: SwaggerSchemaCommon
481− } deriving (Eq, Show, Generic)
483-- | A container for the expected responses of an operation.
644-- | A container for the expected responses of an operation.
484-- The container maps a HTTP response code to the expected response.
645-- The container maps a HTTP response code to the expected response.
485-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
646-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
486-- since they may not be known in advance.
647-- since they may not be known in advance.
487-- However, it is expected from the documentation to cover a successful operation response and any known errors.
648-- However, it is expected from the documentation to cover a successful operation response and any known errors.
488−data SwaggerResponses = SwaggerResponses
649+data Responses = Responses
489 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
650 { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
490 -- It can be used to cover undeclared responses.
651 -- It can be used to cover undeclared responses.
491− _swaggerResponsesDefault :: Maybe (SwaggerReferenced SwaggerResponse)
652+ _responsesDefault :: Maybe (Referenced Response)
493 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
494 -- Describes the expected response for those HTTP status codes.
655 -- Describes the expected response for those HTTP status codes.
495− , _swaggerResponsesResponses :: HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
496− } deriving (Eq, Show, Generic)
657+ } deriving (Eq, Show, Generic, Data, Typeable)
498type HttpStatusCode = Int
659type HttpStatusCode = Int
500-- | Describes a single response from an API Operation.
661-- | Describes a single response from an API Operation.
501−data SwaggerResponse = SwaggerResponse
662+data Response = Response
502 { -- | A short description of the response.
663 { -- | A short description of the response.
503 -- GFM syntax can be used for rich text representation.
664 -- GFM syntax can be used for rich text representation.
504− _swaggerResponseDescription :: Text
665+ _responseDescription :: Text
506 -- | A definition of the response structure.
667 -- | A definition of the response structure.
507 -- It can be a primitive, an array or an object.
668 -- It can be a primitive, an array or an object.
508 -- If this field does not exist, it means no content is returned as part of the response.
669 -- If this field does not exist, it means no content is returned as part of the response.
509 -- As an extension to the Schema Object, its root type value may also be "file".
670 -- As an extension to the Schema Object, its root type value may also be "file".
510 -- This SHOULD be accompanied by a relevant produces mime-type.
671 -- This SHOULD be accompanied by a relevant produces mime-type.
511− , _swaggerResponseSchema :: Maybe (SwaggerReferenced SwaggerSchema)
672+ , _responseSchema :: Maybe (Referenced Schema)
513 -- | A list of headers that are sent with the response.
674 -- | A list of headers that are sent with the response.
514− , _swaggerResponseHeaders :: HashMap HeaderName SwaggerHeader
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
516 -- | An example of the response message.
677 -- | An example of the response message.
517− , _swaggerResponseExamples :: Maybe SwaggerExample
678+ , _responseExamples :: Maybe Example
518− } deriving (Eq, Show, Generic)
679+ } deriving (Eq, Show, Generic, Data, Typeable)
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
520type HeaderName = Text
684type HeaderName = Text
522−data SwaggerHeader = SwaggerHeader
686+data Header = Header
523 { -- | A short description of the header.
687 { -- | A short description of the header.
524− _swaggerHeaderDescription :: Maybe Text
688+ _headerDescription :: Maybe Text
526− -- | The type of the object.
527− , _swaggerHeaderType :: SwaggerItemsType
529− -- | The extending format for the previously mentioned type. See Data Type Formats for further details.
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
530− , _swaggerHeaderFormat :: Maybe SwaggerFormat
691+ } deriving (Eq, Show, Generic, Data, Typeable)
532− -- | __Required if type is @'SwaggerItemsArray'@__.
693+data Example = Example { getExample :: Map MediaType Value }
533− -- Describes the type of items in the array.
694+ deriving (Eq, Show, Generic, Typeable)
534− , _swaggerHeaderItems :: Maybe SwaggerItems
536− -- | Determines the format of the array if type array is used.
696+exampleConstr :: Constr
537− -- Default value is @'SwaggerItemsCollectionCSV'@.
697+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
538− , _swaggerHeaderCollectionFormat :: Maybe SwaggerItemsCollectionFormat
540− , _swaggerHeaderCommon :: SwaggerSchemaCommon
699+exampleDataType :: DataType
541− } deriving (Eq, Show, Generic)
700+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
543−data SwaggerExample = SwaggerExample { getSwaggerExample :: Map MediaType Value }
702+instance Data Example where
544− deriving (Eq, Show)
703+ gunfold k z c = case constrIndex c of
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
546-- | The location of the API key.
709-- | The location of the API key.
547−data SwaggerApiKeyLocation
710+data ApiKeyLocation
548− = SwaggerApiKeyQuery
711+ = ApiKeyQuery
549− | SwaggerApiKeyHeader
712+ | ApiKeyHeader
550− deriving (Eq, Show)
713+ deriving (Eq, Show, Generic, Data, Typeable)
552−data SwaggerApiKeyParams = SwaggerApiKeyParams
715+data ApiKeyParams = ApiKeyParams
553 { -- | The name of the header or query parameter to be used.
716 { -- | The name of the header or query parameter to be used.
554− _swaggerApiKeyName :: Text
717+ _apiKeyName :: Text
556 -- | The location of the API key.
719 -- | The location of the API key.
557− , _swaggerApiKeyIn :: SwaggerApiKeyLocation
720+ , _apiKeyIn :: ApiKeyLocation
558− } deriving (Eq, Show)
721+ } deriving (Eq, Show, Generic, Data, Typeable)
560-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
723-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
561type AuthorizationURL = Text
724type AuthorizationURL = Text
@@ -563,447 +726,702 @@ type AuthorizationURL = Text
563-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
726-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
564type TokenURL = Text
727type TokenURL = Text
566−data SwaggerOAuth2Flow
729+data OAuth2Flow
567− = SwaggerOAuth2Implicit AuthorizationURL
730+ = OAuth2Implicit AuthorizationURL
568− | SwaggerOAuth2Password TokenURL
731+ | OAuth2Password TokenURL
569− | SwaggerOAuth2Application TokenURL
732+ | OAuth2Application TokenURL
570− | SwaggerOAuth2AccessCode AuthorizationURL TokenURL
733+ | OAuth2AccessCode AuthorizationURL TokenURL
571− deriving (Eq, Show)
734+ deriving (Eq, Show, Generic, Data, Typeable)
573−data SwaggerOAuth2Params = SwaggerOAuth2Params
736+data OAuth2Params = OAuth2Params
574 { -- | The flow used by the OAuth2 security scheme.
737 { -- | The flow used by the OAuth2 security scheme.
575− _swaggerOAuth2Flow :: SwaggerOAuth2Flow
738+ _oauth2Flow :: OAuth2Flow
577 -- | The available scopes for the OAuth2 security scheme.
740 -- | The available scopes for the OAuth2 security scheme.
578− , _swaggerOAuth2Scopes :: HashMap Text Text
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
579− } deriving (Eq, Show, Generic)
742+ } deriving (Eq, Show, Generic, Data, Typeable)
581−data SwaggerSecuritySchemeType
744+data SecuritySchemeType
582− = SwaggerSecuritySchemeBasic
745+ = SecuritySchemeBasic
583− | SwaggerSecuritySchemeApiKey SwaggerApiKeyParams
746+ | SecuritySchemeApiKey ApiKeyParams
584− | SwaggerSecuritySchemeOAuth2 SwaggerOAuth2Params
747+ | SecuritySchemeOAuth2 OAuth2Params
585− deriving (Eq, Show)
748+ deriving (Eq, Show, Generic, Data, Typeable)
587−data SwaggerSecurityScheme = SwaggerSecurityScheme
750+data SecurityScheme = SecurityScheme
588 { -- | The type of the security scheme.
751 { -- | The type of the security scheme.
589− _swaggerSecuritySchemeType :: SwaggerSecuritySchemeType
752+ _securitySchemeType :: SecuritySchemeType
591 -- | A short description for security scheme.
754 -- | A short description for security scheme.
592− , _swaggerSecuritySchemeDescription :: Maybe Text
755+ , _securitySchemeDescription :: Maybe Text
593− } deriving (Eq, Show, Generic)
756+ } deriving (Eq, Show, Generic, Data, Typeable)
759+-- | merge scopes of two OAuth2 security schemes when their flows are identical.
760+-- In other case returns first security scheme
761+mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
762+mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
763+ s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
764+ = if flow1 == flow2 then
765+ SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
768+mergeSecurityScheme s1 _ = s1
770+newtype SecurityDefinitions
771+ = SecurityDefinitions (Definitions SecurityScheme)
772+ deriving (Eq, Show, Generic, Data, Typeable)
595-- | Lists the required security schemes to execute this operation.
774-- | Lists the required security schemes to execute this operation.
596-- The object can have multiple security schemes declared in it which are all required
775-- The object can have multiple security schemes declared in it which are all required
597-- (that is, there is a logical AND between the schemes).
776-- (that is, there is a logical AND between the schemes).
598−newtype SwaggerSecurityRequirement = SwaggerSecurityRequirement
777+newtype SecurityRequirement = SecurityRequirement
599− { getSwaggerSecurityRequirement :: HashMap Text [Text]
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
600− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON)
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
602−-- | Allows adding meta data to a single tag that is used by @SwaggerOperation@.
781+-- | Tag name.
603−-- It is not mandatory to have a @SwaggerTag@ per tag used there.
782+type TagName = Text
604−data SwaggerTag = SwaggerTag
783+
784+-- | Allows adding meta data to a single tag that is used by @Operation@.
785+-- It is not mandatory to have a @Tag@ per tag used there.
605 { -- | The name of the tag.
787 { -- | The name of the tag.
606− _swaggerTagName :: Text
788+ _tagName :: TagName
608 -- | A short description for the tag.
790 -- | A short description for the tag.
609 -- GFM syntax can be used for rich text representation.
791 -- GFM syntax can be used for rich text representation.
610− , _swaggerTagDescription :: Maybe Text
792+ , _tagDescription :: Maybe Text
612 -- | Additional external documentation for this tag.
794 -- | Additional external documentation for this tag.
613− , _swaggerTagExternalDocs :: Maybe SwaggerExternalDocs
795+ , _tagExternalDocs :: Maybe ExternalDocs
614− } deriving (Eq, Show)
796+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
798+instance Hashable Tag
800+instance IsString Tag where
801+ fromString s = Tag (fromString s) Nothing Nothing
616-- | Allows referencing an external resource for extended documentation.
803-- | Allows referencing an external resource for extended documentation.
617−data SwaggerExternalDocs = SwaggerExternalDocs
804+data ExternalDocs = ExternalDocs
618 { -- | A short description of the target documentation.
805 { -- | A short description of the target documentation.
619 -- GFM syntax can be used for rich text representation.
806 -- GFM syntax can be used for rich text representation.
620− _swaggerExternalDocsDescription :: Maybe Text
807+ _externalDocsDescription :: Maybe Text
622 -- | The URL for the target documentation.
809 -- | The URL for the target documentation.
623− , _swaggerExternalDocsUrl :: URL
810+ , _externalDocsUrl :: URL
624− } deriving (Eq, Show, Generic)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
813+instance Hashable ExternalDocs
626-- | A simple object to allow referencing other definitions in the specification.
815-- | A simple object to allow referencing other definitions in the specification.
627-- It can be used to reference parameters and responses that are defined at the top level for reuse.
816-- It can be used to reference parameters and responses that are defined at the top level for reuse.
628−newtype SwaggerReference = SwaggerReference { getSwaggerReference :: Text }
817+newtype Reference = Reference { getReference :: Text }
629− deriving (Eq, Show)
818+ deriving (Eq, Show, Data, Typeable)
823+ deriving (Eq, Show, Functor, Data, Typeable)
631−data SwaggerReferenced a
825+instance IsString a => IsString (Referenced a) where
632− = SwaggerRef SwaggerReference
826+ fromString = Inline . fromString
636−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON)
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
638-- =======================================================================
835-- =======================================================================
639-- Monoid instances
836-- Monoid instances
640-- =======================================================================
837-- =======================================================================
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
642instance Monoid Swagger where
841instance Monoid Swagger where
643 mempty = genericMempty
842 mempty = genericMempty
644− mappend = genericMappend
843+ mappend = (<>)
845+instance Semigroup Info where
846+ (<>) = genericMappend
847+instance Monoid Info where
848+ mempty = genericMempty
851+instance Semigroup Contact where
852+ (<>) = genericMappend
853+instance Monoid Contact where
854+ mempty = genericMempty
646−instance Monoid SwaggerInfo where
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
859+instance Monoid PathItem where
647 mempty = genericMempty
860 mempty = genericMempty
648− mappend = genericMappend
861+ mappend = (<>)
650−instance Monoid SwaggerPaths where
863+instance Semigroup Schema where
864+ (<>) = genericMappend
865+instance Monoid Schema where
651 mempty = genericMempty
866 mempty = genericMempty
652− mappend = genericMappend
867+ mappend = (<>)
654−instance Monoid SwaggerPathItem where
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
871+instance Monoid (ParamSchema t) where
655 mempty = genericMempty
872 mempty = genericMempty
656− mappend = genericMappend
873+ mappend = (<>)
658−instance Monoid SwaggerSchema where
875+instance Semigroup Param where
876+ (<>) = genericMappend
877+instance Monoid Param where
659 mempty = genericMempty
878 mempty = genericMempty
660− mappend = genericMappend
879+ mappend = (<>)
662−instance Monoid SwaggerSchemaCommon where
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
883+instance Monoid ParamOtherSchema where
663 mempty = genericMempty
884 mempty = genericMempty
664− mappend = genericMappend
885+ mappend = (<>)
666−instance Monoid SwaggerParameter where
887+instance Semigroup Header where
888+ (<>) = genericMappend
889+instance Monoid Header where
667 mempty = genericMempty
890 mempty = genericMempty
668− mappend = genericMappend
891+ mappend = (<>)
670−instance Monoid SwaggerParameterOtherSchema where
893+instance Semigroup Responses where
894+ (<>) = genericMappend
895+instance Monoid Responses where
671 mempty = genericMempty
896 mempty = genericMempty
672− mappend = genericMappend
897+ mappend = (<>)
674−instance Monoid SwaggerResponses where
899+instance Semigroup Response where
900+ (<>) = genericMappend
901+instance Monoid Response where
675 mempty = genericMempty
902 mempty = genericMempty
676− mappend = genericMappend
903+ mappend = (<>)
678−instance Monoid SwaggerResponse where
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
907+instance Monoid ExternalDocs where
679 mempty = genericMempty
908 mempty = genericMempty
680− mappend = genericMappend
909+ mappend = (<>)
682−instance Monoid SwaggerExternalDocs where
911+instance Semigroup Operation where
912+ (<>) = genericMappend
913+instance Monoid Operation where
683 mempty = genericMempty
914 mempty = genericMempty
684− mappend = genericMappend
915+ mappend = (<>)
686−instance Monoid SwaggerOperation where
917+instance Semigroup Example where
918+ (<>) = genericMappend
919+instance Monoid Example where
687 mempty = genericMempty
920 mempty = genericMempty
688− mappend = genericMappend
921+ mappend = (<>)
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
690-- =======================================================================
934-- =======================================================================
691-- SwaggerMonoid helper instances
935-- SwaggerMonoid helper instances
692-- =======================================================================
936-- =======================================================================
694−instance SwaggerMonoid SwaggerInfo
938+instance SwaggerMonoid Info
695−instance SwaggerMonoid SwaggerPaths
939+instance SwaggerMonoid PathItem
696−instance SwaggerMonoid SwaggerPathItem
940+instance SwaggerMonoid Schema
697−instance SwaggerMonoid SwaggerSchema
941+instance SwaggerMonoid (ParamSchema t)
698−instance SwaggerMonoid SwaggerSchemaCommon
942+instance SwaggerMonoid Param
699−instance SwaggerMonoid SwaggerParameter
943+instance SwaggerMonoid ParamOtherSchema
700−instance SwaggerMonoid SwaggerParameterOtherSchema
944+instance SwaggerMonoid Responses
701−instance SwaggerMonoid SwaggerResponses
945+instance SwaggerMonoid Response
702−instance SwaggerMonoid SwaggerResponse
946+instance SwaggerMonoid ExternalDocs
703−instance SwaggerMonoid SwaggerExternalDocs
947+instance SwaggerMonoid Operation
704−instance SwaggerMonoid SwaggerOperation
948+instance SwaggerMonoid SecurityDefinitions
705−
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
706−instance SwaggerMonoid SwaggerMimeList
950+
951+instance SwaggerMonoid MimeList
707deriving instance SwaggerMonoid URL
952deriving instance SwaggerMonoid URL
709−instance SwaggerMonoid SwaggerSchemaType where
954+instance SwaggerMonoid (SwaggerType t) where
710− swaggerMempty = SwaggerSchemaNull
955+ swaggerMempty = SwaggerString
711 swaggerMappend _ y = y
956 swaggerMappend _ y = y
713−instance SwaggerMonoid SwaggerParameterType where
958+instance SwaggerMonoid ParamLocation where
714− swaggerMempty = SwaggerParamString
959+ swaggerMempty = ParamQuery
715 swaggerMappend _ y = y
960 swaggerMappend _ y = y
717−instance SwaggerMonoid SwaggerParameterLocation where
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
718− swaggerMempty = SwaggerParameterQuery
963+ swaggerMempty = InsOrdHashMap.empty
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
966+instance Monoid a => SwaggerMonoid (Referenced a) where
967+ swaggerMempty = Inline mempty
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
719 swaggerMappend _ y = y
969 swaggerMappend _ y = y
721−instance SwaggerMonoid (HashMap Text SwaggerSchema) where
971+instance SwaggerMonoid ParamAnySchema where
722− swaggerMempty = HashMap.empty
972+ swaggerMempty = ParamOther swaggerMempty
723− swaggerMappend = HashMap.unionWith mappend
973+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975+ swaggerMappend _ y = y
977+-- =======================================================================
978+-- Simple Generic-based ToJSON instances
979+-- =======================================================================
981+instance ToJSON ParamLocation where
982+ toJSON = genericToJSON (jsonPrefix "Param")
725−instance SwaggerMonoid (HashMap Text (SwaggerReferenced SwaggerSchema)) where
984+instance ToJSON Info where
726− swaggerMempty = HashMap.empty
985+ toJSON = genericToJSON (jsonPrefix "Info")
727− swaggerMappend = HashMap.unionWith swaggerMappend
729−instance Monoid a => SwaggerMonoid (SwaggerReferenced a) where
987+instance ToJSON Contact where
730− swaggerMempty = SwaggerInline mempty
988+ toJSON = genericToJSON (jsonPrefix "Contact")
731− swaggerMappend (SwaggerInline x) (SwaggerInline y) = SwaggerInline (x <> y)
732− swaggerMappend _ y = y
734−instance SwaggerMonoid (HashMap Text SwaggerParameter) where
990+instance ToJSON License where
735− swaggerMempty = HashMap.empty
991+ toJSON = genericToJSON (jsonPrefix "License")
736− swaggerMappend = HashMap.unionWith mappend
738−instance SwaggerMonoid (HashMap Text SwaggerResponse) where
993+instance ToJSON ApiKeyLocation where
739− swaggerMempty = HashMap.empty
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
740− swaggerMappend = flip HashMap.union
742−instance SwaggerMonoid (HashMap Text SwaggerSecurityScheme) where
996+instance ToJSON ApiKeyParams where
743− swaggerMempty = HashMap.empty
997+ toJSON = genericToJSON (jsonPrefix "apiKey")
744− swaggerMappend = flip HashMap.union
746−instance SwaggerMonoid (HashMap FilePath SwaggerPathItem) where
999+instance ToJSON Scheme where
747− swaggerMempty = HashMap.empty
1000+ toJSON = genericToJSON (jsonPrefix "")
748− swaggerMappend = HashMap.unionWith mappend
750−instance SwaggerMonoid (HashMap HeaderName SwaggerHeader) where
1002+instance ToJSON Tag where
751− swaggerMempty = HashMap.empty
1003+ toJSON = genericToJSON (jsonPrefix "Tag")
752− swaggerMappend = flip HashMap.union
754−instance SwaggerMonoid (HashMap HttpStatusCode (SwaggerReferenced SwaggerResponse)) where
1005+instance ToJSON ExternalDocs where
755− swaggerMempty = HashMap.empty
1006+ toJSON = genericToJSON (jsonPrefix "ExternalDocs")
756− swaggerMappend = flip HashMap.union
758−instance SwaggerMonoid SwaggerParameterSchema where
1008+instance ToJSON Xml where
759− swaggerMempty = SwaggerParameterOther swaggerMempty
1009+ toJSON = genericToJSON (jsonPrefix "Xml")
760− swaggerMappend (SwaggerParameterBody x) (SwaggerParameterBody y) = SwaggerParameterBody (swaggerMappend x y)
761− swaggerMappend (SwaggerParameterOther x) (SwaggerParameterOther y) = SwaggerParameterOther (swaggerMappend x y)
762− swaggerMappend _ y = y
764-- =======================================================================
1011-- =======================================================================
765−-- TH derived ToJSON and FromJSON instances
1012+-- Simple Generic-based FromJSON instances
766-- =======================================================================
1013-- =======================================================================
768−deriveJSON (jsonPrefix "SwaggerParameter") ''SwaggerParameterLocation
1015+instance FromJSON ParamLocation where
769−deriveJSON (jsonPrefix "SwaggerParam") ''SwaggerParameterType
1016+ parseJSON = genericParseJSON (jsonPrefix "Param")
770−deriveJSON' ''SwaggerInfo
1017+
771−deriveJSON' ''SwaggerContact
1018+instance FromJSON Info where
772−deriveJSON' ''SwaggerLicense
1019+ parseJSON = genericParseJSON (jsonPrefix "Info")
773−deriveJSON (jsonPrefix "SwaggerSchema") ''SwaggerSchemaType
1020+
774−deriveJSON (jsonPrefix "SwaggerItems") ''SwaggerItemsType
1021+instance FromJSON Contact where
775−deriveJSON (jsonPrefix "SwaggerItemsCollection") ''SwaggerItemsCollectionFormat
1022+ parseJSON = genericParseJSON (jsonPrefix "Contact")
776−deriveJSON (jsonPrefix "SwaggerCollection") ''SwaggerCollectionFormat
1023+
777−deriveJSON (jsonPrefix "SwaggerApiKey") ''SwaggerApiKeyLocation
1024+instance FromJSON License where
778−deriveJSON (jsonPrefix "swaggerApiKey") ''SwaggerApiKeyParams
1025+ parseJSON = genericParseJSON (jsonPrefix "License")
779−deriveJSON (jsonPrefix "swaggerSchema") ''SwaggerSchemaCommon
1026+
780−deriveJSONDefault ''SwaggerScheme
1027+instance FromJSON ApiKeyLocation where
781−deriveJSON' ''SwaggerTag
1028+ parseJSON = genericParseJSON (jsonPrefix "ApiKey")
782−deriveJSON' ''SwaggerExternalDocs
1029+
783−
1030+instance FromJSON ApiKeyParams where
784−deriveToJSON' ''SwaggerOperation
1031+ parseJSON = genericParseJSON (jsonPrefix "apiKey")
785−deriveToJSON' ''SwaggerResponse
1032+
786−deriveToJSON' ''SwaggerPathItem
1033+instance FromJSON Scheme where
787−deriveToJSON' ''SwaggerXml
1034+ parseJSON = genericParseJSON (jsonPrefix "")
1036+instance FromJSON Tag where
1037+ parseJSON = genericParseJSON (jsonPrefix "Tag")
1039+instance FromJSON ExternalDocs where
1040+ parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
789-- =======================================================================
1042-- =======================================================================
790-- Manual ToJSON instances
1043-- Manual ToJSON instances
791-- =======================================================================
1044-- =======================================================================
793−instance ToJSON SwaggerOAuth2Flow where
1046+instance ToJSON OAuth2Flow where
794− toJSON (SwaggerOAuth2Implicit authUrl) = object
1047+ toJSON (OAuth2Implicit authUrl) = object
795 [ "flow" .= ("implicit" :: Text)
1048 [ "flow" .= ("implicit" :: Text)
796 , "authorizationUrl" .= authUrl ]
1049 , "authorizationUrl" .= authUrl ]
797− toJSON (SwaggerOAuth2Password tokenUrl) = object
1050+ toJSON (OAuth2Password tokenUrl) = object
798 [ "flow" .= ("password" :: Text)
1051 [ "flow" .= ("password" :: Text)
799 , "tokenUrl" .= tokenUrl ]
1052 , "tokenUrl" .= tokenUrl ]
800− toJSON (SwaggerOAuth2Application tokenUrl) = object
1053+ toJSON (OAuth2Application tokenUrl) = object
801 [ "flow" .= ("application" :: Text)
1054 [ "flow" .= ("application" :: Text)
802 , "tokenUrl" .= tokenUrl ]
1055 , "tokenUrl" .= tokenUrl ]
803− toJSON (SwaggerOAuth2AccessCode authUrl tokenUrl) = object
1056+ toJSON (OAuth2AccessCode authUrl tokenUrl) = object
804 [ "flow" .= ("accessCode" :: Text)
1057 [ "flow" .= ("accessCode" :: Text)
805 , "authorizationUrl" .= authUrl
1058 , "authorizationUrl" .= authUrl
806 , "tokenUrl" .= tokenUrl ]
1059 , "tokenUrl" .= tokenUrl ]
808−instance ToJSON SwaggerOAuth2Params where
1061+instance ToJSON OAuth2Params where
809− toJSON = genericToJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1062+ toJSON = sopSwaggerGenericToJSON
811−instance ToJSON SwaggerSecuritySchemeType where
1065+instance ToJSON SecuritySchemeType where
812− toJSON SwaggerSecuritySchemeBasic
1066+ toJSON SecuritySchemeBasic
813 = object [ "type" .= ("basic" :: Text) ]
1067 = object [ "type" .= ("basic" :: Text) ]
814− toJSON (SwaggerSecuritySchemeApiKey params)
1068+ toJSON (SecuritySchemeApiKey params)
815 = toJSON params
1069 = toJSON params
816 <+> object [ "type" .= ("apiKey" :: Text) ]
1070 <+> object [ "type" .= ("apiKey" :: Text) ]
817− toJSON (SwaggerSecuritySchemeOAuth2 params)
1071+ toJSON (SecuritySchemeOAuth2 params)
818 = toJSON params
1072 = toJSON params
819 <+> object [ "type" .= ("oauth2" :: Text) ]
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
821instance ToJSON Swagger where
1075instance ToJSON Swagger where
822− toJSON = addVersion . genericToJSON (jsonPrefix "swagger")
1076+ toJSON = sopSwaggerGenericToJSON
823− where
1077+ DEFINE_TOENCODING
824− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
1078+
825− addVersion _ = error "impossible"
1079+instance ToJSON SecurityScheme where
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
827−instance ToJSON SwaggerSecurityScheme where
1115+instance ToJSON MimeList where
828− toJSON = genericToJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
1116+ toJSON (MimeList xs) = toJSON (map show xs)
830−instance ToJSON SwaggerSchema where
1118+instance ToJSON Param where
831− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerSchema")
1119+ toJSON = sopSwaggerGenericToJSON
833−instance ToJSON SwaggerHeader where
1122+instance ToJSON ParamAnySchema where
834− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerHeader")
1123+ toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124+ toJSON (ParamOther s) = toJSON s
836−instance ToJSON SwaggerItems where
1126+instance ToJSON ParamOtherSchema where
837− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerItems")
1127+ toJSON = sopSwaggerGenericToJSON
839−instance ToJSON SwaggerHost where
1130+instance ToJSON Responses where
840− toJSON (SwaggerHost host mport) = toJSON $
1131+ toJSON = sopSwaggerGenericToJSON
841− case mport of
1132+ DEFINE_TOENCODING
842− Nothing -> host
1133+
843− Just port -> host ++ ":" ++ show port
1134+instance ToJSON Response where
1135+ toJSON = sopSwaggerGenericToJSON
1138+instance ToJSON Operation where
1139+ toJSON = sopSwaggerGenericToJSON
845−instance ToJSON SwaggerPaths where
1142+instance ToJSON PathItem where
846− toJSON (SwaggerPaths m) = toJSON m
1143+ toJSON = sopSwaggerGenericToJSON
848−instance ToJSON SwaggerMimeList where
1146+instance ToJSON Example where
849− toJSON (SwaggerMimeList xs) = toJSON (map show xs)
1147+ toJSON = toJSON . Map.mapKeys show . getExample
851−instance ToJSON SwaggerParameter where
1149+instance ToJSON SecurityDefinitions where
852− toJSON = genericToJSONWithSub "schema" (jsonPrefix "swaggerParameter")
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
854−instance ToJSON SwaggerParameterSchema where
1152+instance ToJSON Reference where
855− toJSON (SwaggerParameterBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1153+ toJSON (Reference ref) = object [ "$ref" .= ref ]
856− toJSON (SwaggerParameterOther s) = toJSON s
858−instance ToJSON SwaggerParameterOtherSchema where
1155+referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
859− toJSON = genericToJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
1156+referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
1157+referencedToJSON _ (Inline x) = toJSON x
861−instance ToJSON SwaggerSchemaItems where
1159+instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
862− toJSON (SwaggerSchemaItemsObject x) = toJSON x
1160+instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
863− toJSON (SwaggerSchemaItemsArray xs) = toJSON xs
1161+instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
865−instance ToJSON SwaggerResponses where
1163+instance ToJSON (SwaggerType t) where
866− toJSON (SwaggerResponses def rs) = toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1164+ toJSON SwaggerArray = "array"
1165+ toJSON SwaggerString = "string"
1166+ toJSON SwaggerInteger = "integer"
1167+ toJSON SwaggerNumber = "number"
1168+ toJSON SwaggerBoolean = "boolean"
1169+ toJSON SwaggerFile = "file"
1170+ toJSON SwaggerNull = "null"
1171+ toJSON SwaggerObject = "object"
868−instance ToJSON SwaggerExample where
1173+instance ToJSON (CollectionFormat t) where
869− toJSON = toJSON . Map.mapKeys show . getSwaggerExample
1174+ toJSON CollectionCSV = "csv"
1175+ toJSON CollectionSSV = "ssv"
1176+ toJSON CollectionTSV = "tsv"
1177+ toJSON CollectionPipes = "pipes"
1178+ toJSON CollectionMulti = "multi"
871−instance ToJSON SwaggerReference where
1180+instance ToJSON (ParamSchema k) where
872− toJSON (SwaggerReference ref) = object [ "$ref" .= ref ]
1181+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1182+ toJSON = sopSwaggerGenericToJSONWithOpts $
1183+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
874−instance ToJSON a => ToJSON (SwaggerReferenced a) where
1185+instance ToJSON AdditionalProperties where
875− toJSON (SwaggerRef ref) = toJSON ref
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
876− toJSON (SwaggerInline x) = toJSON x
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
878-- =======================================================================
1189-- =======================================================================
879-- Manual FromJSON instances
1190-- Manual FromJSON instances
880-- =======================================================================
1191-- =======================================================================
882−instance FromJSON SwaggerOAuth2Flow where
1193+instance FromJSON OAuth2Flow where
883 parseJSON (Object o) = do
1194 parseJSON (Object o) = do
884 (flow :: Text) <- o .: "flow"
1195 (flow :: Text) <- o .: "flow"
885 case flow of
1196 case flow of
886− "implicit" -> SwaggerOAuth2Implicit <$> o .: "authorizationUrl"
1197+ "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
887− "password" -> SwaggerOAuth2Password <$> o .: "tokenUrl"
1198+ "password" -> OAuth2Password <$> o .: "tokenUrl"
888− "application" -> SwaggerOAuth2Application <$> o .: "tokenUrl"
1199+ "application" -> OAuth2Application <$> o .: "tokenUrl"
889− "accessCode" -> SwaggerOAuth2AccessCode
1200+ "accessCode" -> OAuth2AccessCode
890 <$> o .: "authorizationUrl"
1201 <$> o .: "authorizationUrl"
891 <*> o .: "tokenUrl"
1202 <*> o .: "tokenUrl"
892 _ -> empty
1203 _ -> empty
893 parseJSON _ = empty
1204 parseJSON _ = empty
895−instance FromJSON SwaggerOAuth2Params where
1206+instance FromJSON OAuth2Params where
896− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "swaggerOAuth2")
1207+ parseJSON = sopSwaggerGenericParseJSON
898−instance FromJSON SwaggerSecuritySchemeType where
1209+instance FromJSON SecuritySchemeType where
899− parseJSON json@(Object o) = do
1210+ parseJSON js@(Object o) = do
900 (t :: Text) <- o .: "type"
1211 (t :: Text) <- o .: "type"
901 case t of
1212 case t of
902− "basic" -> pure SwaggerSecuritySchemeBasic
1213+ "basic" -> pure SecuritySchemeBasic
903− "apiKey" -> SwaggerSecuritySchemeApiKey <$> parseJSON json
1214+ "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
904− "oauth2" -> SwaggerSecuritySchemeOAuth2 <$> parseJSON json
1215+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
905 _ -> empty
1216 _ -> empty
906 parseJSON _ = empty
1217 parseJSON _ = empty
908instance FromJSON Swagger where
1219instance FromJSON Swagger where
909− parseJSON json@(Object o) = do
1220+ parseJSON = sopSwaggerGenericParseJSON
910− (version :: Text) <- o .: "swagger"
1221+
911− when (version /= "2.0") empty
1222+instance FromJSON SecurityScheme where
912− (genericParseJSON (jsonPrefix "swagger")
1223+ parseJSON = sopSwaggerGenericParseJSON
913− `withDefaults` [ "consumes" .= (mempty :: SwaggerMimeList)
1224+
914− , "produces" .= (mempty :: SwaggerMimeList)
1225+instance FromJSON Schema where
915− , "security" .= ([] :: [SwaggerSecurityRequirement])
1226+ parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
916− , "tags" .= ([] :: [SwaggerTag])
1227+ where nullaryCleanup :: Schema -> Schema
917− , "definitions" .= (mempty :: HashMap Text SwaggerSchema)
1228+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
918− , "parameters" .= (mempty :: HashMap Text SwaggerParameter)
1229+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
919− , "responses" .= (mempty :: HashMap Text SwaggerResponse)
1230+ then s { _schemaExample = Nothing
920− , "securityDefinitions" .= (mempty :: HashMap Text SwaggerSecurityScheme)
1231+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
921− ] ) json
1232+ else s
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
922 parseJSON _ = empty
1263 parseJSON _ = empty
924−instance FromJSON SwaggerSecurityScheme where
1265+instance FromJSON Host where
925− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "swaggerSecurityScheme")
1266+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
926−
1267+ [host] -> return $ Host host Nothing
927−instance FromJSON SwaggerSchema where
1268+ [host, port] -> case readMaybe port of
928− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerSchema")
1269+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
929− `withDefaults` [ "properties" .= (mempty :: HashMap Text SwaggerSchema)
1270+ Just p -> return $ Host host (Just (fromInteger p))
930− , "required" .= ([] :: [SwaggerParamName]) ]
1271+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
932−instance FromJSON SwaggerHeader where
933− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerHeader")
935−instance FromJSON SwaggerItems where
936− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerItems")
938−instance FromJSON SwaggerHost where
939− parseJSON (String s) =
940− case fromInteger <$> readMaybe portStr of
941− Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
942− mport -> pure $ SwaggerHost host mport
944− (hostText, portText) = Text.breakOn ":" s
945− [host, portStr] = map Text.unpack [hostText, portText]
946 parseJSON _ = empty
1272 parseJSON _ = empty
948−instance FromJSON SwaggerPaths where
1274+instance FromJSON MimeList where
949− parseJSON json = SwaggerPaths <$> parseJSON json
1275+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
951−instance FromJSON SwaggerMimeList where
952− parseJSON json = (SwaggerMimeList . map fromString) <$> parseJSON json
954−instance FromJSON SwaggerParameter where
1277+instance FromJSON Param where
955− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "swaggerParameter")
1278+ parseJSON = sopSwaggerGenericParseJSON
957−instance FromJSON SwaggerParameterSchema where
1280+instance FromJSON ParamAnySchema where
958− parseJSON json@(Object o) = do
1281+ parseJSON js@(Object o) = do
959 (i :: Text) <- o .: "in"
1282 (i :: Text) <- o .: "in"
960 case i of
1283 case i of
961 "body" -> do
1284 "body" -> do
962 schema <- o .: "schema"
1285 schema <- o .: "schema"
963− SwaggerParameterBody <$> parseJSON schema
1286+ ParamBody <$> parseJSON schema
964− _ -> SwaggerParameterOther <$> parseJSON json
1287+ _ -> ParamOther <$> parseJSON js
965 parseJSON _ = empty
1288 parseJSON _ = empty
967−instance FromJSON SwaggerParameterOtherSchema where
1290+instance FromJSON ParamOtherSchema where
968− parseJSON = genericParseJSONWithSub "common" (jsonPrefix "swaggerParameterOtherSchema")
1291+ parseJSON = sopSwaggerGenericParseJSON
970−instance FromJSON SwaggerSchemaItems where
1293+instance FromJSON Responses where
971− parseJSON json@(Object _) = SwaggerSchemaItemsObject <$> parseJSON json
1294+ parseJSON (Object o) = Responses
972− parseJSON json@(Array _) = SwaggerSchemaItemsArray <$> parseJSON json
975−instance FromJSON SwaggerResponses where
976− parseJSON (Object o) = SwaggerResponses
977 <$> o .:? "default"
1295 <$> o .:? "default"
978− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
979 parseJSON _ = empty
1297 parseJSON _ = empty
981−instance FromJSON SwaggerExample where
1299+instance FromJSON Example where
982− parseJSON json = do
1300+ parseJSON js = do
983− m <- parseJSON json
1301+ m <- parseJSON js
984− pure $ SwaggerExample (Map.mapKeys fromString m)
1302+ pure $ Example (Map.mapKeys fromString m)
986−instance FromJSON SwaggerResponse where
1304+instance FromJSON Response where
987− parseJSON = genericParseJSON (jsonPrefix "swaggerResponse")
1305+ parseJSON = sopSwaggerGenericParseJSON
988− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName SwaggerHeader) ]
990−instance FromJSON SwaggerOperation where
1307+instance FromJSON Operation where
991− parseJSON = genericParseJSON (jsonPrefix "swaggerOperation")
1308+ parseJSON = sopSwaggerGenericParseJSON
992− `withDefaults` [ "security" .= ([] :: [SwaggerSecurityRequirement]) ]
994−instance FromJSON SwaggerPathItem where
1310+instance FromJSON PathItem where
995− parseJSON = genericParseJSON (jsonPrefix "swaggerPathItem")
1311+ parseJSON = sopSwaggerGenericParseJSON
996− `withDefaults` [ "parameters" .= ([] :: [SwaggerParameter]) ]
998−instance FromJSON SwaggerReference where
1313+instance FromJSON SecurityDefinitions where
999− parseJSON (Object o) = SwaggerReference <$> o .: "$ref"
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
1000− parseJSON _ = empty
1002−instance FromJSON a => FromJSON (SwaggerReferenced a) where
1316+instance FromJSON Reference where
1003− parseJSON json
1317+ parseJSON (Object o) = Reference <$> o .: "$ref"
1004− = SwaggerRef <$> parseJSON json
1318+ parseJSON _ = empty
1005− <|> SwaggerInline <$> parseJSON json
1007−instance FromJSON SwaggerXml where
1008− parseJSON = genericParseJSON (jsonPrefix "swaggerXml")
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