@@ -1,6 +1,6 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DataKinds #-}
23{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveFunctor #-}
44{-# LANGUAGE DeriveGeneric #-}
55{-# LANGUAGE DeriveTraversable #-}
66{-# LANGUAGE FlexibleContexts #-}
@@ -14,87 +14,91 @@
1414{-# LANGUAGE TemplateHaskell #-}
1515{-# LANGUAGE TypeFamilies #-}
1616{-# LANGUAGE UndecidableInstances #-}
17−module Data.Swagger.Internal where
17+module Data.OpenApi.Internal where
1818
1919import Prelude ()
2020import Prelude.Compat
2121
22−import Control.Lens ((&), (.~), (?~))
2322import Control.Applicative
24−import Data.Aeson hiding (Encoding)
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)
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)
4248
4349import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
4450import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
4551
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
4658import 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)
5759
5860-- $setup
5961-- >>> :seti -XDataKinds
6062-- >>> import Data.Aeson
63+-- >>> import Data.ByteString.Lazy.Char8 as BSL
64+-- >>> import Data.OpenApi.Internal.Utils
6165
6266-- | A list of definitions that can be used in references.
6367type Definitions = InsOrdHashMap Text
6468
6569-- | This is the root document object for the API specification.
66−data Swagger = Swagger
70+data OpenApi = OpenApi
6771 { -- | Provides metadata about the API.
6872 -- The metadata can be used by the clients if needed.
69− _swaggerInfo :: Info
73+ _openApiInfo :: Info
7074
7175 -- | An array of Server Objects, which provide connectivity information
7276 -- to a target server. If the servers property is not provided, or is an empty array,
7377 -- the default value would be a 'Server' object with a url value of @/@.
74− , _swaggerServers :: [Server]
78+ , _openApiServers :: [Server]
7579
7680 -- | The available paths and operations for the API.
77− , _swaggerPaths :: InsOrdHashMap FilePath PathItem
81+ , _openApiPaths :: InsOrdHashMap FilePath PathItem
7882
7983 -- | An element to hold various schemas for the specification.
80− , _swaggerComponents :: Components
84+ , _openApiComponents :: Components
8185
8286 -- | A declaration of which security mechanisms can be used across the API.
8387 -- The list of values includes alternative security requirement objects that can be used.
8488 -- Only one of the security requirement objects need to be satisfied to authorize a request.
8589 -- Individual operations can override this definition.
8690 -- To make security optional, an empty security requirement can be included in the array.
87− , _swaggerSecurity :: [SecurityRequirement]
91+ , _openApiSecurity :: [SecurityRequirement]
8892
8993 -- | A list of tags used by the specification with additional metadata.
9094 -- The order of the tags can be used to reflect on their order by the parsing tools.
9195 -- Not all tags that are used by the 'Operation' Object must be declared.
9296 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
9397 -- Each tag name in the list MUST be unique.
94− , _swaggerTags :: InsOrdHashSet Tag
98+ , _openApiTags :: InsOrdHashSet Tag
9599
96100 -- | Additional external documentation.
97− , _swaggerExternalDocs :: Maybe ExternalDocs
101+ , _openApiExternalDocs :: Maybe ExternalDocs
98102 } deriving (Eq, Show, Generic, Data, Typeable)
99103
100104-- | The object provides metadata about the API.
@@ -179,6 +183,9 @@ data ServerVariable = ServerVariable
179183 , _serverVariableDescription :: Maybe Text
180184 } deriving (Eq, Show, Generic, Data, Typeable)
181185
186+instance IsString Server where
187+ fromString s = Server (fromString s) Nothing mempty
188+
182189-- | Holds a set of reusable objects for different aspects of the OAS.
183190-- All objects defined within the components object will have no effect on the API
184191-- unless they are explicitly referenced from properties outside the components object.
@@ -188,42 +195,12 @@ data Components = Components
188195 , _componentsParameters :: Definitions Param
189196 , _componentsExamples :: Definitions Example
190197 , _componentsRequestBodies :: Definitions RequestBody
191− , _componentsHeader :: Definitions Header
192− , _componentsSecuritySchemes :: Definitions SecurityScheme
193−-- , _componentsLinks
194−-- , _componentsCallbacks
198+ , _componentsHeaders :: Definitions Header
199+ , _componentsSecuritySchemes :: SecurityDefinitions
200+ , _componentsLinks :: Definitions Link
201+ , _componentsCallbacks :: Definitions Callback
195202 } deriving (Eq, Show, Generic, Data, Typeable)
196203
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−
227204-- | Describes the operations available on a single path.
228205-- A @'PathItem'@ may be empty, due to ACL constraints.
229206-- The path itself is still exposed to the documentation viewer
@@ -311,7 +288,11 @@ data Operation = Operation
311288 -- | The list of possible responses as they are returned from executing this operation.
312289 , _operationResponses :: Responses
313290
314− -- TODO callbacks
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)
315296
316297 -- | Declares this operation to be deprecated.
317298 -- Usage of the declared operation should be refrained.
@@ -331,6 +312,22 @@ data Operation = Operation
331312 , _operationServers :: [Server]
332313 } deriving (Eq, Show, Generic, Data, Typeable)
333314
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+
334331-- | Describes a single request body.
335332data RequestBody = RequestBody
336333 { -- | A brief description of the request body. This could contain examples of use.
@@ -340,9 +337,11 @@ data RequestBody = RequestBody
340337 -- | The content of the request body.
341338 -- The key is a media type or media type range and the value describes it.
342339 -- For requests that match multiple keys, only the most specific key is applicable.
343− -- e.g. @text/plain@ overrides @text/*@
344− , _requestBodyContent :: InsOrdHashMap {-MediaType-} Text MediaTypeObject -- FIXME Data MediaType
340+ -- e.g. @text/plain@ overrides @text/\*@
341+ , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
345342
343+ -- | Determines if the request body is required in the request.
344+ -- Defaults to 'False'.
346345 , _requestBodyRequired :: Maybe Bool
347346 } deriving (Eq, Show, Generic, Data, Typeable)
348347
@@ -365,6 +364,29 @@ data MediaTypeObject = MediaTypeObject
365364 , _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
366365 } deriving (Eq, Show, Generic, Data, Typeable)
367366
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+
368390data Encoding = Encoding
369391 { -- | The Content-Type for encoding a specific property.
370392 -- Default value depends on the property type: for @string@
@@ -372,8 +394,8 @@ data Encoding = Encoding
372394 -- for other primitive types – @text/plain@; for object - @application/json@;
373395 -- for array – the default is defined based on the inner type.
374396 -- The value can be a specific media type (e.g. @application/json@),
375− -- a wildcard media type (e.g. @image/*@), or a comma-separated list of the two types.
376− _encodingContentType :: Maybe Text
397+ -- a wildcard media type (e.g. @image/\*@), or a comma-separated list of the two types.
398+ _encodingContentType :: Maybe MediaType
377399
378400 -- | A map allowing additional information to be provided as headers,
379401 -- for example @Content-Disposition@. @Content-Type@ is described separately
@@ -382,11 +404,11 @@ data Encoding = Encoding
382404 , _encodingHeaders :: InsOrdHashMap Text (Referenced Header)
383405
384406 -- | Describes how a specific property value will be serialized depending on its type.
385− -- See Parameter Object for details on the style property.
407+ -- See 'Param' Object for details on the style property.
386408 -- The behavior follows the same values as query parameters, including default values.
387409 -- This property SHALL be ignored if the request body media type
388410 -- is not @application/x-www-form-urlencoded@.
389− , _encodingStyle :: Maybe Text -- TODO enum
411+ , _encodingStyle :: Maybe Style
390412
391413 -- | When this is true, property values of type @array@ or @object@ generate
392414 -- separate parameters for each value of the array,
@@ -412,11 +434,11 @@ mimeListConstr :: Constr
412434mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
413435
414436mimeListDataType :: DataType
415−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
437+mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
416438
417439instance Data MimeList where
418440 gunfold k z c = case constrIndex c of
419− 1 -> k (z (\xs -> MimeList (map fromString xs)))
441+ 1 -> k (z (MimeList . map fromString))
420442 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
421443 toConstr (MimeList _) = mimeListConstr
422444 dataTypeOf _ = mimeListDataType
@@ -430,7 +452,7 @@ data Param = Param
430452
431453 -- | A brief description of the parameter.
432454 -- This could contain examples of use.
433− -- GFM syntax can be used for rich text representation.
455+ -- CommonMark syntax MAY be used for rich text representation.
434456 , _paramDescription :: Maybe Text
435457
436458 -- | Determines whether this parameter is mandatory.
@@ -438,27 +460,60 @@ data Param = Param
438460 -- Otherwise, the property MAY be included and its default value is @False@.
439461 , _paramRequired :: Maybe Bool
440462
441− -- | Parameter schema.
442− , _paramSchema :: ParamAnySchema
443− } deriving (Eq, Show, Generic, Data, Typeable)
444−
445−data ParamAnySchema
446− = ParamBody (Referenced Schema)
447− | ParamOther ParamOtherSchema
448− deriving (Eq, Show, Generic, Data, Typeable)
463+ -- | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
464+ -- Default value is @false@.
465+ , _paramDeprecated :: Maybe Bool
449466
450−data ParamOtherSchema = ParamOtherSchema
451− { -- | The location of the parameter.
452− _paramOtherSchemaIn :: ParamLocation
467+ -- | The location of the parameter.
468+ , _paramIn :: ParamLocation
453469
454470 -- | Sets the ability to pass empty-valued parameters.
455− -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
456− -- and allows you to send a parameter with a name only or an empty value.
457− -- Default value is @False@.
458− , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
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
459474
460− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
461− } deriving (Eq, Show, Generic, Typeable, Data)
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+
482+ -- | 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.
516+ } deriving (Eq, Show, Generic, Data, Typeable)
462517
463518data Example = Example
464519 { -- | Short description for the example.
@@ -482,137 +537,64 @@ data Example = Example
482537 , _exampleExternalValue :: Maybe URL
483538 } deriving (Eq, Show, Generic, Typeable, Data)
484539
485−-- | Items for @'SwaggerArray'@ schemas.
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
574+ } deriving (Eq, Show, Generic, Typeable, Data)
575+
576+-- | Items for @'OpenApiArray'@ schemas.
486577--
487−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
488−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
489−-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
490−-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
578+-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
579+-- it will incorporate Json Schema mostly verbatim.
491580--
492−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
581+-- @'OpenApiItemsObject'@ should be used to specify homogenous array @'Schema'@s.
493582--
494−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
495−data SwaggerItems t where
496− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
497− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
498− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
499− deriving (Typeable)
500−
501−deriving instance Eq (SwaggerItems t)
502−deriving instance Show (SwaggerItems t)
503−--deriving instance Typeable (SwaggerItems t)
504−
505−swaggerItemsPrimitiveConstr :: Constr
506−swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
507−
508−swaggerItemsObjectConstr :: Constr
509−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
510−
511−swaggerItemsArrayConstr :: Constr
512−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
513−
514−swaggerItemsDataType :: DataType
515−swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
516−
517−-- Note: unfortunately we have to write these Data instances by hand,
518−-- to get better contexts / avoid duplicate name when using standalone deriving
519−
520−instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
521− -- TODO: define gfoldl
522− gunfold k z c = case constrIndex c of
523− 1 -> k (k (z SwaggerItemsPrimitive))
524− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
525− toConstr _ = swaggerItemsPrimitiveConstr
526− dataTypeOf _ = swaggerItemsDataType
527−
528−-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
529−instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
530− -- TODO: define gfoldl
531− gunfold k z c = case constrIndex c of
532− 1 -> k (k (z SwaggerItemsPrimitive))
533− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
534− toConstr _ = swaggerItemsPrimitiveConstr
535− dataTypeOf _ = swaggerItemsDataType
536−
537−instance Data (SwaggerItems 'SwaggerKindSchema) where
538− gfoldl _ _ (SwaggerItemsPrimitive _ _) = error " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
539− gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
540− gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
541−
542− gunfold k z c = case constrIndex c of
543− 2 -> k (z SwaggerItemsObject)
544− 3 -> k (z SwaggerItemsArray)
545− _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
546−
547− toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
548− toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
549− toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
550−
551− dataTypeOf _ = swaggerItemsDataType
552−
553−-- | Type used as a kind to avoid overlapping instances.
554−data SwaggerKind t
555− = SwaggerKindNormal t
556− | SwaggerKindParamOtherSchema
557− | SwaggerKindSchema
558− deriving (Typeable)
559−
560−deriving instance Typeable 'SwaggerKindNormal
561−deriving instance Typeable 'SwaggerKindParamOtherSchema
562−deriving instance Typeable 'SwaggerKindSchema
563−
564−type family SwaggerKindType (k :: SwaggerKind *) :: *
565−type instance SwaggerKindType ('SwaggerKindNormal t) = t
566−type instance SwaggerKindType 'SwaggerKindSchema = Schema
567−type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
568−
569−data SwaggerType t where
570− SwaggerString :: SwaggerType t
571− SwaggerNumber :: SwaggerType t
572− SwaggerInteger :: SwaggerType t
573− SwaggerBoolean :: SwaggerType t
574− SwaggerArray :: SwaggerType t
575− SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
576− SwaggerNull :: SwaggerType 'SwaggerKindSchema
577− SwaggerObject :: SwaggerType 'SwaggerKindSchema
578− deriving (Typeable)
579−
580−deriving instance Eq (SwaggerType t)
581−deriving instance Show (SwaggerType t)
582−
583−swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
584−swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
585−
586−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
587−swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
588−
589−swaggerCommonTypes :: [SwaggerType k]
590−swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
591−
592−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
593−swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
594−
595−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
596−swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
597−
598−swaggerTypeConstrs :: [Constr]
599−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
600− ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
601−
602−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
603− gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
604− toConstr = swaggerTypeConstr
605− dataTypeOf = swaggerTypeDataType
606−
607−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
608− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
609− toConstr = swaggerTypeConstr
610− dataTypeOf = swaggerTypeDataType
611−
612−instance Data (SwaggerType 'SwaggerKindSchema) where
613− gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
614− toConstr = swaggerTypeConstr
615− dataTypeOf = swaggerTypeDataType
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)
616598
617599data ParamLocation
618600 = -- | Parameters that are appended to the URL.
@@ -630,42 +612,6 @@ data ParamLocation
630612
631613type Format = Text
632614
633−-- | Determines the format of the array.
634−data CollectionFormat t where
635− -- Comma separated values: @foo,bar@.
636− CollectionCSV :: CollectionFormat t
637− -- Space separated values: @foo bar@.
638− CollectionSSV :: CollectionFormat t
639− -- Tab separated values: @foo\\tbar@.
640− CollectionTSV :: CollectionFormat t
641− -- Pipe separated values: @foo|bar@.
642− CollectionPipes :: CollectionFormat t
643− -- Corresponds to multiple parameter instances
644− -- instead of multiple values for a single instance @foo=bar&foo=baz@.
645− -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
646− CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
647− deriving (Typeable)
648−
649−deriving instance Eq (CollectionFormat t)
650−deriving instance Show (CollectionFormat t)
651−
652−collectionFormatConstr :: CollectionFormat t -> Constr
653−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
654−
655−collectionFormatDataType :: DataType
656−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
657− map collectionFormatConstr collectionCommonFormats
658−
659−collectionCommonFormats :: [CollectionFormat t]
660−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
661−
662−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
663− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
664− toConstr = collectionFormatConstr
665− dataTypeOf _ = collectionFormatDataType
666−
667−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
668−
669615type ParamName = Text
670616
671617data Schema = Schema
@@ -681,16 +627,50 @@ data Schema = Schema
681627 , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
682628 , _schemaAdditionalProperties :: Maybe AdditionalProperties
683629
684− , _schemaDiscriminator :: Maybe Text -- FIXME Discriminator object
630+ , _schemaDiscriminator :: Maybe Discriminator
685631 , _schemaReadOnly :: Maybe Bool
632+ , _schemaWriteOnly :: Maybe Bool
686633 , _schemaXml :: Maybe Xml
687634 , _schemaExternalDocs :: Maybe ExternalDocs
688635 , _schemaExample :: Maybe Value
636+ , _schemaDeprecated :: Maybe Bool
689637
690638 , _schemaMaxProperties :: Maybe Integer
691639 , _schemaMinProperties :: Maybe Integer
692640
693− , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
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
694674 } deriving (Eq, Show, Generic, Data, Typeable)
695675
696676-- | A @'Schema'@ with an optional name.
@@ -700,41 +680,9 @@ data NamedSchema = NamedSchema
700680 , _namedSchemaSchema :: Schema
701681 } deriving (Eq, Show, Generic, Data, Typeable)
702682
703−-- | Regex pattern for @string@ type.
704−type Pattern = Text
705−
706−-- TODO examples for params
707−
708−data ParamSchema (t :: SwaggerKind *) = ParamSchema
709− { -- | Declares the value of the parameter that the server will use if none is provided,
710− -- for example a @"count"@ to control the number of results per page might default to @100@
711− -- if not supplied by the client in the request.
712− -- (Note: "default" has no meaning for required parameters.)
713− -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
714− _paramSchemaDefault :: Maybe Value
715−
716− , _paramSchemaType :: Maybe (SwaggerType t)
717− , _paramSchemaFormat :: Maybe Format
718− , _paramSchemaItems :: Maybe (SwaggerItems t)
719− , _paramSchemaMaximum :: Maybe Scientific
720− , _paramSchemaExclusiveMaximum :: Maybe Bool
721− , _paramSchemaMinimum :: Maybe Scientific
722− , _paramSchemaExclusiveMinimum :: Maybe Bool
723− , _paramSchemaMaxLength :: Maybe Integer
724− , _paramSchemaMinLength :: Maybe Integer
725− , _paramSchemaPattern :: Maybe Pattern
726− , _paramSchemaMaxItems :: Maybe Integer
727− , _paramSchemaMinItems :: Maybe Integer
728− , _paramSchemaUniqueItems :: Maybe Bool
729− , _paramSchemaEnum :: Maybe [Value]
730− , _paramSchemaMultipleOf :: Maybe Scientific
731− } deriving (Eq, Show, Generic, Typeable)
732−
733−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
734−
735683data Xml = Xml
736684 { -- | Replaces the name of the element/attribute used for the described schema property.
737− -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
685+ -- When defined within the @'OpenApiItems'@ (items), it will affect the name of the individual XML elements within the list.
738686 -- When defined alongside type being array (outside the items),
739687 -- it will affect the wrapping element and only if wrapped is true.
740688 -- If wrapped is false, it will be ignored.
@@ -786,25 +734,46 @@ data Response = Response
786734 -- | A map containing descriptions of potential response payloads.
787735 -- The key is a media type or media type range and the value describes it.
788736 -- For responses that match multiple keys, only the most specific key is applicable.
789− -- e.g. @text/plain@ overrides @text/*@.
790− , _responseContent :: InsOrdHashMap Text MediaTypeObject
737+ -- e.g. @text/plain@ overrides @text/\*@.
738+ , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
791739
792740 -- | Maps a header name to its definition.
793− , _responseHeaders :: InsOrdHashMap HeaderName Header -- FIXME Referenced
741+ , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
794742
795− -- TODO links
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)
796747 } deriving (Eq, Show, Generic, Data, Typeable)
797748
798749instance IsString Response where
799− fromString s = Response (fromString s) mempty mempty
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)
800759
801760type HeaderName = Text
802761
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.
803765data Header = Header
804766 { -- | A short description of the header.
805− _headerDescription :: Maybe Text
767+ _headerDescription :: Maybe HeaderName
768+
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)
806775
807− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
776+ , _headerSchema :: Maybe (Referenced Schema)
808777 } deriving (Eq, Show, Generic, Data, Typeable)
809778
810779-- | The location of the API key.
@@ -828,26 +797,96 @@ type AuthorizationURL = Text
828797-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
829798type TokenURL = Text
830799
831−data OAuth2Flow
832− = OAuth2Implicit AuthorizationURL
833− | OAuth2Password TokenURL
834− | OAuth2Application TokenURL
835− | OAuth2AccessCode AuthorizationURL TokenURL
800+newtype OAuth2ImplicitFlow
801+ = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
802+ deriving (Eq, Show, Generic, Data, Typeable)
803+
804+newtype OAuth2PasswordFlow
805+ = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
806+ deriving (Eq, Show, Generic, Data, Typeable)
807+
808+newtype OAuth2ClientCredentialsFlow
809+ = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
836810 deriving (Eq, Show, Generic, Data, Typeable)
837811
838−data OAuth2Params = OAuth2Params
839− { -- | The flow used by the OAuth2 security scheme.
840− _oauth2Flow :: OAuth2Flow
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
841822
842823 -- | The available scopes for the OAuth2 security scheme.
843− , _oauth2Scopes :: InsOrdHashMap Text Text
824+ -- A map between the scope name and a short description for it.
825+ -- The map MAY be empty.
826+ , _oAuth2Scopes :: InsOrdHashMap Text Text
844827 } deriving (Eq, Show, Generic, Data, Typeable)
845828
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)
841+ } deriving (Eq, Show, Generic, Data, Typeable)
842+
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+--
846885data SecuritySchemeType
847− = SecuritySchemeHttp
886+ = SecuritySchemeHttp HttpSchemeType
848887 | SecuritySchemeApiKey ApiKeyParams
849− | SecuritySchemeOAuth2 OAuth2Params
850−-- | SecuritySchemeOpenIdConnect -- FIXME
888+ | SecuritySchemeOAuth2 OAuth2Flows
889+ | SecuritySchemeOpenIdConnect URL
851890 deriving (Eq, Show, Generic, Data, Typeable)
852891
853892data SecurityScheme = SecurityScheme
@@ -858,18 +897,6 @@ data SecurityScheme = SecurityScheme
858897 , _securitySchemeDescription :: Maybe Text
859898 } deriving (Eq, Show, Generic, Data, Typeable)
860899
861−
862−-- | merge scopes of two OAuth2 security schemes when their flows are identical.
863−-- In other case returns first security scheme
864−mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
865−mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
866− s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
867− = if flow1 == flow2 then
868− SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
869− else
870− s1
871−mergeSecurityScheme s1 _ = s1
872−
873900newtype SecurityDefinitions
874901 = SecurityDefinitions (Definitions SecurityScheme)
875902 deriving (Eq, Show, Generic, Data, Typeable)
@@ -891,7 +918,7 @@ data Tag = Tag
891918 _tagName :: TagName
892919
893920 -- | A short description for the tag.
894− -- GFM syntax can be used for rich text representation.
921+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
895922 , _tagDescription :: Maybe Text
896923
897924 -- | Additional external documentation for this tag.
@@ -906,7 +933,7 @@ instance IsString Tag where
906933-- | Allows referencing an external resource for extended documentation.
907934data ExternalDocs = ExternalDocs
908935 { -- | A short description of the target documentation.
909− -- GFM syntax can be used for rich text representation.
936+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
910937 _externalDocsDescription :: Maybe Text
911938
912939 -- | The URL for the target documentation.
@@ -939,12 +966,13 @@ data AdditionalProperties
939966-- Generic instances
940967-------------------------------------------------------------------------------
941968
969+deriveGeneric ''Server
942970deriveGeneric ''Components
943971deriveGeneric ''Header
944−deriveGeneric ''OAuth2Params
972+deriveGeneric ''OAuth2Flow
973+deriveGeneric ''OAuth2Flows
945974deriveGeneric ''Operation
946975deriveGeneric ''Param
947−deriveGeneric ''ParamOtherSchema
948976deriveGeneric ''PathItem
949977deriveGeneric ''Response
950978deriveGeneric ''RequestBody
@@ -952,18 +980,18 @@ deriveGeneric ''MediaTypeObject
952980deriveGeneric ''Responses
953981deriveGeneric ''SecurityScheme
954982deriveGeneric ''Schema
955−deriveGeneric ''ParamSchema
956−deriveGeneric ''Swagger
983+deriveGeneric ''OpenApi
957984deriveGeneric ''Example
958985deriveGeneric ''Encoding
986+deriveGeneric ''Link
959987
960988-- =======================================================================
961989-- Monoid instances
962990-- =======================================================================
963991
964−instance Semigroup Swagger where
992+instance Semigroup OpenApi where
965993 (<>) = genericMappend
966−instance Monoid Swagger where
994+instance Monoid OpenApi where
967995 mempty = genericMempty
968996 mappend = (<>)
969997
@@ -997,24 +1025,12 @@ instance Monoid Schema where
9971025 mempty = genericMempty
9981026 mappend = (<>)
9991027
1000−instance Semigroup (ParamSchema t) where
1001− (<>) = genericMappend
1002−instance Monoid (ParamSchema t) where
1003− mempty = genericMempty
1004− mappend = (<>)
1005−
10061028instance Semigroup Param where
10071029 (<>) = genericMappend
10081030instance Monoid Param where
10091031 mempty = genericMempty
10101032 mappend = (<>)
10111033
1012−instance Semigroup ParamOtherSchema where
1013− (<>) = genericMappend
1014−instance Monoid ParamOtherSchema where
1015− mempty = genericMempty
1016− mappend = (<>)
1017−
10181034instance Semigroup Header where
10191035 (<>) = genericMappend
10201036instance Monoid Header where
@@ -1057,8 +1073,29 @@ instance Monoid Operation where
10571073 mempty = genericMempty
10581074 mappend = (<>)
10591075
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
1091+ mempty = genericMempty
1092+ mappend = (<>)
1093+
10601094instance Semigroup SecurityScheme where
1061− (<>) = mergeSecurityScheme
1095+ SecurityScheme (SecuritySchemeOAuth2 lFlows) lDesc
1096+ <> SecurityScheme (SecuritySchemeOAuth2 rFlows) rDesc =
1097+ SecurityScheme (SecuritySchemeOAuth2 $ lFlows <> rFlows) (swaggerMappend lDesc rDesc)
1098+ l <> _ = l
10621099
10631100instance Semigroup SecurityDefinitions where
10641101 (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
@@ -1068,6 +1105,12 @@ instance Monoid SecurityDefinitions where
10681105 mempty = SecurityDefinitions InsOrdHashMap.empty
10691106 mappend = (<>)
10701107
1108+instance Semigroup RequestBody where
1109+ (<>) = genericMappend
1110+instance Monoid RequestBody where
1111+ mempty = genericMempty
1112+ mappend = (<>)
1113+
10711114-- =======================================================================
10721115-- SwaggerMonoid helper instances
10731116-- =======================================================================
@@ -1076,21 +1119,19 @@ instance SwaggerMonoid Info
10761119instance SwaggerMonoid Components
10771120instance SwaggerMonoid PathItem
10781121instance SwaggerMonoid Schema
1079−instance SwaggerMonoid (ParamSchema t)
10801122instance SwaggerMonoid Param
1081−instance SwaggerMonoid ParamOtherSchema
10821123instance SwaggerMonoid Responses
10831124instance SwaggerMonoid Response
10841125instance SwaggerMonoid ExternalDocs
10851126instance SwaggerMonoid Operation
1086−instance SwaggerMonoid SecurityDefinitions
10871127instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1128+instance SwaggerMonoid SecurityDefinitions
10881129
10891130instance SwaggerMonoid MimeList
10901131deriving instance SwaggerMonoid URL
10911132
1092−instance SwaggerMonoid (SwaggerType t) where
1093− swaggerMempty = SwaggerString
1133+instance SwaggerMonoid OpenApiType where
1134+ swaggerMempty = OpenApiString
10941135 swaggerMappend _ y = y
10951136
10961137instance SwaggerMonoid ParamLocation where
@@ -1106,16 +1147,16 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
11061147 swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
11071148 swaggerMappend _ y = y
11081149
1109−instance SwaggerMonoid ParamAnySchema where
1110− swaggerMempty = ParamOther swaggerMempty
1111− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
1112− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
1113− swaggerMappend _ y = y
1114−
11151150-- =======================================================================
11161151-- Simple Generic-based ToJSON instances
11171152-- =======================================================================
11181153
1154+instance ToJSON Style where
1155+ toJSON = genericToJSON (jsonPrefix "Style")
1156+
1157+instance ToJSON OpenApiType where
1158+ toJSON = genericToJSON (jsonPrefix "Swagger")
1159+
11191160instance ToJSON ParamLocation where
11201161 toJSON = genericToJSON (jsonPrefix "Param")
11211162
@@ -1128,9 +1169,6 @@ instance ToJSON Contact where
11281169instance ToJSON License where
11291170 toJSON = genericToJSON (jsonPrefix "License")
11301171
1131−instance ToJSON Server where
1132− toJSON = genericToJSON (jsonPrefix "Server")
1133−
11341172instance ToJSON ServerVariable where
11351173 toJSON = genericToJSON (jsonPrefix "ServerVariable")
11361174
@@ -1140,9 +1178,6 @@ instance ToJSON ApiKeyLocation where
11401178instance ToJSON ApiKeyParams where
11411179 toJSON = genericToJSON (jsonPrefix "apiKey")
11421180
1143−instance ToJSON Scheme where
1144− toJSON = genericToJSON (jsonPrefix "")
1145−
11461181instance ToJSON Tag where
11471182 toJSON = genericToJSON (jsonPrefix "Tag")
11481183
@@ -1152,10 +1187,31 @@ instance ToJSON ExternalDocs where
11521187instance ToJSON Xml where
11531188 toJSON = genericToJSON (jsonPrefix "Xml")
11541189
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+
11551205-- =======================================================================
11561206-- Simple Generic-based FromJSON instances
11571207-- =======================================================================
11581208
1209+instance FromJSON Style where
1210+ parseJSON = genericParseJSON (jsonPrefix "Style")
1211+
1212+instance FromJSON OpenApiType where
1213+ parseJSON = genericParseJSON (jsonPrefix "Swagger")
1214+
11591215instance FromJSON ParamLocation where
11601216 parseJSON = genericParseJSON (jsonPrefix "Param")
11611217
@@ -1168,9 +1224,6 @@ instance FromJSON Contact where
11681224instance FromJSON License where
11691225 parseJSON = genericParseJSON (jsonPrefix "License")
11701226
1171−instance FromJSON Server where
1172− parseJSON = genericParseJSON (jsonPrefix "Server")
1173−
11741227instance FromJSON ServerVariable where
11751228 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
11761229
@@ -1180,63 +1233,91 @@ instance FromJSON ApiKeyLocation where
11801233instance FromJSON ApiKeyParams where
11811234 parseJSON = genericParseJSON (jsonPrefix "apiKey")
11821235
1183−instance FromJSON Scheme where
1184− parseJSON = genericParseJSON (jsonPrefix "")
1185−
11861236instance FromJSON Tag where
11871237 parseJSON = genericParseJSON (jsonPrefix "Tag")
11881238
11891239instance FromJSON ExternalDocs where
11901240 parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
11911241
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+
11921257-- =======================================================================
11931258-- Manual ToJSON instances
11941259-- =======================================================================
11951260
1196−instance ToJSON OAuth2Flow where
1197− toJSON (OAuth2Implicit authUrl) = object
1198− [ "flow" .= ("implicit" :: Text)
1199− , "authorizationUrl" .= authUrl ]
1200− toJSON (OAuth2Password tokenUrl) = object
1201− [ "flow" .= ("password" :: Text)
1202− , "tokenUrl" .= tokenUrl ]
1203− toJSON (OAuth2Application tokenUrl) = object
1204− [ "flow" .= ("application" :: Text)
1205− , "tokenUrl" .= tokenUrl ]
1206− toJSON (OAuth2AccessCode authUrl tokenUrl) = object
1207− [ "flow" .= ("accessCode" :: Text)
1208− , "authorizationUrl" .= authUrl
1209− , "tokenUrl" .= tokenUrl ]
1210−
1211−instance ToJSON OAuth2Params where
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
12121273 toJSON = sopSwaggerGenericToJSON
12131274 toEncoding = sopSwaggerGenericToEncoding
12141275
12151276instance ToJSON SecuritySchemeType where
1216− toJSON SecuritySchemeHttp
1217− = object [ "type" .= ("http" :: Text) ]
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+ ]
12181290 toJSON (SecuritySchemeApiKey params)
12191291 = toJSON params
12201292 <+> object [ "type" .= ("apiKey" :: Text) ]
1221− toJSON (SecuritySchemeOAuth2 params)
1222− = toJSON params
1223− <+> object [ "type" .= ("oauth2" :: 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+ ]
12241301
1225−instance ToJSON Swagger where
1302+instance ToJSON OpenApi where
12261303 toJSON a = sopSwaggerGenericToJSON a &
1227− if InsOrdHashMap.null (_swaggerPaths a)
1304+ if InsOrdHashMap.null (_openApiPaths a)
12281305 then (<+> object ["paths" .= object []])
12291306 else id
12301307 toEncoding = sopSwaggerGenericToEncoding
12311308
1232−instance ToJSON SecurityScheme where
1309+instance ToJSON Server where
12331310 toJSON = sopSwaggerGenericToJSON
12341311 toEncoding = sopSwaggerGenericToEncoding
12351312
1236−instance ToJSON Schema where
1313+instance ToJSON SecurityScheme where
12371314 toJSON = sopSwaggerGenericToJSON
12381315 toEncoding = sopSwaggerGenericToEncoding
12391316
1317+instance ToJSON Schema where
1318+ toJSON = sopSwaggerGenericToJSONWithOpts $
1319+ mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1320+
12401321instance ToJSON Header where
12411322 toJSON = sopSwaggerGenericToJSON
12421323 toEncoding = sopSwaggerGenericToEncoding
@@ -1244,31 +1325,26 @@ instance ToJSON Header where
12441325-- | As for nullary schema for 0-arity type constructors, see
12451326-- <https://github.com/GetShopTV/swagger2/issues/167>.
12461327--
1247−-- >>> encode (SwaggerItemsArray [])
1248−-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1328+-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1329+-- {
1330+-- "example": [],
1331+-- "items": {},
1332+-- "maxItems": 0
1333+-- }
12491334--
1250−instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
1251− toJSON (SwaggerItemsPrimitive fmt schema) = object
1252− [ "collectionFormat" .= fmt
1253− , "items" .= schema ]
1254− toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1255− toJSON (SwaggerItemsArray []) = object
1335+instance ToJSON OpenApiItems where
1336+ toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1337+ toJSON (OpenApiItemsArray []) = object
12561338 [ "items" .= object []
12571339 , "maxItems" .= (0 :: Int)
12581340 , "example" .= Array mempty
12591341 ]
1260− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1342+ toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
12611343
12621344instance ToJSON Components where
12631345 toJSON = sopSwaggerGenericToJSON
12641346 toEncoding = sopSwaggerGenericToEncoding
12651347
1266−instance ToJSON Host where
1267− toJSON (Host host mport) = toJSON $
1268− case mport of
1269− Nothing -> host
1270− Just port -> host ++ ":" ++ show port
1271−
12721348instance ToJSON MimeList where
12731349 toJSON (MimeList xs) = toJSON (map show xs)
12741350
@@ -1276,14 +1352,6 @@ instance ToJSON Param where
12761352 toJSON = sopSwaggerGenericToJSON
12771353 toEncoding = sopSwaggerGenericToEncoding
12781354
1279−instance ToJSON ParamAnySchema where
1280− toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1281− toJSON (ParamOther s) = toJSON s
1282−
1283−instance ToJSON ParamOtherSchema where
1284− toJSON = sopSwaggerGenericToJSON
1285− toEncoding = sopSwaggerGenericToEncoding
1286−
12871355instance ToJSON Responses where
12881356 toJSON = sopSwaggerGenericToJSON
12891357 toEncoding = sopSwaggerGenericToEncoding
@@ -1316,6 +1384,10 @@ instance ToJSON Encoding where
13161384 toJSON = sopSwaggerGenericToJSON
13171385 toEncoding = sopSwaggerGenericToEncoding
13181386
1387+instance ToJSON Link where
1388+ toJSON = sopSwaggerGenericToJSON
1389+ toEncoding = sopSwaggerGenericToEncoding
1390+
13191391instance ToJSON SecurityDefinitions where
13201392 toJSON (SecurityDefinitions sd) = toJSON sd
13211393
@@ -1332,64 +1404,57 @@ instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/compone
13321404instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
13331405instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
13341406instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1335−
1336−instance ToJSON (SwaggerType t) where
1337− toJSON SwaggerArray = "array"
1338− toJSON SwaggerString = "string"
1339− toJSON SwaggerInteger = "integer"
1340− toJSON SwaggerNumber = "number"
1341− toJSON SwaggerBoolean = "boolean"
1342− toJSON SwaggerFile = "file"
1343− toJSON SwaggerNull = "null"
1344− toJSON SwaggerObject = "object"
1345−
1346−instance ToJSON (CollectionFormat t) where
1347− toJSON CollectionCSV = "csv"
1348− toJSON CollectionSSV = "ssv"
1349− toJSON CollectionTSV = "tsv"
1350− toJSON CollectionPipes = "pipes"
1351− toJSON CollectionMulti = "multi"
1352−
1353−instance ToJSON (ParamSchema k) where
1354− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1355− toJSON = sopSwaggerGenericToJSONWithOpts $
1356− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1407+instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1408+instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
13571409
13581410instance ToJSON AdditionalProperties where
13591411 toJSON (AdditionalPropertiesAllowed b) = toJSON b
13601412 toJSON (AdditionalPropertiesSchema s) = toJSON s
13611413
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+
13621421-- =======================================================================
13631422-- Manual FromJSON instances
13641423-- =======================================================================
13651424
1366−instance FromJSON OAuth2Flow where
1367− parseJSON (Object o) = do
1368− (flow :: Text) <- o .: "flow"
1369− case flow of
1370− "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
1371− "password" -> OAuth2Password <$> o .: "tokenUrl"
1372− "application" -> OAuth2Application <$> o .: "tokenUrl"
1373− "accessCode" -> OAuth2AccessCode
1374− <$> o .: "authorizationUrl"
1375− <*> o .: "tokenUrl"
1376− _ -> empty
1377− parseJSON _ = empty
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)
13781431
1379−instance FromJSON OAuth2Params where
1432+instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1433+ parseJSON = sopSwaggerGenericParseJSON
1434+
1435+instance FromJSON OAuth2Flows where
13801436 parseJSON = sopSwaggerGenericParseJSON
13811437
13821438instance FromJSON SecuritySchemeType where
13831439 parseJSON js@(Object o) = do
13841440 (t :: Text) <- o .: "type"
13851441 case t of
1386− "http" -> pure SecuritySchemeHttp
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
13871448 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1388− "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
1449+ "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1450+ "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
13891451 _ -> empty
13901452 parseJSON _ = empty
13911453
1392−instance FromJSON Swagger where
1454+instance FromJSON OpenApi where
1455+ parseJSON = sopSwaggerGenericParseJSON
1456+
1457+instance FromJSON Server where
13931458 parseJSON = sopSwaggerGenericParseJSON
13941459
13951460instance FromJSON SecurityScheme where
@@ -1398,78 +1463,36 @@ instance FromJSON SecurityScheme where
13981463instance FromJSON Schema where
13991464 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
14001465 where nullaryCleanup :: Schema -> Schema
1401− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1402− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1466+ nullaryCleanup s =
1467+ if _schemaItems s == Just (OpenApiItemsArray [])
14031468 then s { _schemaExample = Nothing
1404− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1469+ , _schemaMaxItems = Nothing
1470+ }
14051471 else s
14061472
14071473instance FromJSON Header where
14081474 parseJSON = sopSwaggerGenericParseJSON
14091475
1410−instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1411− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1412− <$> o .:? "collectionFormat"
1413− <*> (o .: "items" >>= parseJSON)
1414−
1415−instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1416− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1417− <$> o .:? "collectionFormat"
1418− <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1419−
1420−-- |
1421−--
1422−-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1423−-- Just (SwaggerItemsArray [])
1424−--
1425−-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1426−-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1427−--
1428−-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1429−-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1430−--
1431−instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1476+instance FromJSON OpenApiItems where
14321477 parseJSON js@(Object obj)
1433− | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1434− | otherwise = SwaggerItemsObject <$> parseJSON js
1435− parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1478+ | null obj = pure $ OpenApiItemsArray [] -- Nullary schema.
1479+ | otherwise = OpenApiItemsObject <$> parseJSON js
1480+ parseJSON js@(Array _) = OpenApiItemsArray <$> parseJSON js
14361481 parseJSON _ = empty
14371482
14381483instance FromJSON Components where
14391484 parseJSON = sopSwaggerGenericParseJSON
14401485
1441−instance FromJSON Host where
1442− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1443− [host] -> return $ Host host Nothing
1444− [host, port] -> case readMaybe port of
1445− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1446− Just p -> return $ Host host (Just (fromInteger p))
1447− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1448− parseJSON _ = empty
1449−
14501486instance FromJSON MimeList where
1451− parseJSON js = (MimeList . map fromString) <$> parseJSON js
1487+ parseJSON js = MimeList . map fromString <$> parseJSON js
14521488
14531489instance FromJSON Param where
14541490 parseJSON = sopSwaggerGenericParseJSON
14551491
1456−instance FromJSON ParamAnySchema where
1457− parseJSON js@(Object o) = do
1458− (i :: Text) <- o .: "in"
1459− case i of
1460− "body" -> do
1461− schema <- o .: "schema"
1462− ParamBody <$> parseJSON schema
1463− _ -> ParamOther <$> parseJSON js
1464− parseJSON _ = empty
1465−
1466−instance FromJSON ParamOtherSchema where
1467− parseJSON = sopSwaggerGenericParseJSON
1468−
14691492instance FromJSON Responses where
14701493 parseJSON (Object o) = Responses
14711494 <$> o .:? "default"
1472− <*> (parseJSON (Object (HashMap.delete "default" o)))
1495+ <*> parseJSON (Object (deleteKey "default" o))
14731496 parseJSON _ = empty
14741497
14751498instance FromJSON Example where
@@ -1484,6 +1507,9 @@ instance FromJSON Operation where
14841507instance FromJSON PathItem where
14851508 parseJSON = sopSwaggerGenericParseJSON
14861509
1510+instance FromJSON SecurityDefinitions where
1511+ parseJSON js = SecurityDefinitions <$> parseJSON js
1512+
14871513instance FromJSON RequestBody where
14881514 parseJSON = sopSwaggerGenericParseJSON
14891515
@@ -1493,8 +1519,8 @@ instance FromJSON MediaTypeObject where
14931519instance FromJSON Encoding where
14941520 parseJSON = sopSwaggerGenericParseJSON
14951521
1496−instance FromJSON SecurityDefinitions where
1497− parseJSON js = SecurityDefinitions <$> parseJSON js
1522+instance FromJSON Link where
1523+ parseJSON = sopSwaggerGenericParseJSON
14981524
14991525instance FromJSON Reference where
15001526 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1519,52 +1545,38 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
15191545instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
15201546instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
15211547instance 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/"
15221550
15231551instance FromJSON Xml where
15241552 parseJSON = genericParseJSON (jsonPrefix "xml")
15251553
1526−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1527− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1528−
1529−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1530− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1531−
1532−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1533− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1534−
1535−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1536− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1537−
1538−-- NOTE: There aren't collections of 'Schema'
1539−--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1540−-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1541−
1542−instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1543− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1544−
1545−instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1546− parseJSON = sopSwaggerGenericParseJSON
1547−instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1548− parseJSON = sopSwaggerGenericParseJSON
1549−instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1550− parseJSON = sopSwaggerGenericParseJSON
1551−
15521554instance FromJSON AdditionalProperties where
15531555 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
15541556 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
15551557
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"
15561568instance HasSwaggerAesonOptions Components where
15571569 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
15581570instance HasSwaggerAesonOptions Header where
1559− swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1560−instance HasSwaggerAesonOptions OAuth2Params where
1561− swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
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"
15621576instance HasSwaggerAesonOptions Operation where
15631577 swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
15641578instance HasSwaggerAesonOptions Param where
1565− swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1566−instance HasSwaggerAesonOptions ParamOtherSchema where
1567− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1579+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param"
15681580instance HasSwaggerAesonOptions PathItem where
15691581 swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
15701582instance HasSwaggerAesonOptions Response where
@@ -1579,29 +1591,29 @@ instance HasSwaggerAesonOptions SecurityScheme where
15791591 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
15801592instance HasSwaggerAesonOptions Schema where
15811593 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1582−instance HasSwaggerAesonOptions Swagger where
1583− swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.3")]
1594+instance HasSwaggerAesonOptions OpenApi where
1595+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
15841596instance HasSwaggerAesonOptions Example where
15851597 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
15861598instance HasSwaggerAesonOptions Encoding where
15871599 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
15881600
1589−instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1590− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1591−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1592− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1593−-- NOTE: Schema doesn't have 'items' sub object!
1594−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1595− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1601+instance HasSwaggerAesonOptions Link where
1602+ swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
15961603
1604+instance AesonDefaultValue Server
15971605instance AesonDefaultValue Components
1598−instance AesonDefaultValue (ParamSchema s)
1599−instance AesonDefaultValue OAuth2Flow
1606+instance AesonDefaultValue OAuth2ImplicitFlow
1607+instance AesonDefaultValue OAuth2PasswordFlow
1608+instance AesonDefaultValue OAuth2ClientCredentialsFlow
1609+instance AesonDefaultValue OAuth2AuthorizationCodeFlow
1610+instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
16001611instance AesonDefaultValue Responses
1601−instance AesonDefaultValue ParamAnySchema
16021612instance AesonDefaultValue SecuritySchemeType
1603−instance AesonDefaultValue (SwaggerType a)
1613+instance AesonDefaultValue OpenApiType
16041614instance AesonDefaultValue MimeList where defaultValue = Just mempty
16051615instance AesonDefaultValue Info
16061616instance AesonDefaultValue ParamLocation
1607−instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty
1617+instance AesonDefaultValue Link
1618+instance AesonDefaultValue SecurityDefinitions where
1619+ defaultValue = Just mempty