@@ -0,0 +1,1427 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
5+{-# LANGUAGE DeriveGeneric #-}
6+{-# LANGUAGE DeriveTraversable #-}
7+{-# LANGUAGE FlexibleContexts #-}
8+{-# LANGUAGE FlexibleInstances #-}
9+{-# LANGUAGE GADTs #-}
10+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11+{-# LANGUAGE OverloadedStrings #-}
12+{-# LANGUAGE RecordWildCards #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
20+#endif
21+#include "overlapping-compat.h"
22+module Data.Swagger.Internal where
23+
24+import Prelude ()
25+import Prelude.Compat
26+
27+import Control.Lens ((&), (.~), (?~))
28+import Control.Applicative
29+import Data.Aeson
30+import qualified Data.Aeson.Types as JSON
31+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
32+import Data.Hashable (Hashable)
33+import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
35+import Data.Map (Map)
36+import qualified Data.Map as Map
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
39+import Data.Scientific (Scientific)
40+import Data.String (IsString(..))
41+import Data.Text (Text)
42+import qualified Data.Text as Text
43+import GHC.Generics (Generic)
44+import Network.Socket (HostName, PortNumber)
45+import Network.HTTP.Media (MediaType)
46+import Text.Read (readMaybe)
47+
48+import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50+
51+import Generics.SOP.TH (deriveGeneric)
52+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53+ ,sopSwaggerGenericToJSONWithOpts
54+ ,sopSwaggerGenericParseJSON
55+ ,HasSwaggerAesonOptions(..)
56+ ,AesonDefaultValue(..)
57+ ,mkSwaggerAesonOptions
58+ ,saoAdditionalPairs
59+ ,saoSubObject)
60+import Data.Swagger.Internal.Utils
61+
62+#if MIN_VERSION_aeson(0,10,0)
63+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64+#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
65+#else
66+#define DEFINE_TOENCODING
67+#endif
68+
69+-- $setup
70+-- >>> :seti -XDataKinds
71+-- >>> import Data.Aeson
72+
73+-- | A list of definitions that can be used in references.
74+type Definitions = InsOrdHashMap Text
75+
76+-- | This is the root document object for the API specification.
77+data Swagger = Swagger
78+ { -- | Provides metadata about the API.
79+ -- The metadata can be used by the clients if needed.
80+ _swaggerInfo :: Info
81+
82+ -- | The host (name or ip) serving the API. It MAY include a port.
83+ -- If the host is not included, the host serving the documentation is to be used (including the port).
84+ , _swaggerHost :: Maybe Host
85+
86+ -- | The base path on which the API is served, which is relative to the host.
87+ -- If it is not included, the API is served directly under the host.
88+ -- The value MUST start with a leading slash (/).
89+ , _swaggerBasePath :: Maybe FilePath
90+
91+ -- | The transfer protocol of the API.
92+ -- If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
93+ , _swaggerSchemes :: Maybe [Scheme]
94+
95+ -- | A list of MIME types the APIs can consume.
96+ -- This is global to all APIs but can be overridden on specific API calls.
97+ , _swaggerConsumes :: MimeList
98+
99+ -- | A list of MIME types the APIs can produce.
100+ -- This is global to all APIs but can be overridden on specific API calls.
101+ , _swaggerProduces :: MimeList
102+
103+ -- | The available paths and operations for the API.
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
107+
108+ -- | An object to hold data types produced and consumed by operations.
109+ , _swaggerDefinitions :: Definitions Schema
110+
111+ -- | An object to hold parameters that can be used across operations.
112+ -- This property does not define global parameters for all operations.
113+ , _swaggerParameters :: Definitions Param
114+
115+ -- | An object to hold responses that can be used across operations.
116+ -- This property does not define global responses for all operations.
117+ , _swaggerResponses :: Definitions Response
118+
119+ -- | Security scheme definitions that can be used across the specification.
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
121+
122+ -- | A declaration of which security schemes are applied for the API as a whole.
123+ -- The list of values describes alternative security schemes that can be used
124+ -- (that is, there is a logical OR between the security requirements).
125+ -- Individual operations can override this definition.
126+ , _swaggerSecurity :: [SecurityRequirement]
127+
128+ -- | A list of tags used by the specification with additional metadata.
129+ -- The order of the tags can be used to reflect on their order by the parsing tools.
130+ -- Not all tags that are used by the Operation Object must be declared.
131+ -- The tags that are not declared may be organized randomly or based on the tools' logic.
132+ -- Each tag name in the list MUST be unique.
133+ , _swaggerTags :: InsOrdHashSet Tag
134+
135+ -- | Additional external documentation.
136+ , _swaggerExternalDocs :: Maybe ExternalDocs
137+ } deriving (Eq, Show, Generic, Data, Typeable)
138+
139+-- | The object provides metadata about the API.
140+-- The metadata can be used by the clients if needed,
141+-- and can be presented in the Swagger-UI for convenience.
142+data Info = Info
143+ { -- | The title of the application.
144+ _infoTitle :: Text
145+
146+ -- | A short description of the application.
147+ -- GFM syntax can be used for rich text representation.
148+ , _infoDescription :: Maybe Text
149+
150+ -- | The Terms of Service for the API.
151+ , _infoTermsOfService :: Maybe Text
152+
153+ -- | The contact information for the exposed API.
154+ , _infoContact :: Maybe Contact
155+
156+ -- | The license information for the exposed API.
157+ , _infoLicense :: Maybe License
158+
159+ -- | Provides the version of the application API
160+ -- (not to be confused with the specification version).
161+ , _infoVersion :: Text
162+ } deriving (Eq, Show, Generic, Data, Typeable)
163+
164+-- | Contact information for the exposed API.
165+data Contact = Contact
166+ { -- | The identifying name of the contact person/organization.
167+ _contactName :: Maybe Text
168+
169+ -- | The URL pointing to the contact information.
170+ , _contactUrl :: Maybe URL
171+
172+ -- | The email address of the contact person/organization.
173+ , _contactEmail :: Maybe Text
174+ } deriving (Eq, Show, Generic, Data, Typeable)
175+
176+-- | License information for the exposed API.
177+data License = License
178+ { -- | The license name used for the API.
179+ _licenseName :: Text
180+
181+ -- | A URL to the license used for the API.
182+ , _licenseUrl :: Maybe URL
183+ } deriving (Eq, Show, Generic, Data, Typeable)
184+
185+instance IsString License where
186+ fromString s = License (fromString s) Nothing
187+
188+-- | The host (name or ip) serving the API. It MAY include a port.
189+data Host = Host
190+ { _hostName :: HostName -- ^ Host name.
191+ , _hostPort :: Maybe PortNumber -- ^ Optional port.
192+ } deriving (Eq, Show, Generic, Typeable)
193+
194+instance IsString Host where
195+ fromString s = Host s Nothing
196+
197+hostConstr :: Constr
198+hostConstr = mkConstr hostDataType "Host" [] Prefix
199+
200+hostDataType :: DataType
201+hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
202+
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
209+
210+-- | The transfer protocol of the API.
211+data Scheme
212+ = Http
213+ | Https
214+ | Ws
215+ | Wss
216+ deriving (Eq, Show, Generic, Data, Typeable)
217+
218+-- | Describes the operations available on a single path.
219+-- A @'PathItem'@ may be empty, due to ACL constraints.
220+-- The path itself is still exposed to the documentation viewer
221+-- but they will not know which operations and parameters are available.
222+data PathItem = PathItem
223+ { -- | A definition of a GET operation on this path.
224+ _pathItemGet :: Maybe Operation
225+
226+ -- | A definition of a PUT operation on this path.
227+ , _pathItemPut :: Maybe Operation
228+
229+ -- | A definition of a POST operation on this path.
230+ , _pathItemPost :: Maybe Operation
231+
232+ -- | A definition of a DELETE operation on this path.
233+ , _pathItemDelete :: Maybe Operation
234+
235+ -- | A definition of a OPTIONS operation on this path.
236+ , _pathItemOptions :: Maybe Operation
237+
238+ -- | A definition of a HEAD operation on this path.
239+ , _pathItemHead :: Maybe Operation
240+
241+ -- | A definition of a PATCH operation on this path.
242+ , _pathItemPatch :: Maybe Operation
243+
244+ -- | A list of parameters that are applicable for all the operations described under this path.
245+ -- These parameters can be overridden at the operation level, but cannot be removed there.
246+ -- The list MUST NOT include duplicated parameters.
247+ -- A unique parameter is defined by a combination of a name and location.
248+ , _pathItemParameters :: [Referenced Param]
249+ } deriving (Eq, Show, Generic, Data, Typeable)
250+
251+-- | Describes a single API operation on a path.
252+data Operation = Operation
253+ { -- | A list of tags for API documentation control.
254+ -- Tags can be used for logical grouping of operations by resources or any other qualifier.
255+ _operationTags :: InsOrdHashSet TagName
256+
257+ -- | A short summary of what the operation does.
258+ -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
259+ , _operationSummary :: Maybe Text
260+
261+ -- | A verbose explanation of the operation behavior.
262+ -- GFM syntax can be used for rich text representation.
263+ , _operationDescription :: Maybe Text
264+
265+ -- | Additional external documentation for this operation.
266+ , _operationExternalDocs :: Maybe ExternalDocs
267+
268+ -- | Unique string used to identify the operation.
269+ -- The id MUST be unique among all operations described in the API.
270+ -- Tools and libraries MAY use the it to uniquely identify an operation,
271+ -- therefore, it is recommended to follow common programming naming conventions.
272+ , _operationOperationId :: Maybe Text
273+
274+ -- | A list of MIME types the operation can consume.
275+ -- This overrides the @'consumes'@.
276+ -- @Just []@ MAY be used to clear the global definition.
277+ , _operationConsumes :: Maybe MimeList
278+
279+ -- | A list of MIME types the operation can produce.
280+ -- This overrides the @'produces'@.
281+ -- @Just []@ MAY be used to clear the global definition.
282+ , _operationProduces :: Maybe MimeList
283+
284+ -- | A list of parameters that are applicable for this operation.
285+ -- If a parameter is already defined at the @'PathItem'@,
286+ -- the new definition will override it, but can never remove it.
287+ -- The list MUST NOT include duplicated parameters.
288+ -- A unique parameter is defined by a combination of a name and location.
289+ , _operationParameters :: [Referenced Param]
290+
291+ -- | The list of possible responses as they are returned from executing this operation.
292+ , _operationResponses :: Responses
293+
294+ -- | The transfer protocol for the operation.
295+ -- The value overrides @'schemes'@.
296+ , _operationSchemes :: Maybe [Scheme]
297+
298+ -- | Declares this operation to be deprecated.
299+ -- Usage of the declared operation should be refrained.
300+ -- Default value is @False@.
301+ , _operationDeprecated :: Maybe Bool
302+
303+ -- | A declaration of which security schemes are applied for this operation.
304+ -- The list of values describes alternative security schemes that can be used
305+ -- (that is, there is a logical OR between the security requirements).
306+ -- This definition overrides any declared top-level security.
307+ -- To remove a top-level security declaration, @Just []@ can be used.
308+ , _operationSecurity :: [SecurityRequirement]
309+ } deriving (Eq, Show, Generic, Data, Typeable)
310+
311+newtype MimeList = MimeList { getMimeList :: [MediaType] }
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
313+
314+mimeListConstr :: Constr
315+mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
316+
317+mimeListDataType :: DataType
318+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
319+
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
326+
327+-- | Describes a single operation parameter.
328+-- A unique parameter is defined by a combination of a name and location.
329+data Param = Param
330+ { -- | The name of the parameter.
331+ -- Parameter names are case sensitive.
332+ _paramName :: Text
333+
334+ -- | A brief description of the parameter.
335+ -- This could contain examples of use.
336+ -- GFM syntax can be used for rich text representation.
337+ , _paramDescription :: Maybe Text
338+
339+ -- | Determines whether this parameter is mandatory.
340+ -- If the parameter is in "path", this property is required and its value MUST be true.
341+ -- Otherwise, the property MAY be included and its default value is @False@.
342+ , _paramRequired :: Maybe Bool
343+
344+ -- | Parameter schema.
345+ , _paramSchema :: ParamAnySchema
346+ } deriving (Eq, Show, Generic, Data, Typeable)
347+
348+data ParamAnySchema
349+ = ParamBody (Referenced Schema)
350+ | ParamOther ParamOtherSchema
351+ deriving (Eq, Show, Generic, Data, Typeable)
352+
353+data ParamOtherSchema = ParamOtherSchema
354+ { -- | The location of the parameter.
355+ _paramOtherSchemaIn :: ParamLocation
356+
357+ -- | Sets the ability to pass empty-valued parameters.
358+ -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
359+ -- and allows you to send a parameter with a name only or an empty value.
360+ -- Default value is @False@.
361+ , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
362+
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
364+ } deriving (Eq, Show, Generic, Typeable, Data)
365+
366+-- | Items for @'SwaggerArray'@ schemas.
367+--
368+-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
369+-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
370+-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
371+-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
372+--
373+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
374+--
375+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
376+data SwaggerItems t where
377+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
378+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
379+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
380+ deriving (Typeable)
381+
382+deriving instance Eq (SwaggerItems t)
383+deriving instance Show (SwaggerItems t)
384+--deriving instance Typeable (SwaggerItems t)
385+
386+swaggerItemsPrimitiveConstr :: Constr
387+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
388+
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391+
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394+
395+swaggerItemsDataType :: DataType
396+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
397+
398+-- Note: unfortunately we have to write these Data instances by hand,
399+-- to get better contexts / avoid duplicate name when using standalone deriving
400+
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
408+
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
417+
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
422+
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)."
427+
428+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
431+
432+ dataTypeOf _ = swaggerItemsDataType
433+
434+-- | Type used as a kind to avoid overlapping instances.
435+data SwaggerKind t
436+ = SwaggerKindNormal t
437+ | SwaggerKindParamOtherSchema
438+ | SwaggerKindSchema
439+ deriving (Typeable)
440+
441+deriving instance Typeable 'SwaggerKindNormal
442+deriving instance Typeable 'SwaggerKindParamOtherSchema
443+deriving instance Typeable 'SwaggerKindSchema
444+
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
449+
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
459+ deriving (Typeable)
460+
461+deriving instance Eq (SwaggerType t)
462+deriving instance Show (SwaggerType t)
463+
464+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
465+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
466+
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
468+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
469+
470+swaggerCommonTypes :: [SwaggerType k]
471+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
472+
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
474+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
475+
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
477+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
478+
479+swaggerTypeConstrs :: [Constr]
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
481+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
482+
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
484+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
485+ toConstr = swaggerTypeConstr
486+ dataTypeOf = swaggerTypeDataType
487+
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
489+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
490+ toConstr = swaggerTypeConstr
491+ dataTypeOf = swaggerTypeDataType
492+
493+instance Data (SwaggerType 'SwaggerKindSchema) where
494+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
495+ toConstr = swaggerTypeConstr
496+ dataTypeOf = swaggerTypeDataType
497+
498+data ParamLocation
499+ = -- | Parameters that are appended to the URL.
500+ -- For example, in @/items?id=###@, the query parameter is @id@.
501+ ParamQuery
502+ -- | Custom headers that are expected as part of the request.
503+ | ParamHeader
504+ -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
505+ -- This does not include the host or base path of the API.
506+ -- For example, in @/items/{itemId}@, the path parameter is @itemId@.
507+ | ParamPath
508+ -- | Used to describe the payload of an HTTP request when either @application/x-www-form-urlencoded@
509+ -- or @multipart/form-data@ are used as the content type of the request
510+ -- (in Swagger's definition, the @consumes@ property of an operation).
511+ -- This is the only parameter type that can be used to send files, thus supporting the @'ParamFile'@ type.
512+ -- Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation.
513+ -- Form parameters have a different format based on the content-type used
514+ -- (for further details, consult <http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4>).
515+ | ParamFormData
516+ deriving (Eq, Show, Generic, Data, Typeable)
517+
518+type Format = Text
519+
520+-- | Determines the format of the array.
521+data CollectionFormat t where
522+ -- Comma separated values: @foo,bar@.
523+ CollectionCSV :: CollectionFormat t
524+ -- Space separated values: @foo bar@.
525+ CollectionSSV :: CollectionFormat t
526+ -- Tab separated values: @foo\\tbar@.
527+ CollectionTSV :: CollectionFormat t
528+ -- Pipe separated values: @foo|bar@.
529+ CollectionPipes :: CollectionFormat t
530+ -- Corresponds to multiple parameter instances
531+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
532+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534+ deriving (Typeable)
535+
536+deriving instance Eq (CollectionFormat t)
537+deriving instance Show (CollectionFormat t)
538+
539+collectionFormatConstr :: CollectionFormat t -> Constr
540+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
541+
542+collectionFormatDataType :: DataType
543+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
544+ map collectionFormatConstr collectionCommonFormats
545+
546+collectionCommonFormats :: [CollectionFormat t]
547+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
548+
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
550+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
551+ toConstr = collectionFormatConstr
552+ dataTypeOf _ = collectionFormatDataType
553+
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
555+
556+type ParamName = Text
557+
558+data Schema = Schema
559+ { _schemaTitle :: Maybe Text
560+ , _schemaDescription :: Maybe Text
561+ , _schemaRequired :: [ParamName]
562+
563+ , _schemaAllOf :: Maybe [Referenced Schema]
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
566+
567+ , _schemaDiscriminator :: Maybe Text
568+ , _schemaReadOnly :: Maybe Bool
569+ , _schemaXml :: Maybe Xml
570+ , _schemaExternalDocs :: Maybe ExternalDocs
571+ , _schemaExample :: Maybe Value
572+
573+ , _schemaMaxProperties :: Maybe Integer
574+ , _schemaMinProperties :: Maybe Integer
575+
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
577+ } deriving (Eq, Show, Generic, Data, Typeable)
578+
579+-- | A @'Schema'@ with an optional name.
580+-- This name can be used in references.
581+data NamedSchema = NamedSchema
582+ { _namedSchemaName :: Maybe Text
583+ , _namedSchemaSchema :: Schema
584+ } deriving (Eq, Show, Generic, Data, Typeable)
585+
586+-- | Regex pattern for @string@ type.
587+type Pattern = Text
588+
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
590+ { -- | Declares the value of the parameter that the server will use if none is provided,
591+ -- for example a @"count"@ to control the number of results per page might default to @100@
592+ -- if not supplied by the client in the request.
593+ -- (Note: "default" has no meaning for required parameters.)
594+ -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
595+ _paramSchemaDefault :: Maybe Value
596+
597+ , _paramSchemaType :: Maybe (SwaggerType t)
598+ , _paramSchemaFormat :: Maybe Format
599+ , _paramSchemaItems :: Maybe (SwaggerItems t)
600+ , _paramSchemaMaximum :: Maybe Scientific
601+ , _paramSchemaExclusiveMaximum :: Maybe Bool
602+ , _paramSchemaMinimum :: Maybe Scientific
603+ , _paramSchemaExclusiveMinimum :: Maybe Bool
604+ , _paramSchemaMaxLength :: Maybe Integer
605+ , _paramSchemaMinLength :: Maybe Integer
606+ , _paramSchemaPattern :: Maybe Pattern
607+ , _paramSchemaMaxItems :: Maybe Integer
608+ , _paramSchemaMinItems :: Maybe Integer
609+ , _paramSchemaUniqueItems :: Maybe Bool
610+ , _paramSchemaEnum :: Maybe [Value]
611+ , _paramSchemaMultipleOf :: Maybe Scientific
612+ } deriving (Eq, Show, Generic, Typeable)
613+
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
615+
616+data Xml = Xml
617+ { -- | Replaces the name of the element/attribute used for the described schema property.
618+ -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
619+ -- When defined alongside type being array (outside the items),
620+ -- it will affect the wrapping element and only if wrapped is true.
621+ -- If wrapped is false, it will be ignored.
622+ _xmlName :: Maybe Text
623+
624+ -- | The URL of the namespace definition.
625+ -- Value SHOULD be in the form of a URL.
626+ , _xmlNamespace :: Maybe Text
627+
628+ -- | The prefix to be used for the name.
629+ , _xmlPrefix :: Maybe Text
630+
631+ -- | Declares whether the property definition translates to an attribute instead of an element.
632+ -- Default value is @False@.
633+ , _xmlAttribute :: Maybe Bool
634+
635+ -- | MAY be used only for an array definition.
636+ -- Signifies whether the array is wrapped
637+ -- (for example, @\<books\>\<book/\>\<book/\>\</books\>@)
638+ -- or unwrapped (@\<book/\>\<book/\>@).
639+ -- Default value is @False@.
640+ -- The definition takes effect only when defined alongside type being array (outside the items).
641+ , _xmlWrapped :: Maybe Bool
642+ } deriving (Eq, Show, Generic, Data, Typeable)
643+
644+-- | A container for the expected responses of an operation.
645+-- The container maps a HTTP response code to the expected response.
646+-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
647+-- since they may not be known in advance.
648+-- However, it is expected from the documentation to cover a successful operation response and any known errors.
649+data Responses = Responses
650+ { -- | The documentation of responses other than the ones declared for specific HTTP response codes.
651+ -- It can be used to cover undeclared responses.
652+ _responsesDefault :: Maybe (Referenced Response)
653+
654+ -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
655+ -- Describes the expected response for those HTTP status codes.
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
657+ } deriving (Eq, Show, Generic, Data, Typeable)
658+
659+type HttpStatusCode = Int
660+
661+-- | Describes a single response from an API Operation.
662+data Response = Response
663+ { -- | A short description of the response.
664+ -- GFM syntax can be used for rich text representation.
665+ _responseDescription :: Text
666+
667+ -- | A definition of the response structure.
668+ -- It can be a primitive, an array or an object.
669+ -- If this field does not exist, it means no content is returned as part of the response.
670+ -- As an extension to the Schema Object, its root type value may also be "file".
671+ -- This SHOULD be accompanied by a relevant produces mime-type.
672+ , _responseSchema :: Maybe (Referenced Schema)
673+
674+ -- | A list of headers that are sent with the response.
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
676+
677+ -- | An example of the response message.
678+ , _responseExamples :: Maybe Example
679+ } deriving (Eq, Show, Generic, Data, Typeable)
680+
681+instance IsString Response where
682+ fromString s = Response (fromString s) Nothing mempty Nothing
683+
684+type HeaderName = Text
685+
686+data Header = Header
687+ { -- | A short description of the header.
688+ _headerDescription :: Maybe Text
689+
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
691+ } deriving (Eq, Show, Generic, Data, Typeable)
692+
693+data Example = Example { getExample :: Map MediaType Value }
694+ deriving (Eq, Show, Generic, Typeable)
695+
696+exampleConstr :: Constr
697+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
698+
699+exampleDataType :: DataType
700+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
701+
702+instance Data Example where
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
708+
709+-- | The location of the API key.
710+data ApiKeyLocation
711+ = ApiKeyQuery
712+ | ApiKeyHeader
713+ deriving (Eq, Show, Generic, Data, Typeable)
714+
715+data ApiKeyParams = ApiKeyParams
716+ { -- | The name of the header or query parameter to be used.
717+ _apiKeyName :: Text
718+
719+ -- | The location of the API key.
720+ , _apiKeyIn :: ApiKeyLocation
721+ } deriving (Eq, Show, Generic, Data, Typeable)
722+
723+-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
724+type AuthorizationURL = Text
725+
726+-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
727+type TokenURL = Text
728+
729+data OAuth2Flow
730+ = OAuth2Implicit AuthorizationURL
731+ | OAuth2Password TokenURL
732+ | OAuth2Application TokenURL
733+ | OAuth2AccessCode AuthorizationURL TokenURL
734+ deriving (Eq, Show, Generic, Data, Typeable)
735+
736+data OAuth2Params = OAuth2Params
737+ { -- | The flow used by the OAuth2 security scheme.
738+ _oauth2Flow :: OAuth2Flow
739+
740+ -- | The available scopes for the OAuth2 security scheme.
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
742+ } deriving (Eq, Show, Generic, Data, Typeable)
743+
744+data SecuritySchemeType
745+ = SecuritySchemeBasic
746+ | SecuritySchemeApiKey ApiKeyParams
747+ | SecuritySchemeOAuth2 OAuth2Params
748+ deriving (Eq, Show, Generic, Data, Typeable)
749+
750+data SecurityScheme = SecurityScheme
751+ { -- | The type of the security scheme.
752+ _securitySchemeType :: SecuritySchemeType
753+
754+ -- | A short description for security scheme.
755+ , _securitySchemeDescription :: Maybe Text
756+ } deriving (Eq, Show, Generic, Data, Typeable)
757+
758+
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
766+ else
767+ s1
768+mergeSecurityScheme s1 _ = s1
769+
770+newtype SecurityDefinitions
771+ = SecurityDefinitions (Definitions SecurityScheme)
772+ deriving (Eq, Show, Generic, Data, Typeable)
773+
774+-- | Lists the required security schemes to execute this operation.
775+-- The object can have multiple security schemes declared in it which are all required
776+-- (that is, there is a logical AND between the schemes).
777+newtype SecurityRequirement = SecurityRequirement
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
780+
781+-- | Tag name.
782+type TagName = Text
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.
786+data Tag = Tag
787+ { -- | The name of the tag.
788+ _tagName :: TagName
789+
790+ -- | A short description for the tag.
791+ -- GFM syntax can be used for rich text representation.
792+ , _tagDescription :: Maybe Text
793+
794+ -- | Additional external documentation for this tag.
795+ , _tagExternalDocs :: Maybe ExternalDocs
796+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
797+
798+instance Hashable Tag
799+
800+instance IsString Tag where
801+ fromString s = Tag (fromString s) Nothing Nothing
802+
803+-- | Allows referencing an external resource for extended documentation.
804+data ExternalDocs = ExternalDocs
805+ { -- | A short description of the target documentation.
806+ -- GFM syntax can be used for rich text representation.
807+ _externalDocsDescription :: Maybe Text
808+
809+ -- | The URL for the target documentation.
810+ , _externalDocsUrl :: URL
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812+
813+instance Hashable ExternalDocs
814+
815+-- | A simple object to allow referencing other definitions in the specification.
816+-- It can be used to reference parameters and responses that are defined at the top level for reuse.
817+newtype Reference = Reference { getReference :: Text }
818+ deriving (Eq, Show, Data, Typeable)
819+
820+data Referenced a
821+ = Ref Reference
822+ | Inline a
823+ deriving (Eq, Show, Functor, Data, Typeable)
824+
825+instance IsString a => IsString (Referenced a) where
826+ fromString = Inline . fromString
827+
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
829+
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
834+
835+-- =======================================================================
836+-- Monoid instances
837+-- =======================================================================
838+
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
841+instance Monoid Swagger where
842+ mempty = genericMempty
843+ mappend = (<>)
844+
845+instance Semigroup Info where
846+ (<>) = genericMappend
847+instance Monoid Info where
848+ mempty = genericMempty
849+ mappend = (<>)
850+
851+instance Semigroup Contact where
852+ (<>) = genericMappend
853+instance Monoid Contact where
854+ mempty = genericMempty
855+ mappend = (<>)
856+
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
859+instance Monoid PathItem where
860+ mempty = genericMempty
861+ mappend = (<>)
862+
863+instance Semigroup Schema where
864+ (<>) = genericMappend
865+instance Monoid Schema where
866+ mempty = genericMempty
867+ mappend = (<>)
868+
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
871+instance Monoid (ParamSchema t) where
872+ mempty = genericMempty
873+ mappend = (<>)
874+
875+instance Semigroup Param where
876+ (<>) = genericMappend
877+instance Monoid Param where
878+ mempty = genericMempty
879+ mappend = (<>)
880+
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
883+instance Monoid ParamOtherSchema where
884+ mempty = genericMempty
885+ mappend = (<>)
886+
887+instance Semigroup Header where
888+ (<>) = genericMappend
889+instance Monoid Header where
890+ mempty = genericMempty
891+ mappend = (<>)
892+
893+instance Semigroup Responses where
894+ (<>) = genericMappend
895+instance Monoid Responses where
896+ mempty = genericMempty
897+ mappend = (<>)
898+
899+instance Semigroup Response where
900+ (<>) = genericMappend
901+instance Monoid Response where
902+ mempty = genericMempty
903+ mappend = (<>)
904+
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
907+instance Monoid ExternalDocs where
908+ mempty = genericMempty
909+ mappend = (<>)
910+
911+instance Semigroup Operation where
912+ (<>) = genericMappend
913+instance Monoid Operation where
914+ mempty = genericMempty
915+ mappend = (<>)
916+
917+instance Semigroup Example where
918+ (<>) = genericMappend
919+instance Monoid Example where
920+ mempty = genericMempty
921+ mappend = (<>)
922+
923+instance Semigroup SecurityScheme where
924+ (<>) = mergeSecurityScheme
925+
926+instance Semigroup SecurityDefinitions where
927+ (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928+ SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
929+
930+instance Monoid SecurityDefinitions where
931+ mempty = SecurityDefinitions $ InsOrdHashMap.empty
932+ mappend = (<>)
933+
934+-- =======================================================================
935+-- SwaggerMonoid helper instances
936+-- =======================================================================
937+
938+instance SwaggerMonoid Info
939+instance SwaggerMonoid PathItem
940+instance SwaggerMonoid Schema
941+instance SwaggerMonoid (ParamSchema t)
942+instance SwaggerMonoid Param
943+instance SwaggerMonoid ParamOtherSchema
944+instance SwaggerMonoid Responses
945+instance SwaggerMonoid Response
946+instance SwaggerMonoid ExternalDocs
947+instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
950+
951+instance SwaggerMonoid MimeList
952+deriving instance SwaggerMonoid URL
953+
954+instance SwaggerMonoid (SwaggerType t) where
955+ swaggerMempty = SwaggerString
956+ swaggerMappend _ y = y
957+
958+instance SwaggerMonoid ParamLocation where
959+ swaggerMempty = ParamQuery
960+ swaggerMappend _ y = y
961+
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
963+ swaggerMempty = InsOrdHashMap.empty
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
965+
966+instance Monoid a => SwaggerMonoid (Referenced a) where
967+ swaggerMempty = Inline mempty
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
969+ swaggerMappend _ y = y
970+
971+instance SwaggerMonoid ParamAnySchema where
972+ swaggerMempty = ParamOther swaggerMempty
973+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
974+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
975+ swaggerMappend _ y = y
976+
977+-- =======================================================================
978+-- Simple Generic-based ToJSON instances
979+-- =======================================================================
980+
981+instance ToJSON ParamLocation where
982+ toJSON = genericToJSON (jsonPrefix "Param")
983+
984+instance ToJSON Info where
985+ toJSON = genericToJSON (jsonPrefix "Info")
986+
987+instance ToJSON Contact where
988+ toJSON = genericToJSON (jsonPrefix "Contact")
989+
990+instance ToJSON License where
991+ toJSON = genericToJSON (jsonPrefix "License")
992+
993+instance ToJSON ApiKeyLocation where
994+ toJSON = genericToJSON (jsonPrefix "ApiKey")
995+
996+instance ToJSON ApiKeyParams where
997+ toJSON = genericToJSON (jsonPrefix "apiKey")
998+
999+instance ToJSON Scheme where
1000+ toJSON = genericToJSON (jsonPrefix "")
1001+
1002+instance ToJSON Tag where
1003+ toJSON = genericToJSON (jsonPrefix "Tag")
1004+
1005+instance ToJSON ExternalDocs where
1006+ toJSON = genericToJSON (jsonPrefix "ExternalDocs")
1007+
1008+instance ToJSON Xml where
1009+ toJSON = genericToJSON (jsonPrefix "Xml")
1010+
1011+-- =======================================================================
1012+-- Simple Generic-based FromJSON instances
1013+-- =======================================================================
1014+
1015+instance FromJSON ParamLocation where
1016+ parseJSON = genericParseJSON (jsonPrefix "Param")
1017+
1018+instance FromJSON Info where
1019+ parseJSON = genericParseJSON (jsonPrefix "Info")
1020+
1021+instance FromJSON Contact where
1022+ parseJSON = genericParseJSON (jsonPrefix "Contact")
1023+
1024+instance FromJSON License where
1025+ parseJSON = genericParseJSON (jsonPrefix "License")
1026+
1027+instance FromJSON ApiKeyLocation where
1028+ parseJSON = genericParseJSON (jsonPrefix "ApiKey")
1029+
1030+instance FromJSON ApiKeyParams where
1031+ parseJSON = genericParseJSON (jsonPrefix "apiKey")
1032+
1033+instance FromJSON Scheme where
1034+ parseJSON = genericParseJSON (jsonPrefix "")
1035+
1036+instance FromJSON Tag where
1037+ parseJSON = genericParseJSON (jsonPrefix "Tag")
1038+
1039+instance FromJSON ExternalDocs where
1040+ parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
1041+
1042+-- =======================================================================
1043+-- Manual ToJSON instances
1044+-- =======================================================================
1045+
1046+instance ToJSON OAuth2Flow where
1047+ toJSON (OAuth2Implicit authUrl) = object
1048+ [ "flow" .= ("implicit" :: Text)
1049+ , "authorizationUrl" .= authUrl ]
1050+ toJSON (OAuth2Password tokenUrl) = object
1051+ [ "flow" .= ("password" :: Text)
1052+ , "tokenUrl" .= tokenUrl ]
1053+ toJSON (OAuth2Application tokenUrl) = object
1054+ [ "flow" .= ("application" :: Text)
1055+ , "tokenUrl" .= tokenUrl ]
1056+ toJSON (OAuth2AccessCode authUrl tokenUrl) = object
1057+ [ "flow" .= ("accessCode" :: Text)
1058+ , "authorizationUrl" .= authUrl
1059+ , "tokenUrl" .= tokenUrl ]
1060+
1061+instance ToJSON OAuth2Params where
1062+ toJSON = sopSwaggerGenericToJSON
1063+ DEFINE_TOENCODING
1064+
1065+instance ToJSON SecuritySchemeType where
1066+ toJSON SecuritySchemeBasic
1067+ = object [ "type" .= ("basic" :: Text) ]
1068+ toJSON (SecuritySchemeApiKey params)
1069+ = toJSON params
1070+ <+> object [ "type" .= ("apiKey" :: Text) ]
1071+ toJSON (SecuritySchemeOAuth2 params)
1072+ = toJSON params
1073+ <+> object [ "type" .= ("oauth2" :: Text) ]
1074+
1075+instance ToJSON Swagger where
1076+ toJSON = sopSwaggerGenericToJSON
1077+ DEFINE_TOENCODING
1078+
1079+instance ToJSON SecurityScheme where
1080+ toJSON = sopSwaggerGenericToJSON
1081+ DEFINE_TOENCODING
1082+
1083+instance ToJSON Schema where
1084+ toJSON = sopSwaggerGenericToJSON
1085+ DEFINE_TOENCODING
1086+
1087+instance ToJSON Header where
1088+ toJSON = sopSwaggerGenericToJSON
1089+ DEFINE_TOENCODING
1090+
1091+-- | As for nullary schema for 0-arity type constructors, see
1092+-- <https://github.com/GetShopTV/swagger2/issues/167>.
1093+--
1094+-- >>> encode (SwaggerItemsArray [])
1095+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1096+--
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
1106+ ]
1107+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1108+
1109+instance ToJSON Host where
1110+ toJSON (Host host mport) = toJSON $
1111+ case mport of
1112+ Nothing -> host
1113+ Just port -> host ++ ":" ++ show port
1114+
1115+instance ToJSON MimeList where
1116+ toJSON (MimeList xs) = toJSON (map show xs)
1117+
1118+instance ToJSON Param where
1119+ toJSON = sopSwaggerGenericToJSON
1120+ DEFINE_TOENCODING
1121+
1122+instance ToJSON ParamAnySchema where
1123+ toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1124+ toJSON (ParamOther s) = toJSON s
1125+
1126+instance ToJSON ParamOtherSchema where
1127+ toJSON = sopSwaggerGenericToJSON
1128+ DEFINE_TOENCODING
1129+
1130+instance ToJSON Responses where
1131+ toJSON = sopSwaggerGenericToJSON
1132+ DEFINE_TOENCODING
1133+
1134+instance ToJSON Response where
1135+ toJSON = sopSwaggerGenericToJSON
1136+ DEFINE_TOENCODING
1137+
1138+instance ToJSON Operation where
1139+ toJSON = sopSwaggerGenericToJSON
1140+ DEFINE_TOENCODING
1141+
1142+instance ToJSON PathItem where
1143+ toJSON = sopSwaggerGenericToJSON
1144+ DEFINE_TOENCODING
1145+
1146+instance ToJSON Example where
1147+ toJSON = toJSON . Map.mapKeys show . getExample
1148+
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
1151+
1152+instance ToJSON Reference where
1153+ toJSON (Reference ref) = object [ "$ref" .= ref ]
1154+
1155+referencedToJSON :: ToJSON a => Text -> Referenced a -> Value
1156+referencedToJSON prefix (Ref (Reference ref)) = object [ "$ref" .= (prefix <> ref) ]
1157+referencedToJSON _ (Inline x) = toJSON x
1158+
1159+instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/definitions/"
1160+instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/parameters/"
1161+instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/responses/"
1162+
1163+instance ToJSON (SwaggerType t) where
1164+ toJSON SwaggerArray = "array"
1165+ toJSON SwaggerString = "string"
1166+ toJSON SwaggerInteger = "integer"
1167+ toJSON SwaggerNumber = "number"
1168+ toJSON SwaggerBoolean = "boolean"
1169+ toJSON SwaggerFile = "file"
1170+ toJSON SwaggerNull = "null"
1171+ toJSON SwaggerObject = "object"
1172+
1173+instance ToJSON (CollectionFormat t) where
1174+ toJSON CollectionCSV = "csv"
1175+ toJSON CollectionSSV = "ssv"
1176+ toJSON CollectionTSV = "tsv"
1177+ toJSON CollectionPipes = "pipes"
1178+ toJSON CollectionMulti = "multi"
1179+
1180+instance ToJSON (ParamSchema k) where
1181+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1182+ toJSON = sopSwaggerGenericToJSONWithOpts $
1183+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1184+
1185+instance ToJSON AdditionalProperties where
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
1188+
1189+-- =======================================================================
1190+-- Manual FromJSON instances
1191+-- =======================================================================
1192+
1193+instance FromJSON OAuth2Flow where
1194+ parseJSON (Object o) = do
1195+ (flow :: Text) <- o .: "flow"
1196+ case flow of
1197+ "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
1198+ "password" -> OAuth2Password <$> o .: "tokenUrl"
1199+ "application" -> OAuth2Application <$> o .: "tokenUrl"
1200+ "accessCode" -> OAuth2AccessCode
1201+ <$> o .: "authorizationUrl"
1202+ <*> o .: "tokenUrl"
1203+ _ -> empty
1204+ parseJSON _ = empty
1205+
1206+instance FromJSON OAuth2Params where
1207+ parseJSON = sopSwaggerGenericParseJSON
1208+
1209+instance FromJSON SecuritySchemeType where
1210+ parseJSON js@(Object o) = do
1211+ (t :: Text) <- o .: "type"
1212+ case t of
1213+ "basic" -> pure SecuritySchemeBasic
1214+ "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1215+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
1216+ _ -> empty
1217+ parseJSON _ = empty
1218+
1219+instance FromJSON Swagger where
1220+ parseJSON = sopSwaggerGenericParseJSON
1221+
1222+instance FromJSON SecurityScheme where
1223+ parseJSON = sopSwaggerGenericParseJSON
1224+
1225+instance FromJSON Schema where
1226+ parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1227+ where nullaryCleanup :: Schema -> Schema
1228+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230+ then s { _schemaExample = Nothing
1231+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1232+ else s
1233+
1234+instance FromJSON Header where
1235+ parseJSON = sopSwaggerGenericParseJSON
1236+
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)
1241+
1242+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1243+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244+ <$> o .:? "collectionFormat"
1245+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1246+
1247+-- |
1248+--
1249+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250+-- Just (SwaggerItemsArray [])
1251+--
1252+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1254+--
1255+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1257+--
1258+instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1259+ parseJSON js@(Object obj)
1260+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1261+ | otherwise = SwaggerItemsObject <$> parseJSON js
1262+ parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1263+ parseJSON _ = empty
1264+
1265+instance FromJSON Host where
1266+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1267+ [host] -> return $ Host host Nothing
1268+ [host, port] -> case readMaybe port of
1269+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1270+ Just p -> return $ Host host (Just (fromInteger p))
1271+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1272+ parseJSON _ = empty
1273+
1274+instance FromJSON MimeList where
1275+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
1276+
1277+instance FromJSON Param where
1278+ parseJSON = sopSwaggerGenericParseJSON
1279+
1280+instance FromJSON ParamAnySchema where
1281+ parseJSON js@(Object o) = do
1282+ (i :: Text) <- o .: "in"
1283+ case i of
1284+ "body" -> do
1285+ schema <- o .: "schema"
1286+ ParamBody <$> parseJSON schema
1287+ _ -> ParamOther <$> parseJSON js
1288+ parseJSON _ = empty
1289+
1290+instance FromJSON ParamOtherSchema where
1291+ parseJSON = sopSwaggerGenericParseJSON
1292+
1293+instance FromJSON Responses where
1294+ parseJSON (Object o) = Responses
1295+ <$> o .:? "default"
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
1297+ parseJSON _ = empty
1298+
1299+instance FromJSON Example where
1300+ parseJSON js = do
1301+ m <- parseJSON js
1302+ pure $ Example (Map.mapKeys fromString m)
1303+
1304+instance FromJSON Response where
1305+ parseJSON = sopSwaggerGenericParseJSON
1306+
1307+instance FromJSON Operation where
1308+ parseJSON = sopSwaggerGenericParseJSON
1309+
1310+instance FromJSON PathItem where
1311+ parseJSON = sopSwaggerGenericParseJSON
1312+
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
1315+
1316+instance FromJSON Reference where
1317+ parseJSON (Object o) = Reference <$> o .: "$ref"
1318+ parseJSON _ = empty
1319+
1320+referencedParseJSON :: FromJSON a => Text -> Value -> JSON.Parser (Referenced a)
1321+referencedParseJSON prefix js@(Object o) = do
1322+ ms <- o .:? "$ref"
1323+ case ms of
1324+ Nothing -> Inline <$> parseJSON js
1325+ Just s -> Ref <$> parseRef s
1326+ where
1327+ parseRef s = do
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"
1332+
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/"
1336+
1337+instance FromJSON Xml where
1338+ parseJSON = genericParseJSON (jsonPrefix "xml")
1339+
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1341+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1342+
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1344+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1345+
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1347+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1348+
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1350+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1351+
1352+-- NOTE: There aren't collections of 'Schema'
1353+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1354+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1355+
1356+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1357+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1358+
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
1365+
1366+instance FromJSON AdditionalProperties where
1367+ parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368+ parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1369+
1370+-------------------------------------------------------------------------------
1371+-- TH splices
1372+-------------------------------------------------------------------------------
1373+
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
1386+
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")]
1409+
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"
1417+
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