@@ -1,6 +1,6 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE DataKinds #-}
32{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveFunctor #-}
44{-# LANGUAGE DeriveGeneric #-}
55{-# LANGUAGE DeriveTraversable #-}
66{-# LANGUAGE FlexibleContexts #-}
@@ -14,91 +14,87 @@
1414{-# LANGUAGE TemplateHaskell #-}
1515{-# LANGUAGE TypeFamilies #-}
1616{-# LANGUAGE UndecidableInstances #-}
17−module Data.OpenApi.Internal where
17+module Data.Swagger.Internal where
1818
1919import Prelude ()
2020import Prelude.Compat
2121
22+import Control.Lens ((&), (.~), (?~))
2223import Control.Applicative
23−import Control.Lens ((&), (.~), (?~))
24−import Data.Aeson hiding (Encoding)
25−#if MIN_VERSION_aeson(2,0,0)
26−import qualified Data.Aeson.KeyMap as KeyMap
27−#endif
28−import qualified Data.Aeson.Types as JSON
29−import Data.Data (Constr, Data (..), DataType, Fixity (..), Typeable,
30− constrIndex, mkConstr, mkDataType)
31−import Data.Hashable (Hashable (..))
32−import qualified Data.HashMap.Strict as HashMap
33−import Data.HashSet.InsOrd (InsOrdHashSet)
34−import Data.Map (Map)
35−import qualified Data.Map as Map
36−import Data.Monoid (Monoid (..))
37−import Data.Scientific (Scientific)
38−import Data.Semigroup.Compat (Semigroup (..))
39−import Data.String (IsString (..))
40−import Data.Text (Text)
41−import qualified Data.Text as Text
42−import Data.Text.Encoding (encodeUtf8)
43−import GHC.Generics (Generic)
44−import Network.HTTP.Media (MediaType, mainType, parameters, parseAccept, subType, (//),
45− (/:))
46−import Network.Socket (HostName, PortNumber)
47−import Text.Read (readMaybe)
24+import Data.Aeson
25+import qualified Data.Aeson.Types as JSON
26+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
27+import Data.Hashable (Hashable)
28+import qualified Data.HashMap.Strict as HashMap
29+import Data.HashSet.InsOrd (InsOrdHashSet)
30+import Data.Map (Map)
31+import qualified Data.Map as Map
32+import Data.Monoid (Monoid (..))
33+import Data.Semigroup.Compat (Semigroup (..))
34+import Data.Scientific (Scientific)
35+import Data.String (IsString(..))
36+import Data.Text (Text)
37+import qualified Data.Text as Text
38+import GHC.Generics (Generic)
39+import Network.Socket (HostName, PortNumber)
40+import Network.HTTP.Media (MediaType)
41+import Text.Read (readMaybe)
4842
4943import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
5044import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
5145
52−import Data.OpenApi.Aeson.Compat (deleteKey)
53−import Data.OpenApi.Internal.AesonUtils (AesonDefaultValue (..), HasSwaggerAesonOptions (..),
54− mkSwaggerAesonOptions, saoAdditionalPairs, saoSubObject,
55− sopSwaggerGenericParseJSON, sopSwaggerGenericToEncoding,
56− sopSwaggerGenericToJSON, sopSwaggerGenericToJSONWithOpts)
57−import Data.OpenApi.Internal.Utils
5846import Generics.SOP.TH (deriveGeneric)
47+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
48+ ,sopSwaggerGenericToJSONWithOpts
49+ ,sopSwaggerGenericParseJSON
50+ ,HasSwaggerAesonOptions(..)
51+ ,AesonDefaultValue(..)
52+ ,mkSwaggerAesonOptions
53+ ,saoAdditionalPairs
54+ ,saoSubObject)
55+import Data.Swagger.Internal.Utils
56+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
5957
6058-- $setup
6159-- >>> :seti -XDataKinds
6260-- >>> import Data.Aeson
63−-- >>> import Data.ByteString.Lazy.Char8 as BSL
64−-- >>> import Data.OpenApi.Internal.Utils
6561
6662-- | A list of definitions that can be used in references.
6763type Definitions = InsOrdHashMap Text
6864
6965-- | This is the root document object for the API specification.
70−data OpenApi = OpenApi
66+data Swagger = Swagger
7167 { -- | Provides metadata about the API.
7268 -- The metadata can be used by the clients if needed.
73− _openApiInfo :: Info
69+ _swaggerInfo :: Info
7470
7571 -- | An array of Server Objects, which provide connectivity information
7672 -- to a target server. If the servers property is not provided, or is an empty array,
7773 -- the default value would be a 'Server' object with a url value of @/@.
78− , _openApiServers :: [Server]
74+ , _swaggerServers :: [Server]
7975
8076 -- | The available paths and operations for the API.
81− , _openApiPaths :: InsOrdHashMap FilePath PathItem
77+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
8278
8379 -- | An element to hold various schemas for the specification.
84− , _openApiComponents :: Components
80+ , _swaggerComponents :: Components
8581
8682 -- | A declaration of which security mechanisms can be used across the API.
8783 -- The list of values includes alternative security requirement objects that can be used.
8884 -- Only one of the security requirement objects need to be satisfied to authorize a request.
8985 -- Individual operations can override this definition.
9086 -- To make security optional, an empty security requirement can be included in the array.
91− , _openApiSecurity :: [SecurityRequirement]
87+ , _swaggerSecurity :: [SecurityRequirement]
9288
9389 -- | A list of tags used by the specification with additional metadata.
9490 -- The order of the tags can be used to reflect on their order by the parsing tools.
9591 -- Not all tags that are used by the 'Operation' Object must be declared.
9692 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
9793 -- Each tag name in the list MUST be unique.
98− , _openApiTags :: InsOrdHashSet Tag
94+ , _swaggerTags :: InsOrdHashSet Tag
9995
10096 -- | Additional external documentation.
101− , _openApiExternalDocs :: Maybe ExternalDocs
97+ , _swaggerExternalDocs :: Maybe ExternalDocs
10298 } deriving (Eq, Show, Generic, Data, Typeable)
10399
104100-- | The object provides metadata about the API.
@@ -183,9 +179,6 @@ data ServerVariable = ServerVariable
183179 , _serverVariableDescription :: Maybe Text
184180 } deriving (Eq, Show, Generic, Data, Typeable)
185181
186−instance IsString Server where
187− fromString s = Server (fromString s) Nothing mempty
188−
189182-- | Holds a set of reusable objects for different aspects of the OAS.
190183-- All objects defined within the components object will have no effect on the API
191184-- unless they are explicitly referenced from properties outside the components object.
@@ -193,14 +186,44 @@ data Components = Components
193186 { _componentsSchemas :: Definitions Schema
194187 , _componentsResponses :: Definitions Response
195188 , _componentsParameters :: Definitions Param
196− , _componentsExamples :: Definitions Example
189+-- , _componentsExamples
197190 , _componentsRequestBodies :: Definitions RequestBody
198− , _componentsHeaders :: Definitions Header
199− , _componentsSecuritySchemes :: SecurityDefinitions
200− , _componentsLinks :: Definitions Link
201− , _componentsCallbacks :: Definitions Callback
191+ , _componentsHeader :: Definitions Header
192+ , _componentsSecuritySchemes :: Definitions SecurityScheme
193+-- , _componentsLinks
194+-- , _componentsCallbacks
202195 } deriving (Eq, Show, Generic, Data, Typeable)
203196
197+-- | The host (name or ip) serving the API. It MAY include a port.
198+data Host = Host
199+ { _hostName :: HostName -- ^ Host name.
200+ , _hostPort :: Maybe PortNumber -- ^ Optional port.
201+ } deriving (Eq, Show, Generic, Typeable)
202+
203+instance IsString Host where
204+ fromString s = Host s Nothing
205+
206+hostConstr :: Constr
207+hostConstr = mkConstr hostDataType "Host" [] Prefix
208+
209+hostDataType :: DataType
210+hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
211+
212+instance Data Host where
213+ gunfold k z c = case constrIndex c of
214+ 1 -> k (k (z (\name mport -> Host name (fromInteger <$> mport))))
215+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Host."
216+ toConstr (Host _ _) = hostConstr
217+ dataTypeOf _ = hostDataType
218+
219+-- | The transfer protocol of the API.
220+data Scheme
221+ = Http
222+ | Https
223+ | Ws
224+ | Wss
225+ deriving (Eq, Show, Generic, Data, Typeable)
226+
204227-- | Describes the operations available on a single path.
205228-- A @'PathItem'@ may be empty, due to ACL constraints.
206229-- The path itself is still exposed to the documentation viewer
@@ -288,11 +311,7 @@ data Operation = Operation
288311 -- | The list of possible responses as they are returned from executing this operation.
289312 , _operationResponses :: Responses
290313
291− -- | A map of possible out-of band callbacks related to the parent operation.
292− -- The key is a unique identifier for the 'Callback' Object.
293− -- Each value in the map is a 'Callback' Object that describes a request
294− -- that may be initiated by the API provider and the expected responses.
295− , _operationCallbacks :: InsOrdHashMap Text (Referenced Callback)
314+ -- TODO callbacks
296315
297316 -- | Declares this operation to be deprecated.
298317 -- Usage of the declared operation should be refrained.
@@ -312,22 +331,6 @@ data Operation = Operation
312331 , _operationServers :: [Server]
313332 } deriving (Eq, Show, Generic, Data, Typeable)
314333
315−-- This instance should be in @http-media@.
316−instance Data MediaType where
317− gunfold k z c = case constrIndex c of
318− 1 -> k (k (k (z (\main sub params -> foldl (/:) (main // sub) (Map.toList params)))))
319− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MediaType."
320−
321− toConstr _ = mediaTypeConstr
322−
323− dataTypeOf _ = mediaTypeData
324−
325−mediaTypeConstr = mkConstr mediaTypeData "MediaType" [] Prefix
326−mediaTypeData = mkDataType "MediaType" [mediaTypeConstr]
327−
328−instance Hashable MediaType where
329− hashWithSalt salt mt = salt `hashWithSalt` show mt
330−
331334-- | Describes a single request body.
332335data RequestBody = RequestBody
333336 { -- | A brief description of the request body. This could contain examples of use.
@@ -337,94 +340,21 @@ data RequestBody = RequestBody
337340 -- | The content of the request body.
338341 -- The key is a media type or media type range and the value describes it.
339342 -- For requests that match multiple keys, only the most specific key is applicable.
340− -- e.g. @text/plain@ overrides @text/\*@
341− , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
343+ -- e.g. @text/plain@ overrides @text/*@
344+ , _requestBodyContent :: InsOrdHashMap {-MediaType-} Text MediaTypeObject -- FIXME Data MediaType
342345
343− -- | Determines if the request body is required in the request.
344− -- Defaults to 'False'.
345346 , _requestBodyRequired :: Maybe Bool
346347 } deriving (Eq, Show, Generic, Data, Typeable)
347348
348349-- | Each Media Type Object provides schema and examples for the media type identified by its key.
349350data MediaTypeObject = MediaTypeObject
350− { _mediaTypeObjectSchema :: Maybe (Referenced Schema)
351+ { _mediaTypeSchema :: Maybe (Referenced Schema)
351352
352− -- | Example of the media type.
353− -- The example object SHOULD be in the correct format as specified by the media type.
354− , _mediaTypeObjectExample :: Maybe Value
353+-- TODO
354+-- , _mediaTypeExample
355+-- , _mediaTypeExamples
355356
356− -- | Examples of the media type.
357− -- Each example object SHOULD match the media type and specified schema if present.
358− , _mediaTypeObjectExamples :: InsOrdHashMap Text (Referenced Example)
359−
360− -- | A map between a property name and its encoding information.
361− -- The key, being the property name, MUST exist in the schema as a property.
362− -- The encoding object SHALL only apply to 'RequestBody' objects when the media type
363− -- is @multipart@ or @application/x-www-form-urlencoded@.
364− , _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
365− } deriving (Eq, Show, Generic, Data, Typeable)
366−
367−-- | In order to support common ways of serializing simple parameters, a set of style values are defined.
368−data Style
369− = StyleMatrix
370− -- ^ Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
371− | StyleLabel
372− -- ^ Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
373− | StyleForm
374− -- ^ Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
375− -- This option replaces @collectionFormat@ with a @csv@ (when @explode@ is false) or @multi@
376− -- (when explode is true) value from OpenAPI 2.0.
377− | StyleSimple
378− -- ^ Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
379− -- This option replaces @collectionFormat@ with a @csv@ value from OpenAPI 2.0.
380− | StyleSpaceDelimited
381− -- ^ Space separated array values.
382− -- This option replaces @collectionFormat@ equal to @ssv@ from OpenAPI 2.0.
383− | StylePipeDelimited
384− -- ^ Pipe separated array values.
385− -- This option replaces @collectionFormat@ equal to @pipes@ from OpenAPI 2.0.
386− | StyleDeepObject
387− -- ^ Provides a simple way of rendering nested objects using form parameters.
388− deriving (Eq, Show, Generic, Data, Typeable)
389−
390−data Encoding = Encoding
391− { -- | The Content-Type for encoding a specific property.
392− -- Default value depends on the property type: for @string@
393− -- with format being @binary@ – @application/octet-stream@;
394− -- for other primitive types – @text/plain@; for object - @application/json@;
395− -- for array – the default is defined based on the inner type.
396− -- The value can be a specific media type (e.g. @application/json@),
397− -- a wildcard media type (e.g. @image/\*@), or a comma-separated list of the two types.
398− _encodingContentType :: Maybe MediaType
399−
400− -- | A map allowing additional information to be provided as headers,
401− -- for example @Content-Disposition@. @Content-Type@ is described separately
402− -- and SHALL be ignored in this section.
403− -- This property SHALL be ignored if the request body media type is not a @multipart@.
404− , _encodingHeaders :: InsOrdHashMap Text (Referenced Header)
405−
406− -- | Describes how a specific property value will be serialized depending on its type.
407− -- See 'Param' Object for details on the style property.
408− -- The behavior follows the same values as query parameters, including default values.
409− -- This property SHALL be ignored if the request body media type
410− -- is not @application/x-www-form-urlencoded@.
411− , _encodingStyle :: Maybe Style
412−
413− -- | When this is true, property values of type @array@ or @object@ generate
414− -- separate parameters for each value of the array,
415− -- or key-value-pair of the map.
416− -- For other types of properties this property has no effect.
417− -- When style is form, the default value is @true@. For all other styles,
418− -- the default value is @false@. This property SHALL be ignored
419− -- if the request body media type is not @application/x-www-form-urlencoded@.
420− , _encodingExplode :: Maybe Bool
421−
422− -- | Determines whether the parameter value SHOULD allow reserved characters,
423− -- as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2)
424− -- @:/?#[]@!$&'()*+,;=@ to be included without percent-encoding.
425− -- The default value is @false@. This property SHALL be ignored if the request body media type
426− -- is not @application/x-www-form-urlencoded@.
427− , _encodingAllowReserved :: Maybe Bool
357+-- , _mediaTypeEncoding :: InsOrdHashMap Text Encoding
428358 } deriving (Eq, Show, Generic, Data, Typeable)
429359
430360newtype MimeList = MimeList { getMimeList :: [MediaType] }
@@ -434,11 +364,11 @@ mimeListConstr :: Constr
434364mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
435365
436366mimeListDataType :: DataType
437−mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
367+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
438368
439369instance Data MimeList where
440370 gunfold k z c = case constrIndex c of
441− 1 -> k (z (MimeList . map fromString))
371+ 1 -> k (z (\xs -> MimeList (map fromString xs)))
442372 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
443373 toConstr (MimeList _) = mimeListConstr
444374 dataTypeOf _ = mimeListDataType
@@ -452,7 +382,7 @@ data Param = Param
452382
453383 -- | A brief description of the parameter.
454384 -- This could contain examples of use.
455− -- CommonMark syntax MAY be used for rich text representation.
385+ -- GFM syntax can be used for rich text representation.
456386 , _paramDescription :: Maybe Text
457387
458388 -- | Determines whether this parameter is mandatory.
@@ -460,141 +390,159 @@ data Param = Param
460390 -- Otherwise, the property MAY be included and its default value is @False@.
461391 , _paramRequired :: Maybe Bool
462392
463− -- | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
464− -- Default value is @false@.
465− , _paramDeprecated :: Maybe Bool
466−
467− -- | The location of the parameter.
468− , _paramIn :: ParamLocation
469−
470− -- | Sets the ability to pass empty-valued parameters.
471− -- This is valid only for 'ParamQuery' parameters and allows sending
472− -- a parameter with an empty value. Default value is @false@.
473− , _paramAllowEmptyValue :: Maybe Bool
474−
475− -- | Determines whether the parameter value SHOULD allow reserved characters,
476− -- as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2)
477− -- @:/?#[]@!$&'()*+,;=@ to be included without percent-encoding.
478− -- This property only applies to parameters with an '_paramIn' value of 'ParamQuery'.
479− -- The default value is 'False'.
480− , _paramAllowReserved :: Maybe Bool
481−
482393 -- | Parameter schema.
483− , _paramSchema :: Maybe (Referenced Schema)
484−
485− -- | Describes how the parameter value will be serialized depending
486− -- on the type of the parameter value. Default values (based on value of '_paramIn'):
487− -- for 'ParamQuery' - 'StyleForm'; for 'ParamPath' - 'StyleSimple'; for 'ParamHeader' - 'StyleSimple';
488− -- for 'ParamCookie' - 'StyleForm'.
489− , _paramStyle :: Maybe Style
490−
491− -- | When this is true, parameter values of type @array@ or @object@
492− -- generate separate parameters for each value of the array or key-value pair of the map.
493− -- For other types of parameters this property has no effect.
494− -- When style is @form@, the default value is true. For all other styles, the default value is false.
495− , _paramExplode :: Maybe Bool
496−
497− -- | Example of the parameter's potential value.
498− -- The example SHOULD match the specified schema and encoding properties if present.
499− -- The '_paramExample' field is mutually exclusive of the '_paramExamples' field.
500− -- Furthermore, if referencing a schema that contains an example, the example value
501− -- SHALL override the example provided by the schema. To represent examples of media types
502− -- that cannot naturally be represented in JSON or YAML, a string value can contain
503− -- the example with escaping where necessary.
504− , _paramExample :: Maybe Value
505−
506− -- | Examples of the parameter's potential value.
507− -- Each example SHOULD contain a value in the correct format as specified
508− -- in the parameter encoding. The '_paramExamples' field is mutually exclusive of the '_paramExample' field.
509− -- Furthermore, if referencing a schema that contains an example,
510− -- the examples value SHALL override the example provided by the schema.
511− , _paramExamples :: InsOrdHashMap Text (Referenced Example)
512−
513− -- TODO
514− -- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
515− -- should be singleton. mutually exclusive with _paramSchema.
394+ , _paramSchema :: ParamAnySchema
516395 } deriving (Eq, Show, Generic, Data, Typeable)
517396
518−data Example = Example
519− { -- | Short description for the example.
520− _exampleSummary :: Maybe Text
521−
522− -- | Long description for the example.
523− -- CommonMark syntax MAY be used for rich text representation.
524− , _exampleDescription :: Maybe Text
525−
526− -- | Embedded literal example.
527− -- The '_exampleValue' field and '_exampleExternalValue' field are mutually exclusive.
528− --
529− -- To represent examples of media types that cannot naturally represented in JSON or YAML,
530− -- use a string value to contain the example, escaping where necessary.
531− , _exampleValue :: Maybe Value
532−
533− -- | A URL that points to the literal example.
534− -- This provides the capability to reference examples that cannot easily be included
535− -- in JSON or YAML documents. The '_exampleValue' field
536− -- and '_exampleExternalValue' field are mutually exclusive.
537− , _exampleExternalValue :: Maybe URL
538− } deriving (Eq, Show, Generic, Typeable, Data)
397+data ParamAnySchema
398+ = ParamBody (Referenced Schema)
399+ | ParamOther ParamOtherSchema
400+ deriving (Eq, Show, Generic, Data, Typeable)
401+
402+data ParamOtherSchema = ParamOtherSchema
403+ { -- | The location of the parameter.
404+ _paramOtherSchemaIn :: ParamLocation
539405
540−data ExpressionOrValue
541− = Expression Text
542− | Value Value
543− deriving (Eq, Show, Generic, Typeable, Data)
544−
545−-- | The Link object represents a possible design-time link for a response.
546−-- The presence of a link does not guarantee the caller's ability to successfully invoke it,
547−-- rather it provides a known relationship and traversal mechanism between responses and other operations.
548−data Link = Link
549− { -- | A relative or absolute URI reference to an OAS operation.
550− -- This field is mutually exclusive of the '_linkOperationId' field,
551− -- and MUST point to an 'Operation' Object. Relative '_linkOperationRef'
552− -- values MAY be used to locate an existing 'Operation' Object in the OpenAPI definition.
553− _linkOperationRef :: Maybe Text
554−
555− -- | The name of an /existing/, resolvable OAS operation, as defined with a unique
556− -- '_operationOperationId'. This field is mutually exclusive of the '_linkOperationRef' field.
557− , _linkOperationId :: Maybe Text
558−
559− -- | A map representing parameters to pass to an operation as specified with '_linkOperationId'
560− -- or identified via '_linkOperationRef'. The key is the parameter name to be used, whereas
561− -- the value can be a constant or an expression to be evaluated and passed to the linked operation.
562− -- The parameter name can be qualified using the parameter location @[{in}.]{name}@
563− -- for operations that use the same parameter name in different locations (e.g. path.id).
564− , _linkParameters :: InsOrdHashMap Text ExpressionOrValue
565−
566− -- | A literal value or @{expression}@ to use as a request body when calling the target operation.
567− , _linkRequestBody :: Maybe ExpressionOrValue
568−
569− -- | A description of the link.
570− , _linkDescription :: Maybe Text
571−
572− -- | A server object to be used by the target operation.
573− , _linkServer :: Maybe Server
406+ -- | Sets the ability to pass empty-valued parameters.
407+ -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
408+ -- and allows you to send a parameter with a name only or an empty value.
409+ -- Default value is @False@.
410+ , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
411+
412+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
574413 } deriving (Eq, Show, Generic, Typeable, Data)
575414
576−-- | Items for @'OpenApiArray'@ schemas.
415+-- | Items for @'SwaggerArray'@ schemas.
577416--
578−-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
579−-- it will incorporate Json Schema mostly verbatim.
417+-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
418+-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
419+-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
420+-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
580421--
581−-- @'OpenApiItemsObject'@ should be used to specify homogenous array @'Schema'@s.
422+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
582423--
583−-- @'OpenApiItemsArray'@ should be used to specify tuple @'Schema'@s.
584−data OpenApiItems where
585− OpenApiItemsObject :: Referenced Schema -> OpenApiItems
586− OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems
587− deriving (Eq, Show, Typeable, Data)
588−
589−data OpenApiType where
590− OpenApiString :: OpenApiType
591− OpenApiNumber :: OpenApiType
592− OpenApiInteger :: OpenApiType
593− OpenApiBoolean :: OpenApiType
594− OpenApiArray :: OpenApiType
595− OpenApiNull :: OpenApiType
596− OpenApiObject :: OpenApiType
597− deriving (Eq, Show, Typeable, Generic, Data)
424+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
425+data SwaggerItems t where
426+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
427+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
428+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
429+ deriving (Typeable)
430+
431+deriving instance Eq (SwaggerItems t)
432+deriving instance Show (SwaggerItems t)
433+--deriving instance Typeable (SwaggerItems t)
434+
435+swaggerItemsPrimitiveConstr :: Constr
436+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
437+
438+swaggerItemsObjectConstr :: Constr
439+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
440+
441+swaggerItemsArrayConstr :: Constr
442+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
443+
444+swaggerItemsDataType :: DataType
445+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
446+
447+-- Note: unfortunately we have to write these Data instances by hand,
448+-- to get better contexts / avoid duplicate name when using standalone deriving
449+
450+instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
451+ -- TODO: define gfoldl
452+ gunfold k z c = case constrIndex c of
453+ 1 -> k (k (z SwaggerItemsPrimitive))
454+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
455+ toConstr _ = swaggerItemsPrimitiveConstr
456+ dataTypeOf _ = swaggerItemsDataType
457+
458+-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
459+instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
460+ -- TODO: define gfoldl
461+ gunfold k z c = case constrIndex c of
462+ 1 -> k (k (z SwaggerItemsPrimitive))
463+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
464+ toConstr _ = swaggerItemsPrimitiveConstr
465+ dataTypeOf _ = swaggerItemsDataType
466+
467+instance Data (SwaggerItems 'SwaggerKindSchema) where
468+ gfoldl _ _ (SwaggerItemsPrimitive _ _) = error " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
469+ gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
470+ gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
471+
472+ gunfold k z c = case constrIndex c of
473+ 2 -> k (z SwaggerItemsObject)
474+ 3 -> k (z SwaggerItemsArray)
475+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
476+
477+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
478+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
479+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
480+
481+ dataTypeOf _ = swaggerItemsDataType
482+
483+-- | Type used as a kind to avoid overlapping instances.
484+data SwaggerKind t
485+ = SwaggerKindNormal t
486+ | SwaggerKindParamOtherSchema
487+ | SwaggerKindSchema
488+ deriving (Typeable)
489+
490+deriving instance Typeable 'SwaggerKindNormal
491+deriving instance Typeable 'SwaggerKindParamOtherSchema
492+deriving instance Typeable 'SwaggerKindSchema
493+
494+type family SwaggerKindType (k :: SwaggerKind *) :: *
495+type instance SwaggerKindType ('SwaggerKindNormal t) = t
496+type instance SwaggerKindType 'SwaggerKindSchema = Schema
497+type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
498+
499+data SwaggerType t where
500+ SwaggerString :: SwaggerType t
501+ SwaggerNumber :: SwaggerType t
502+ SwaggerInteger :: SwaggerType t
503+ SwaggerBoolean :: SwaggerType t
504+ SwaggerArray :: SwaggerType t
505+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
506+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
507+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
508+ deriving (Typeable)
509+
510+deriving instance Eq (SwaggerType t)
511+deriving instance Show (SwaggerType t)
512+
513+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
514+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
515+
516+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
517+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
518+
519+swaggerCommonTypes :: [SwaggerType k]
520+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
521+
522+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
523+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
524+
525+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
526+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
527+
528+swaggerTypeConstrs :: [Constr]
529+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
530+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
531+
532+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
533+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
534+ toConstr = swaggerTypeConstr
535+ dataTypeOf = swaggerTypeDataType
536+
537+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
538+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
539+ toConstr = swaggerTypeConstr
540+ dataTypeOf = swaggerTypeDataType
541+
542+instance Data (SwaggerType 'SwaggerKindSchema) where
543+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
544+ toConstr = swaggerTypeConstr
545+ dataTypeOf = swaggerTypeDataType
598546
599547data ParamLocation
600548 = -- | Parameters that are appended to the URL.
@@ -612,6 +560,42 @@ data ParamLocation
612560
613561type Format = Text
614562
563+-- | Determines the format of the array.
564+data CollectionFormat t where
565+ -- Comma separated values: @foo,bar@.
566+ CollectionCSV :: CollectionFormat t
567+ -- Space separated values: @foo bar@.
568+ CollectionSSV :: CollectionFormat t
569+ -- Tab separated values: @foo\\tbar@.
570+ CollectionTSV :: CollectionFormat t
571+ -- Pipe separated values: @foo|bar@.
572+ CollectionPipes :: CollectionFormat t
573+ -- Corresponds to multiple parameter instances
574+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
575+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
576+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
577+ deriving (Typeable)
578+
579+deriving instance Eq (CollectionFormat t)
580+deriving instance Show (CollectionFormat t)
581+
582+collectionFormatConstr :: CollectionFormat t -> Constr
583+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
584+
585+collectionFormatDataType :: DataType
586+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
587+ map collectionFormatConstr collectionCommonFormats
588+
589+collectionCommonFormats :: [CollectionFormat t]
590+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
591+
592+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
593+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
594+ toConstr = collectionFormatConstr
595+ dataTypeOf _ = collectionFormatDataType
596+
597+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
598+
615599type ParamName = Text
616600
617601data Schema = Schema
@@ -627,50 +611,16 @@ data Schema = Schema
627611 , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
628612 , _schemaAdditionalProperties :: Maybe AdditionalProperties
629613
630− , _schemaDiscriminator :: Maybe Discriminator
614+ , _schemaDiscriminator :: Maybe Text -- FIXME Discriminator object
631615 , _schemaReadOnly :: Maybe Bool
632− , _schemaWriteOnly :: Maybe Bool
633616 , _schemaXml :: Maybe Xml
634617 , _schemaExternalDocs :: Maybe ExternalDocs
635618 , _schemaExample :: Maybe Value
636− , _schemaDeprecated :: Maybe Bool
637619
638620 , _schemaMaxProperties :: Maybe Integer
639621 , _schemaMinProperties :: Maybe Integer
640622
641− , -- | Declares the value of the parameter that the server will use if none is provided,
642− -- for example a @"count"@ to control the number of results per page might default to @100@
643− -- if not supplied by the client in the request.
644− -- (Note: "default" has no meaning for required parameters.)
645− -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
646− _schemaDefault :: Maybe Value
647−
648− , _schemaType :: Maybe OpenApiType
649− , _schemaFormat :: Maybe Format
650− , _schemaItems :: Maybe OpenApiItems
651− , _schemaMaximum :: Maybe Scientific
652− , _schemaExclusiveMaximum :: Maybe Bool
653− , _schemaMinimum :: Maybe Scientific
654− , _schemaExclusiveMinimum :: Maybe Bool
655− , _schemaMaxLength :: Maybe Integer
656− , _schemaMinLength :: Maybe Integer
657− , _schemaPattern :: Maybe Pattern
658− , _schemaMaxItems :: Maybe Integer
659− , _schemaMinItems :: Maybe Integer
660− , _schemaUniqueItems :: Maybe Bool
661− , _schemaEnum :: Maybe [Value]
662− , _schemaMultipleOf :: Maybe Scientific
663− } deriving (Eq, Show, Generic, Data, Typeable)
664−
665−-- | Regex pattern for @string@ type.
666−type Pattern = Text
667−
668−data Discriminator = Discriminator
669− { -- | The name of the property in the payload that will hold the discriminator value.
670− _discriminatorPropertyName :: Text
671−
672− -- | An object to hold mappings between payload values and schema names or references.
673− , _discriminatorMapping :: InsOrdHashMap Text Text
623+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
674624 } deriving (Eq, Show, Generic, Data, Typeable)
675625
676626-- | A @'Schema'@ with an optional name.
@@ -680,9 +630,39 @@ data NamedSchema = NamedSchema
680630 , _namedSchemaSchema :: Schema
681631 } deriving (Eq, Show, Generic, Data, Typeable)
682632
633+-- | Regex pattern for @string@ type.
634+type Pattern = Text
635+
636+data ParamSchema (t :: SwaggerKind *) = ParamSchema
637+ { -- | Declares the value of the parameter that the server will use if none is provided,
638+ -- for example a @"count"@ to control the number of results per page might default to @100@
639+ -- if not supplied by the client in the request.
640+ -- (Note: "default" has no meaning for required parameters.)
641+ -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
642+ _paramSchemaDefault :: Maybe Value
643+
644+ , _paramSchemaType :: Maybe (SwaggerType t)
645+ , _paramSchemaFormat :: Maybe Format
646+ , _paramSchemaItems :: Maybe (SwaggerItems t)
647+ , _paramSchemaMaximum :: Maybe Scientific
648+ , _paramSchemaExclusiveMaximum :: Maybe Bool
649+ , _paramSchemaMinimum :: Maybe Scientific
650+ , _paramSchemaExclusiveMinimum :: Maybe Bool
651+ , _paramSchemaMaxLength :: Maybe Integer
652+ , _paramSchemaMinLength :: Maybe Integer
653+ , _paramSchemaPattern :: Maybe Pattern
654+ , _paramSchemaMaxItems :: Maybe Integer
655+ , _paramSchemaMinItems :: Maybe Integer
656+ , _paramSchemaUniqueItems :: Maybe Bool
657+ , _paramSchemaEnum :: Maybe [Value]
658+ , _paramSchemaMultipleOf :: Maybe Scientific
659+ } deriving (Eq, Show, Generic, Typeable)
660+
661+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
662+
683663data Xml = Xml
684664 { -- | Replaces the name of the element/attribute used for the described schema property.
685− -- When defined within the @'OpenApiItems'@ (items), it will affect the name of the individual XML elements within the list.
665+ -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
686666 -- When defined alongside type being array (outside the items),
687667 -- it will affect the wrapping element and only if wrapped is true.
688668 -- If wrapped is false, it will be ignored.
@@ -734,48 +714,43 @@ data Response = Response
734714 -- | A map containing descriptions of potential response payloads.
735715 -- The key is a media type or media type range and the value describes it.
736716 -- For responses that match multiple keys, only the most specific key is applicable.
737− -- e.g. @text/plain@ overrides @text/\*@.
738− , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
717+ -- e.g. @text/plain@ overrides @text/*@.
718+ , _responseContent :: InsOrdHashMap Text MediaTypeObject
739719
740720 -- | Maps a header name to its definition.
741− , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
721+ , _responseHeaders :: InsOrdHashMap HeaderName Header -- FIXME Referenced
742722
743− -- | A map of operations links that can be followed from the response.
744− -- The key of the map is a short name for the link, following the naming
745− -- constraints of the names for 'Component' Objects.
746− , _responseLinks :: InsOrdHashMap Text (Referenced Link)
723+ -- TODO links
747724 } deriving (Eq, Show, Generic, Data, Typeable)
748725
749726instance IsString Response where
750− fromString s = Response (fromString s) mempty mempty mempty
751−
752−-- | A map of possible out-of band callbacks related to the parent operation.
753−-- Each value in the map is a 'PathItem' Object that describes a set of requests that
754−-- may be initiated by the API provider and the expected responses.
755−-- The key value used to identify the path item object is an expression, evaluated at runtime,
756−-- that identifies a URL to use for the callback operation.
757−newtype Callback = Callback (InsOrdHashMap Text PathItem)
758− deriving (Eq, Show, Generic, Data, Typeable)
727+ fromString s = Response (fromString s) mempty mempty
759728
760729type HeaderName = Text
761730
762−-- | Header fields have the same meaning as for 'Param'.
763−--
764−-- Style is always treated as 'StyleSimple', as it is the only value allowed for headers.
765731data Header = Header
766732 { -- | A short description of the header.
767− _headerDescription :: Maybe HeaderName
733+ _headerDescription :: Maybe Text
768734
769− , _headerRequired :: Maybe Bool
770− , _headerDeprecated :: Maybe Bool
771− , _headerAllowEmptyValue :: Maybe Bool
772− , _headerExplode :: Maybe Bool
773− , _headerExample :: Maybe Value
774− , _headerExamples :: InsOrdHashMap Text (Referenced Example)
775−
776− , _headerSchema :: Maybe (Referenced Schema)
735+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
777736 } deriving (Eq, Show, Generic, Data, Typeable)
778737
738+data Example = Example { getExample :: Map MediaType Value }
739+ deriving (Eq, Show, Generic, Typeable)
740+
741+exampleConstr :: Constr
742+exampleConstr = mkConstr exampleDataType "Example" ["getExample"] Prefix
743+
744+exampleDataType :: DataType
745+exampleDataType = mkDataType "Data.Swagger.Example" [exampleConstr]
746+
747+instance Data Example where
748+ gunfold k z c = case constrIndex c of
749+ 1 -> k (z (\m -> Example (Map.mapKeys fromString m)))
750+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type Example."
751+ toConstr (Example _) = exampleConstr
752+ dataTypeOf _ = exampleDataType
753+
779754-- | The location of the API key.
780755data ApiKeyLocation
781756 = ApiKeyQuery
@@ -797,96 +772,26 @@ type AuthorizationURL = Text
797772-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
798773type TokenURL = Text
799774
800−newtype OAuth2ImplicitFlow
801− = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
802− deriving (Eq, Show, Generic, Data, Typeable)
803−
804−newtype OAuth2PasswordFlow
805− = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
775+data OAuth2Flow
776+ = OAuth2Implicit AuthorizationURL
777+ | OAuth2Password TokenURL
778+ | OAuth2Application TokenURL
779+ | OAuth2AccessCode AuthorizationURL TokenURL
806780 deriving (Eq, Show, Generic, Data, Typeable)
807781
808−newtype OAuth2ClientCredentialsFlow
809− = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
810− deriving (Eq, Show, Generic, Data, Typeable)
811−
812−data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
813− { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
814− , _oAuth2AuthorizationCodeFlowTokenUrl :: TokenURL
815− } deriving (Eq, Show, Generic, Data, Typeable)
816−
817−data OAuth2Flow p = OAuth2Flow
818− { _oAuth2Params :: p
819−
820− -- | The URL to be used for obtaining refresh tokens.
821− , _oAath2RefreshUrl :: Maybe URL
782+data OAuth2Params = OAuth2Params
783+ { -- | The flow used by the OAuth2 security scheme.
784+ _oauth2Flow :: OAuth2Flow
822785
823786 -- | The available scopes for the OAuth2 security scheme.
824− -- A map between the scope name and a short description for it.
825− -- The map MAY be empty.
826− , _oAuth2Scopes :: InsOrdHashMap Text Text
827− } deriving (Eq, Show, Generic, Data, Typeable)
828−
829−data OAuth2Flows = OAuth2Flows
830− { -- | Configuration for the OAuth Implicit flow
831− _oAuth2FlowsImplicit :: Maybe (OAuth2Flow OAuth2ImplicitFlow)
832−
833− -- | Configuration for the OAuth Resource Owner Password flow
834− , _oAuth2FlowsPassword :: Maybe (OAuth2Flow OAuth2PasswordFlow)
835−
836− -- | Configuration for the OAuth Client Credentials flow
837− , _oAuth2FlowsClientCredentials :: Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)
838−
839− -- | Configuration for the OAuth Authorization Code flow
840− , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
787+ , _oauth2Scopes :: InsOrdHashMap Text Text
841788 } deriving (Eq, Show, Generic, Data, Typeable)
842789
843−type BearerFormat = Text
844−
845−data HttpSchemeType
846− = HttpSchemeBearer (Maybe BearerFormat)
847− | HttpSchemeBasic
848− | HttpSchemeCustom Text
849− deriving (Eq, Show, Generic, Data, Typeable)
850−
851−-- |
852−--
853−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer Nothing))
854−-- {
855−-- "scheme": "bearer",
856−-- "type": "http"
857−-- }
858−--
859−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt")))
860−-- {
861−-- "bearerFormat": "jwt",
862−-- "scheme": "bearer",
863−-- "type": "http"
864−-- }
865−--
866−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp HttpSchemeBasic)
867−-- {
868−-- "scheme": "basic",
869−-- "type": "http"
870−-- }
871−--
872−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeCustom "CANARY"))
873−-- {
874−-- "scheme": "CANARY",
875−-- "type": "http"
876−-- }
877−--
878−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie))
879−-- {
880−-- "in": "cookie",
881−-- "name": "id",
882−-- "type": "apiKey"
883−-- }
884−--
885790data SecuritySchemeType
886− = SecuritySchemeHttp HttpSchemeType
791+ = SecuritySchemeHttp
887792 | SecuritySchemeApiKey ApiKeyParams
888− | SecuritySchemeOAuth2 OAuth2Flows
889− | SecuritySchemeOpenIdConnect URL
793+ | SecuritySchemeOAuth2 OAuth2Params
794+-- | SecuritySchemeOpenIdConnect -- FIXME
890795 deriving (Eq, Show, Generic, Data, Typeable)
891796
892797data SecurityScheme = SecurityScheme
@@ -897,6 +802,18 @@ data SecurityScheme = SecurityScheme
897802 , _securitySchemeDescription :: Maybe Text
898803 } deriving (Eq, Show, Generic, Data, Typeable)
899804
805+
806+-- | merge scopes of two OAuth2 security schemes when their flows are identical.
807+-- In other case returns first security scheme
808+mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
809+mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
810+ s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
811+ = if flow1 == flow2 then
812+ SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
813+ else
814+ s1
815+mergeSecurityScheme s1 _ = s1
816+
900817newtype SecurityDefinitions
901818 = SecurityDefinitions (Definitions SecurityScheme)
902819 deriving (Eq, Show, Generic, Data, Typeable)
@@ -918,7 +835,7 @@ data Tag = Tag
918835 _tagName :: TagName
919836
920837 -- | A short description for the tag.
921− -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
838+ -- GFM syntax can be used for rich text representation.
922839 , _tagDescription :: Maybe Text
923840
924841 -- | Additional external documentation for this tag.
@@ -933,7 +850,7 @@ instance IsString Tag where
933850-- | Allows referencing an external resource for extended documentation.
934851data ExternalDocs = ExternalDocs
935852 { -- | A short description of the target documentation.
936− -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
853+ -- GFM syntax can be used for rich text representation.
937854 _externalDocsDescription :: Maybe Text
938855
939856 -- | The URL for the target documentation.
@@ -966,13 +883,12 @@ data AdditionalProperties
966883-- Generic instances
967884-------------------------------------------------------------------------------
968885
969−deriveGeneric ''Server
970886deriveGeneric ''Components
971887deriveGeneric ''Header
972−deriveGeneric ''OAuth2Flow
973−deriveGeneric ''OAuth2Flows
888+deriveGeneric ''OAuth2Params
974889deriveGeneric ''Operation
975890deriveGeneric ''Param
891+deriveGeneric ''ParamOtherSchema
976892deriveGeneric ''PathItem
977893deriveGeneric ''Response
978894deriveGeneric ''RequestBody
@@ -980,18 +896,16 @@ deriveGeneric ''MediaTypeObject
980896deriveGeneric ''Responses
981897deriveGeneric ''SecurityScheme
982898deriveGeneric ''Schema
983−deriveGeneric ''OpenApi
984−deriveGeneric ''Example
985−deriveGeneric ''Encoding
986−deriveGeneric ''Link
899+deriveGeneric ''ParamSchema
900+deriveGeneric ''Swagger
987901
988902-- =======================================================================
989903-- Monoid instances
990904-- =======================================================================
991905
992−instance Semigroup OpenApi where
906+instance Semigroup Swagger where
993907 (<>) = genericMappend
994−instance Monoid OpenApi where
908+instance Monoid Swagger where
995909 mempty = genericMempty
996910 mappend = (<>)
997911
@@ -1025,39 +939,39 @@ instance Monoid Schema where
1025939 mempty = genericMempty
1026940 mappend = (<>)
1027941
1028−instance Semigroup Param where
942+instance Semigroup (ParamSchema t) where
1029943 (<>) = genericMappend
1030−instance Monoid Param where
944+instance Monoid (ParamSchema t) where
1031945 mempty = genericMempty
1032946 mappend = (<>)
1033947
1034−instance Semigroup Header where
948+instance Semigroup Param where
1035949 (<>) = genericMappend
1036−instance Monoid Header where
950+instance Monoid Param where
1037951 mempty = genericMempty
1038952 mappend = (<>)
1039953
1040−instance Semigroup Responses where
954+instance Semigroup ParamOtherSchema where
1041955 (<>) = genericMappend
1042−instance Monoid Responses where
956+instance Monoid ParamOtherSchema where
1043957 mempty = genericMempty
1044958 mappend = (<>)
1045959
1046−instance Semigroup Response where
960+instance Semigroup Header where
1047961 (<>) = genericMappend
1048−instance Monoid Response where
962+instance Monoid Header where
1049963 mempty = genericMempty
1050964 mappend = (<>)
1051965
1052−instance Semigroup MediaTypeObject where
966+instance Semigroup Responses where
1053967 (<>) = genericMappend
1054−instance Monoid MediaTypeObject where
968+instance Monoid Responses where
1055969 mempty = genericMempty
1056970 mappend = (<>)
1057971
1058−instance Semigroup Encoding where
972+instance Semigroup Response where
1059973 (<>) = genericMappend
1060−instance Monoid Encoding where
974+instance Monoid Response where
1061975 mempty = genericMempty
1062976 mappend = (<>)
1063977
@@ -1073,29 +987,14 @@ instance Monoid Operation where
1073987 mempty = genericMempty
1074988 mappend = (<>)
1075989
1076−instance Semigroup (OAuth2Flow p) where
1077− l@OAuth2Flow{ _oAath2RefreshUrl = lUrl, _oAuth2Scopes = lScopes }
1078− <> OAuth2Flow { _oAath2RefreshUrl = rUrl, _oAuth2Scopes = rScopes } =
1079− l { _oAath2RefreshUrl = swaggerMappend lUrl rUrl, _oAuth2Scopes = lScopes <> rScopes }
1080−
1081−-- swaggerMappend has First-like semantics, and here we need mappend'ing under Maybes.
1082−instance Semigroup OAuth2Flows where
1083− l <> r = OAuth2Flows
1084− { _oAuth2FlowsImplicit = _oAuth2FlowsImplicit l <> _oAuth2FlowsImplicit r
1085− , _oAuth2FlowsPassword = _oAuth2FlowsPassword l <> _oAuth2FlowsPassword r
1086− , _oAuth2FlowsClientCredentials = _oAuth2FlowsClientCredentials l <> _oAuth2FlowsClientCredentials r
1087− , _oAuth2FlowsAuthorizationCode = _oAuth2FlowsAuthorizationCode l <> _oAuth2FlowsAuthorizationCode r
1088− }
1089−
1090−instance Monoid OAuth2Flows where
990+instance Semigroup Example where
991+ (<>) = genericMappend
992+instance Monoid Example where
1091993 mempty = genericMempty
1092994 mappend = (<>)
1093995
1094996instance Semigroup SecurityScheme where
1095− SecurityScheme (SecuritySchemeOAuth2 lFlows) lDesc
1096− <> SecurityScheme (SecuritySchemeOAuth2 rFlows) rDesc =
1097− SecurityScheme (SecuritySchemeOAuth2 $ lFlows <> rFlows) (swaggerMappend lDesc rDesc)
1098− l <> _ = l
997+ (<>) = mergeSecurityScheme
1099998
1100999instance Semigroup SecurityDefinitions where
11011000 (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
@@ -1105,12 +1004,6 @@ instance Monoid SecurityDefinitions where
11051004 mempty = SecurityDefinitions InsOrdHashMap.empty
11061005 mappend = (<>)
11071006
1108−instance Semigroup RequestBody where
1109− (<>) = genericMappend
1110−instance Monoid RequestBody where
1111− mempty = genericMempty
1112− mappend = (<>)
1113−
11141007-- =======================================================================
11151008-- SwaggerMonoid helper instances
11161009-- =======================================================================
@@ -1119,19 +1012,21 @@ instance SwaggerMonoid Info
11191012instance SwaggerMonoid Components
11201013instance SwaggerMonoid PathItem
11211014instance SwaggerMonoid Schema
1015+instance SwaggerMonoid (ParamSchema t)
11221016instance SwaggerMonoid Param
1017+instance SwaggerMonoid ParamOtherSchema
11231018instance SwaggerMonoid Responses
11241019instance SwaggerMonoid Response
11251020instance SwaggerMonoid ExternalDocs
11261021instance SwaggerMonoid Operation
1127−instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
11281022instance SwaggerMonoid SecurityDefinitions
1023+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
11291024
11301025instance SwaggerMonoid MimeList
11311026deriving instance SwaggerMonoid URL
11321027
1133−instance SwaggerMonoid OpenApiType where
1134− swaggerMempty = OpenApiString
1028+instance SwaggerMonoid (SwaggerType t) where
1029+ swaggerMempty = SwaggerString
11351030 swaggerMappend _ y = y
11361031
11371032instance SwaggerMonoid ParamLocation where
@@ -1147,16 +1042,16 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
11471042 swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
11481043 swaggerMappend _ y = y
11491044
1045+instance SwaggerMonoid ParamAnySchema where
1046+ swaggerMempty = ParamOther swaggerMempty
1047+ swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
1048+ swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
1049+ swaggerMappend _ y = y
1050+
11501051-- =======================================================================
11511052-- Simple Generic-based ToJSON instances
11521053-- =======================================================================
11531054
1154−instance ToJSON Style where
1155− toJSON = genericToJSON (jsonPrefix "Style")
1156−
1157−instance ToJSON OpenApiType where
1158− toJSON = genericToJSON (jsonPrefix "Swagger")
1159−
11601055instance ToJSON ParamLocation where
11611056 toJSON = genericToJSON (jsonPrefix "Param")
11621057
@@ -1169,6 +1064,9 @@ instance ToJSON Contact where
11691064instance ToJSON License where
11701065 toJSON = genericToJSON (jsonPrefix "License")
11711066
1067+instance ToJSON Server where
1068+ toJSON = genericToJSON (jsonPrefix "Server")
1069+
11721070instance ToJSON ServerVariable where
11731071 toJSON = genericToJSON (jsonPrefix "ServerVariable")
11741072
@@ -1178,6 +1076,9 @@ instance ToJSON ApiKeyLocation where
11781076instance ToJSON ApiKeyParams where
11791077 toJSON = genericToJSON (jsonPrefix "apiKey")
11801078
1079+instance ToJSON Scheme where
1080+ toJSON = genericToJSON (jsonPrefix "")
1081+
11811082instance ToJSON Tag where
11821083 toJSON = genericToJSON (jsonPrefix "Tag")
11831084
@@ -1187,31 +1088,10 @@ instance ToJSON ExternalDocs where
11871088instance ToJSON Xml where
11881089 toJSON = genericToJSON (jsonPrefix "Xml")
11891090
1190−instance ToJSON Discriminator where
1191− toJSON = genericToJSON (jsonPrefix "Discriminator")
1192−
1193−instance ToJSON OAuth2ImplicitFlow where
1194− toJSON = genericToJSON (jsonPrefix "OAuth2ImplicitFlow")
1195−
1196−instance ToJSON OAuth2PasswordFlow where
1197− toJSON = genericToJSON (jsonPrefix "OAuth2PasswordFlow")
1198−
1199−instance ToJSON OAuth2ClientCredentialsFlow where
1200− toJSON = genericToJSON (jsonPrefix "OAuth2ClientCredentialsFlow")
1201−
1202−instance ToJSON OAuth2AuthorizationCodeFlow where
1203− toJSON = genericToJSON (jsonPrefix "OAuth2AuthorizationCodeFlow")
1204−
12051091-- =======================================================================
12061092-- Simple Generic-based FromJSON instances
12071093-- =======================================================================
12081094
1209−instance FromJSON Style where
1210− parseJSON = genericParseJSON (jsonPrefix "Style")
1211−
1212−instance FromJSON OpenApiType where
1213− parseJSON = genericParseJSON (jsonPrefix "Swagger")
1214−
12151095instance FromJSON ParamLocation where
12161096 parseJSON = genericParseJSON (jsonPrefix "Param")
12171097
@@ -1224,6 +1104,9 @@ instance FromJSON Contact where
12241104instance FromJSON License where
12251105 parseJSON = genericParseJSON (jsonPrefix "License")
12261106
1107+instance FromJSON Server where
1108+ parseJSON = genericParseJSON (jsonPrefix "Server")
1109+
12271110instance FromJSON ServerVariable where
12281111 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
12291112
@@ -1233,90 +1116,62 @@ instance FromJSON ApiKeyLocation where
12331116instance FromJSON ApiKeyParams where
12341117 parseJSON = genericParseJSON (jsonPrefix "apiKey")
12351118
1119+instance FromJSON Scheme where
1120+ parseJSON = genericParseJSON (jsonPrefix "")
1121+
12361122instance FromJSON Tag where
12371123 parseJSON = genericParseJSON (jsonPrefix "Tag")
12381124
12391125instance FromJSON ExternalDocs where
12401126 parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
12411127
1242−instance FromJSON Discriminator where
1243− parseJSON = genericParseJSON (jsonPrefix "Discriminator")
1244−
1245−instance FromJSON OAuth2ImplicitFlow where
1246− parseJSON = genericParseJSON (jsonPrefix "OAuth2ImplicitFlow")
1247−
1248−instance FromJSON OAuth2PasswordFlow where
1249− parseJSON = genericParseJSON (jsonPrefix "OAuth2PasswordFlow")
1250−
1251−instance FromJSON OAuth2ClientCredentialsFlow where
1252− parseJSON = genericParseJSON (jsonPrefix "OAuth2ClientCredentialsFlow")
1253−
1254−instance FromJSON OAuth2AuthorizationCodeFlow where
1255− parseJSON = genericParseJSON (jsonPrefix "OAuth2AuthorizationCodeFlow")
1256−
12571128-- =======================================================================
12581129-- Manual ToJSON instances
12591130-- =======================================================================
12601131
1261−instance ToJSON MediaType where
1262− toJSON = toJSON . show
1263− toEncoding = toEncoding . show
1264−
1265−instance ToJSONKey MediaType where
1266− toJSONKey = JSON.toJSONKeyText (Text.pack . show)
1267−
1268−instance (Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) where
1269− toJSON = sopSwaggerGenericToJSON
1270− toEncoding = sopSwaggerGenericToEncoding
1271−
1272−instance ToJSON OAuth2Flows where
1132+instance ToJSON OAuth2Flow where
1133+ toJSON (OAuth2Implicit authUrl) = object
1134+ [ "flow" .= ("implicit" :: Text)
1135+ , "authorizationUrl" .= authUrl ]
1136+ toJSON (OAuth2Password tokenUrl) = object
1137+ [ "flow" .= ("password" :: Text)
1138+ , "tokenUrl" .= tokenUrl ]
1139+ toJSON (OAuth2Application tokenUrl) = object
1140+ [ "flow" .= ("application" :: Text)
1141+ , "tokenUrl" .= tokenUrl ]
1142+ toJSON (OAuth2AccessCode authUrl tokenUrl) = object
1143+ [ "flow" .= ("accessCode" :: Text)
1144+ , "authorizationUrl" .= authUrl
1145+ , "tokenUrl" .= tokenUrl ]
1146+
1147+instance ToJSON OAuth2Params where
12731148 toJSON = sopSwaggerGenericToJSON
12741149 toEncoding = sopSwaggerGenericToEncoding
12751150
12761151instance ToJSON SecuritySchemeType where
1277− toJSON (SecuritySchemeHttp ty) = case ty of
1278− HttpSchemeBearer mFmt ->
1279− object $ [ "type" .= ("http" :: Text)
1280− , "scheme" .= ("bearer" :: Text)
1281− ] <> maybe [] (\t -> ["bearerFormat" .= t]) mFmt
1282− HttpSchemeBasic ->
1283− object [ "type" .= ("http" :: Text)
1284− , "scheme" .= ("basic" :: Text)
1285− ]
1286− HttpSchemeCustom t ->
1287− object [ "type" .= ("http" :: Text)
1288− , "scheme" .= t
1289− ]
1152+ toJSON SecuritySchemeHttp
1153+ = object [ "type" .= ("http" :: Text) ]
12901154 toJSON (SecuritySchemeApiKey params)
12911155 = toJSON params
12921156 <+> object [ "type" .= ("apiKey" :: Text) ]
1293− toJSON (SecuritySchemeOAuth2 params) = object
1294− [ "type" .= ("oauth2" :: Text)
1295− , "flows" .= toJSON params
1296− ]
1297− toJSON (SecuritySchemeOpenIdConnect url) = object
1298− [ "type" .= ("openIdConnect" :: Text)
1299− , "openIdConnectUrl" .= url
1300− ]
1157+ toJSON (SecuritySchemeOAuth2 params)
1158+ = toJSON params
1159+ <+> object [ "type" .= ("oauth2" :: Text) ]
13011160
1302−instance ToJSON OpenApi where
1161+instance ToJSON Swagger where
13031162 toJSON a = sopSwaggerGenericToJSON a &
1304− if InsOrdHashMap.null (_openApiPaths a)
1163+ if InsOrdHashMap.null (_swaggerPaths a)
13051164 then (<+> object ["paths" .= object []])
13061165 else id
13071166 toEncoding = sopSwaggerGenericToEncoding
13081167
1309−instance ToJSON Server where
1310− toJSON = sopSwaggerGenericToJSON
1311− toEncoding = sopSwaggerGenericToEncoding
1312−
13131168instance ToJSON SecurityScheme where
13141169 toJSON = sopSwaggerGenericToJSON
13151170 toEncoding = sopSwaggerGenericToEncoding
13161171
13171172instance ToJSON Schema where
1318− toJSON = sopSwaggerGenericToJSONWithOpts $
1319− mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1173+ toJSON = sopSwaggerGenericToJSON
1174+ toEncoding = sopSwaggerGenericToEncoding
13201175
13211176instance ToJSON Header where
13221177 toJSON = sopSwaggerGenericToJSON
@@ -1325,26 +1180,31 @@ instance ToJSON Header where
13251180-- | As for nullary schema for 0-arity type constructors, see
13261181-- <https://github.com/GetShopTV/swagger2/issues/167>.
13271182--
1328−-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1329−-- {
1330−-- "example": [],
1331−-- "items": {},
1332−-- "maxItems": 0
1333−-- }
1183+-- >>> encode (SwaggerItemsArray [])
1184+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
13341185--
1335−instance ToJSON OpenApiItems where
1336− toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1337− toJSON (OpenApiItemsArray []) = object
1186+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
1187+ toJSON (SwaggerItemsPrimitive fmt schema) = object
1188+ [ "collectionFormat" .= fmt
1189+ , "items" .= schema ]
1190+ toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1191+ toJSON (SwaggerItemsArray []) = object
13381192 [ "items" .= object []
13391193 , "maxItems" .= (0 :: Int)
13401194 , "example" .= Array mempty
13411195 ]
1342− toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
1196+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
13431197
13441198instance ToJSON Components where
13451199 toJSON = sopSwaggerGenericToJSON
13461200 toEncoding = sopSwaggerGenericToEncoding
13471201
1202+instance ToJSON Host where
1203+ toJSON (Host host mport) = toJSON $
1204+ case mport of
1205+ Nothing -> host
1206+ Just port -> host ++ ":" ++ show port
1207+
13481208instance ToJSON MimeList where
13491209 toJSON (MimeList xs) = toJSON (map show xs)
13501210
@@ -1352,6 +1212,14 @@ instance ToJSON Param where
13521212 toJSON = sopSwaggerGenericToJSON
13531213 toEncoding = sopSwaggerGenericToEncoding
13541214
1215+instance ToJSON ParamAnySchema where
1216+ toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1217+ toJSON (ParamOther s) = toJSON s
1218+
1219+instance ToJSON ParamOtherSchema where
1220+ toJSON = sopSwaggerGenericToJSON
1221+ toEncoding = sopSwaggerGenericToEncoding
1222+
13551223instance ToJSON Responses where
13561224 toJSON = sopSwaggerGenericToJSON
13571225 toEncoding = sopSwaggerGenericToEncoding
@@ -1377,16 +1245,7 @@ instance ToJSON MediaTypeObject where
13771245 toEncoding = sopSwaggerGenericToEncoding
13781246
13791247instance ToJSON Example where
1380− toJSON = sopSwaggerGenericToJSON
1381− toEncoding = sopSwaggerGenericToEncoding
1382−
1383−instance ToJSON Encoding where
1384− toJSON = sopSwaggerGenericToJSON
1385− toEncoding = sopSwaggerGenericToEncoding
1386−
1387−instance ToJSON Link where
1388− toJSON = sopSwaggerGenericToJSON
1389− toEncoding = sopSwaggerGenericToEncoding
1248+ toJSON = toJSON . Map.mapKeys show . getExample
13901249
13911250instance ToJSON SecurityDefinitions where
13921251 toJSON (SecurityDefinitions sd) = toJSON sd
@@ -1402,59 +1261,64 @@ instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/compone
14021261instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/components/parameters/"
14031262instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/components/responses/"
14041263instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1405−instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1406−instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1407−instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1408−instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
1264+
1265+instance ToJSON (SwaggerType t) where
1266+ toJSON SwaggerArray = "array"
1267+ toJSON SwaggerString = "string"
1268+ toJSON SwaggerInteger = "integer"
1269+ toJSON SwaggerNumber = "number"
1270+ toJSON SwaggerBoolean = "boolean"
1271+ toJSON SwaggerFile = "file"
1272+ toJSON SwaggerNull = "null"
1273+ toJSON SwaggerObject = "object"
1274+
1275+instance ToJSON (CollectionFormat t) where
1276+ toJSON CollectionCSV = "csv"
1277+ toJSON CollectionSSV = "ssv"
1278+ toJSON CollectionTSV = "tsv"
1279+ toJSON CollectionPipes = "pipes"
1280+ toJSON CollectionMulti = "multi"
1281+
1282+instance ToJSON (ParamSchema k) where
1283+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1284+ toJSON = sopSwaggerGenericToJSONWithOpts $
1285+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
14091286
14101287instance ToJSON AdditionalProperties where
14111288 toJSON (AdditionalPropertiesAllowed b) = toJSON b
14121289 toJSON (AdditionalPropertiesSchema s) = toJSON s
14131290
1414−instance ToJSON ExpressionOrValue where
1415− toJSON (Expression expr) = toJSON expr
1416− toJSON (Value val) = toJSON val
1417−
1418−instance ToJSON Callback where
1419− toJSON (Callback ps) = toJSON ps
1420−
14211291-- =======================================================================
14221292-- Manual FromJSON instances
14231293-- =======================================================================
14241294
1425−instance FromJSON MediaType where
1426− parseJSON = withText "MediaType" $ \str ->
1427− maybe (fail $ "Invalid media type literal " <> Text.unpack str) pure $ parseAccept $ encodeUtf8 str
1428−
1429−instance FromJSONKey MediaType where
1430− fromJSONKey = FromJSONKeyTextParser (parseJSON . String)
1431−
1432−instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1433− parseJSON = sopSwaggerGenericParseJSON
1295+instance FromJSON OAuth2Flow where
1296+ parseJSON (Object o) = do
1297+ (flow :: Text) <- o .: "flow"
1298+ case flow of
1299+ "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
1300+ "password" -> OAuth2Password <$> o .: "tokenUrl"
1301+ "application" -> OAuth2Application <$> o .: "tokenUrl"
1302+ "accessCode" -> OAuth2AccessCode
1303+ <$> o .: "authorizationUrl"
1304+ <*> o .: "tokenUrl"
1305+ _ -> empty
1306+ parseJSON _ = empty
14341307
1435−instance FromJSON OAuth2Flows where
1308+instance FromJSON OAuth2Params where
14361309 parseJSON = sopSwaggerGenericParseJSON
14371310
14381311instance FromJSON SecuritySchemeType where
14391312 parseJSON js@(Object o) = do
14401313 (t :: Text) <- o .: "type"
14411314 case t of
1442− "http" -> do
1443− scheme <- o .: "scheme"
1444− SecuritySchemeHttp <$> case scheme of
1445− "bearer" -> HttpSchemeBearer <$> (o .:! "bearerFormat")
1446− "basic" -> pure HttpSchemeBasic
1447− t -> pure $ HttpSchemeCustom t
1315+ "http" -> pure SecuritySchemeHttp
14481316 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1449− "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1450− "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1317+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
14511318 _ -> empty
14521319 parseJSON _ = empty
14531320
1454−instance FromJSON OpenApi where
1455− parseJSON = sopSwaggerGenericParseJSON
1456−
1457−instance FromJSON Server where
1321+instance FromJSON Swagger where
14581322 parseJSON = sopSwaggerGenericParseJSON
14591323
14601324instance FromJSON SecurityScheme where
@@ -1463,40 +1327,84 @@ instance FromJSON SecurityScheme where
14631327instance FromJSON Schema where
14641328 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
14651329 where nullaryCleanup :: Schema -> Schema
1466− nullaryCleanup s =
1467− if _schemaItems s == Just (OpenApiItemsArray [])
1330+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1331+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
14681332 then s { _schemaExample = Nothing
1469− , _schemaMaxItems = Nothing
1470− }
1333+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
14711334 else s
14721335
14731336instance FromJSON Header where
14741337 parseJSON = sopSwaggerGenericParseJSON
14751338
1476−instance FromJSON OpenApiItems where
1339+instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1340+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1341+ <$> o .:? "collectionFormat"
1342+ <*> (o .: "items" >>= parseJSON)
1343+
1344+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1345+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1346+ <$> o .:? "collectionFormat"
1347+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1348+
1349+-- |
1350+--
1351+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1352+-- Just (SwaggerItemsArray [])
1353+--
1354+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1355+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1356+--
1357+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1358+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1359+--
1360+instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
14771361 parseJSON js@(Object obj)
1478− | null obj = pure $ OpenApiItemsArray [] -- Nullary schema.
1479− | otherwise = OpenApiItemsObject <$> parseJSON js
1480− parseJSON js@(Array _) = OpenApiItemsArray <$> parseJSON js
1362+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1363+ | otherwise = SwaggerItemsObject <$> parseJSON js
1364+ parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
14811365 parseJSON _ = empty
14821366
14831367instance FromJSON Components where
14841368 parseJSON = sopSwaggerGenericParseJSON
14851369
1370+instance FromJSON Host where
1371+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1372+ [host] -> return $ Host host Nothing
1373+ [host, port] -> case readMaybe port of
1374+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1375+ Just p -> return $ Host host (Just (fromInteger p))
1376+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1377+ parseJSON _ = empty
1378+
14861379instance FromJSON MimeList where
1487− parseJSON js = MimeList . map fromString <$> parseJSON js
1380+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
14881381
14891382instance FromJSON Param where
14901383 parseJSON = sopSwaggerGenericParseJSON
14911384
1385+instance FromJSON ParamAnySchema where
1386+ parseJSON js@(Object o) = do
1387+ (i :: Text) <- o .: "in"
1388+ case i of
1389+ "body" -> do
1390+ schema <- o .: "schema"
1391+ ParamBody <$> parseJSON schema
1392+ _ -> ParamOther <$> parseJSON js
1393+ parseJSON _ = empty
1394+
1395+instance FromJSON ParamOtherSchema where
1396+ parseJSON = sopSwaggerGenericParseJSON
1397+
14921398instance FromJSON Responses where
14931399 parseJSON (Object o) = Responses
14941400 <$> o .:? "default"
1495− <*> parseJSON (Object (deleteKey "default" o))
1401+ <*> (parseJSON (Object (HashMap.delete "default" o)))
14961402 parseJSON _ = empty
14971403
14981404instance FromJSON Example where
1499− parseJSON = sopSwaggerGenericParseJSON
1405+ parseJSON js = do
1406+ m <- parseJSON js
1407+ pure $ Example (Map.mapKeys fromString m)
15001408
15011409instance FromJSON Response where
15021410 parseJSON = sopSwaggerGenericParseJSON
@@ -1507,20 +1415,14 @@ instance FromJSON Operation where
15071415instance FromJSON PathItem where
15081416 parseJSON = sopSwaggerGenericParseJSON
15091417
1510−instance FromJSON SecurityDefinitions where
1511− parseJSON js = SecurityDefinitions <$> parseJSON js
1512−
15131418instance FromJSON RequestBody where
15141419 parseJSON = sopSwaggerGenericParseJSON
15151420
15161421instance FromJSON MediaTypeObject where
15171422 parseJSON = sopSwaggerGenericParseJSON
15181423
1519−instance FromJSON Encoding where
1520− parseJSON = sopSwaggerGenericParseJSON
1521−
1522−instance FromJSON Link where
1523− parseJSON = sopSwaggerGenericParseJSON
1424+instance FromJSON SecurityDefinitions where
1425+ parseJSON js = SecurityDefinitions <$> parseJSON js
15241426
15251427instance FromJSON Reference where
15261428 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1542,41 +1444,53 @@ referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
15421444instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/components/schemas/"
15431445instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/components/parameters/"
15441446instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#/components/responses/"
1545−instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1546−instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1547−instance FromJSON (Referenced Header) where parseJSON = referencedParseJSON "#/components/headers/"
1548−instance FromJSON (Referenced Link) where parseJSON = referencedParseJSON "#/components/links/"
1549−instance FromJSON (Referenced Callback) where parseJSON = referencedParseJSON "#/components/callbacks/"
1447+instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies"
15501448
15511449instance FromJSON Xml where
15521450 parseJSON = genericParseJSON (jsonPrefix "xml")
15531451
1452+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1453+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1454+
1455+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1456+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1457+
1458+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1459+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1460+
1461+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1462+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1463+
1464+-- NOTE: There aren't collections of 'Schema'
1465+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1466+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1467+
1468+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1469+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1470+
1471+instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1472+ parseJSON = sopSwaggerGenericParseJSON
1473+instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1474+ parseJSON = sopSwaggerGenericParseJSON
1475+instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1476+ parseJSON = sopSwaggerGenericParseJSON
1477+
15541478instance FromJSON AdditionalProperties where
15551479 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
15561480 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
15571481
1558−-- | All strings are parsed as expressions
1559−instance FromJSON ExpressionOrValue where
1560− parseJSON (String expr) = pure $ Expression expr
1561− parseJSON v = pure $ Value v
1562−
1563−instance FromJSON Callback where
1564− parseJSON = fmap Callback . parseJSON
1565−
1566−instance HasSwaggerAesonOptions Server where
1567− swaggerAesonOptions _ = mkSwaggerAesonOptions "server"
15681482instance HasSwaggerAesonOptions Components where
15691483 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
15701484instance HasSwaggerAesonOptions Header where
1571− swaggerAesonOptions _ = mkSwaggerAesonOptions "header"
1572−instance AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) where
1573− swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "params"
1574−instance HasSwaggerAesonOptions OAuth2Flows where
1575− swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2Flows"
1485+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1486+instance HasSwaggerAesonOptions OAuth2Params where
1487+ swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
15761488instance HasSwaggerAesonOptions Operation where
15771489 swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
15781490instance HasSwaggerAesonOptions Param where
1579− swaggerAesonOptions _ = mkSwaggerAesonOptions "param"
1491+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1492+instance HasSwaggerAesonOptions ParamOtherSchema where
1493+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
15801494instance HasSwaggerAesonOptions PathItem where
15811495 swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
15821496instance HasSwaggerAesonOptions Response where
@@ -1584,36 +1498,32 @@ instance HasSwaggerAesonOptions Response where
15841498instance HasSwaggerAesonOptions RequestBody where
15851499 swaggerAesonOptions _ = mkSwaggerAesonOptions "requestBody"
15861500instance HasSwaggerAesonOptions MediaTypeObject where
1587− swaggerAesonOptions _ = mkSwaggerAesonOptions "mediaTypeObject"
1501+ swaggerAesonOptions _ = mkSwaggerAesonOptions "mediaType"
15881502instance HasSwaggerAesonOptions Responses where
15891503 swaggerAesonOptions _ = mkSwaggerAesonOptions "responses" & saoSubObject ?~ "responses"
15901504instance HasSwaggerAesonOptions SecurityScheme where
15911505 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
15921506instance HasSwaggerAesonOptions Schema where
15931507 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1594−instance HasSwaggerAesonOptions OpenApi where
1595− swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1596−instance HasSwaggerAesonOptions Example where
1597− swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1598−instance HasSwaggerAesonOptions Encoding where
1599− swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1508+instance HasSwaggerAesonOptions Swagger where
1509+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.3")]
16001510
1601−instance HasSwaggerAesonOptions Link where
1602− swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
1511+instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1512+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1513+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1514+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1515+-- NOTE: Schema doesn't have 'items' sub object!
1516+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1517+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
16031518
1604−instance AesonDefaultValue Server
16051519instance AesonDefaultValue Components
1606−instance AesonDefaultValue OAuth2ImplicitFlow
1607−instance AesonDefaultValue OAuth2PasswordFlow
1608−instance AesonDefaultValue OAuth2ClientCredentialsFlow
1609−instance AesonDefaultValue OAuth2AuthorizationCodeFlow
1610−instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1520+instance AesonDefaultValue (ParamSchema s)
1521+instance AesonDefaultValue OAuth2Flow
16111522instance AesonDefaultValue Responses
1523+instance AesonDefaultValue ParamAnySchema
16121524instance AesonDefaultValue SecuritySchemeType
1613−instance AesonDefaultValue OpenApiType
1525+instance AesonDefaultValue (SwaggerType a)
16141526instance AesonDefaultValue MimeList where defaultValue = Just mempty
16151527instance AesonDefaultValue Info
16161528instance AesonDefaultValue ParamLocation
1617−instance AesonDefaultValue Link
1618−instance AesonDefaultValue SecurityDefinitions where
1619− defaultValue = Just mempty
1529+instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty