@@ -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)
463+ -- | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
464+ -- Default value is @false@.
465+ , _paramDeprecated :: Maybe Bool
444466
445−data ParamAnySchema
446− = ParamBody (Referenced Schema)
447− | ParamOther ParamOtherSchema
448− deriving (Eq, Show, Generic, Data, Typeable)
449−
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
@@ -692,9 +638,33 @@ data Schema = Schema
692638 , _schemaMaxProperties :: Maybe Integer
693639 , _schemaMinProperties :: Maybe Integer
694640
695− , _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
696663 } deriving (Eq, Show, Generic, Data, Typeable)
697664
665+-- | Regex pattern for @string@ type.
666+type Pattern = Text
667+
698668data Discriminator = Discriminator
699669 { -- | The name of the property in the payload that will hold the discriminator value.
700670 _discriminatorPropertyName :: Text
@@ -710,41 +680,9 @@ data NamedSchema = NamedSchema
710680 , _namedSchemaSchema :: Schema
711681 } deriving (Eq, Show, Generic, Data, Typeable)
712682
713−-- | Regex pattern for @string@ type.
714−type Pattern = Text
715−
716−-- TODO examples for params
717−
718−data ParamSchema (t :: SwaggerKind *) = ParamSchema
719− { -- | Declares the value of the parameter that the server will use if none is provided,
720− -- for example a @"count"@ to control the number of results per page might default to @100@
721− -- if not supplied by the client in the request.
722− -- (Note: "default" has no meaning for required parameters.)
723− -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
724− _paramSchemaDefault :: Maybe Value
725−
726− , _paramSchemaType :: Maybe (SwaggerType t)
727− , _paramSchemaFormat :: Maybe Format
728− , _paramSchemaItems :: Maybe (SwaggerItems t)
729− , _paramSchemaMaximum :: Maybe Scientific
730− , _paramSchemaExclusiveMaximum :: Maybe Bool
731− , _paramSchemaMinimum :: Maybe Scientific
732− , _paramSchemaExclusiveMinimum :: Maybe Bool
733− , _paramSchemaMaxLength :: Maybe Integer
734− , _paramSchemaMinLength :: Maybe Integer
735− , _paramSchemaPattern :: Maybe Pattern
736− , _paramSchemaMaxItems :: Maybe Integer
737− , _paramSchemaMinItems :: Maybe Integer
738− , _paramSchemaUniqueItems :: Maybe Bool
739− , _paramSchemaEnum :: Maybe [Value]
740− , _paramSchemaMultipleOf :: Maybe Scientific
741− } deriving (Eq, Show, Generic, Typeable)
742−
743−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
744−
745683data Xml = Xml
746684 { -- | Replaces the name of the element/attribute used for the described schema property.
747− -- 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.
748686 -- When defined alongside type being array (outside the items),
749687 -- it will affect the wrapping element and only if wrapped is true.
750688 -- If wrapped is false, it will be ignored.
@@ -796,25 +734,46 @@ data Response = Response
796734 -- | A map containing descriptions of potential response payloads.
797735 -- The key is a media type or media type range and the value describes it.
798736 -- For responses that match multiple keys, only the most specific key is applicable.
799− -- e.g. @text/plain@ overrides @text/*@.
800− , _responseContent :: InsOrdHashMap Text MediaTypeObject
737+ -- e.g. @text/plain@ overrides @text/\*@.
738+ , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
801739
802740 -- | Maps a header name to its definition.
803741 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
804742
805− -- 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)
806747 } deriving (Eq, Show, Generic, Data, Typeable)
807748
808749instance IsString Response where
809− 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)
810759
811760type HeaderName = Text
812761
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.
813765data Header = Header
814766 { -- | A short description of the header.
815− _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)
816775
817− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
776+ , _headerSchema :: Maybe (Referenced Schema)
818777 } deriving (Eq, Show, Generic, Data, Typeable)
819778
820779-- | The location of the API key.
@@ -838,17 +797,17 @@ type AuthorizationURL = Text
838797-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
839798type TokenURL = Text
840799
841−data OAuth2ImplicitFlow = OAuth2ImplicitFlow
842− { _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL
843− } deriving (Eq, Show, Generic, Data, Typeable)
800+newtype OAuth2ImplicitFlow
801+ = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
802+ deriving (Eq, Show, Generic, Data, Typeable)
844803
845−data OAuth2PasswordFlow = OAuth2PasswordFlow
846− { _oAuth2PasswordFlowTokenUrl :: TokenURL
847− } deriving (Eq, Show, Generic, Data, Typeable)
804+newtype OAuth2PasswordFlow
805+ = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
806+ deriving (Eq, Show, Generic, Data, Typeable)
848807
849−data OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow
850− { _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL
851− } deriving (Eq, Show, Generic, Data, Typeable)
808+newtype OAuth2ClientCredentialsFlow
809+ = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
810+ deriving (Eq, Show, Generic, Data, Typeable)
852811
853812data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
854813 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
@@ -881,8 +840,50 @@ data OAuth2Flows = OAuth2Flows
881840 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
882841 } deriving (Eq, Show, Generic, Data, Typeable)
883842
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+--
884885data SecuritySchemeType
885− = SecuritySchemeHttp
886+ = SecuritySchemeHttp HttpSchemeType
886887 | SecuritySchemeApiKey ApiKeyParams
887888 | SecuritySchemeOAuth2 OAuth2Flows
888889 | SecuritySchemeOpenIdConnect URL
@@ -896,6 +897,10 @@ data SecurityScheme = SecurityScheme
896897 , _securitySchemeDescription :: Maybe Text
897898 } deriving (Eq, Show, Generic, Data, Typeable)
898899
900+newtype SecurityDefinitions
901+ = SecurityDefinitions (Definitions SecurityScheme)
902+ deriving (Eq, Show, Generic, Data, Typeable)
903+
899904-- | Lists the required security schemes to execute this operation.
900905-- The object can have multiple security schemes declared in it which are all required
901906-- (that is, there is a logical AND between the schemes).
@@ -913,7 +918,7 @@ data Tag = Tag
913918 _tagName :: TagName
914919
915920 -- | A short description for the tag.
916− -- GFM syntax can be used for rich text representation.
921+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
917922 , _tagDescription :: Maybe Text
918923
919924 -- | Additional external documentation for this tag.
@@ -928,7 +933,7 @@ instance IsString Tag where
928933-- | Allows referencing an external resource for extended documentation.
929934data ExternalDocs = ExternalDocs
930935 { -- | A short description of the target documentation.
931− -- GFM syntax can be used for rich text representation.
936+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
932937 _externalDocsDescription :: Maybe Text
933938
934939 -- | The URL for the target documentation.
@@ -961,13 +966,13 @@ data AdditionalProperties
961966-- Generic instances
962967-------------------------------------------------------------------------------
963968
969+deriveGeneric ''Server
964970deriveGeneric ''Components
965971deriveGeneric ''Header
966972deriveGeneric ''OAuth2Flow
967973deriveGeneric ''OAuth2Flows
968974deriveGeneric ''Operation
969975deriveGeneric ''Param
970−deriveGeneric ''ParamOtherSchema
971976deriveGeneric ''PathItem
972977deriveGeneric ''Response
973978deriveGeneric ''RequestBody
@@ -975,18 +980,18 @@ deriveGeneric ''MediaTypeObject
975980deriveGeneric ''Responses
976981deriveGeneric ''SecurityScheme
977982deriveGeneric ''Schema
978−deriveGeneric ''ParamSchema
979−deriveGeneric ''Swagger
983+deriveGeneric ''OpenApi
980984deriveGeneric ''Example
981985deriveGeneric ''Encoding
986+deriveGeneric ''Link
982987
983988-- =======================================================================
984989-- Monoid instances
985990-- =======================================================================
986991
987−instance Semigroup Swagger where
992+instance Semigroup OpenApi where
988993 (<>) = genericMappend
989−instance Monoid Swagger where
994+instance Monoid OpenApi where
990995 mempty = genericMempty
991996 mappend = (<>)
992997
@@ -1020,24 +1025,12 @@ instance Monoid Schema where
10201025 mempty = genericMempty
10211026 mappend = (<>)
10221027
1023−instance Semigroup (ParamSchema t) where
1024− (<>) = genericMappend
1025−instance Monoid (ParamSchema t) where
1026− mempty = genericMempty
1027− mappend = (<>)
1028−
10291028instance Semigroup Param where
10301029 (<>) = genericMappend
10311030instance Monoid Param where
10321031 mempty = genericMempty
10331032 mappend = (<>)
10341033
1035−instance Semigroup ParamOtherSchema where
1036− (<>) = genericMappend
1037−instance Monoid ParamOtherSchema where
1038− mempty = genericMempty
1039− mappend = (<>)
1040−
10411034instance Semigroup Header where
10421035 (<>) = genericMappend
10431036instance Monoid Header where
@@ -1080,12 +1073,44 @@ instance Monoid Operation where
10801073 mempty = genericMempty
10811074 mappend = (<>)
10821075
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.
10831082instance Semigroup OAuth2Flows where
1084− (<>) = genericMappend
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+
10851090instance Monoid OAuth2Flows where
10861091 mempty = genericMempty
10871092 mappend = (<>)
10881093
1094+instance Semigroup SecurityScheme where
1095+ SecurityScheme (SecuritySchemeOAuth2 lFlows) lDesc
1096+ <> SecurityScheme (SecuritySchemeOAuth2 rFlows) rDesc =
1097+ SecurityScheme (SecuritySchemeOAuth2 $ lFlows <> rFlows) (swaggerMappend lDesc rDesc)
1098+ l <> _ = l
1099+
1100+instance Semigroup SecurityDefinitions where
1101+ (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
1102+ SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
1103+
1104+instance Monoid SecurityDefinitions where
1105+ mempty = SecurityDefinitions InsOrdHashMap.empty
1106+ mappend = (<>)
1107+
1108+instance Semigroup RequestBody where
1109+ (<>) = genericMappend
1110+instance Monoid RequestBody where
1111+ mempty = genericMempty
1112+ mappend = (<>)
1113+
10891114-- =======================================================================
10901115-- SwaggerMonoid helper instances
10911116-- =======================================================================
@@ -1094,20 +1119,19 @@ instance SwaggerMonoid Info
10941119instance SwaggerMonoid Components
10951120instance SwaggerMonoid PathItem
10961121instance SwaggerMonoid Schema
1097−instance SwaggerMonoid (ParamSchema t)
10981122instance SwaggerMonoid Param
1099−instance SwaggerMonoid ParamOtherSchema
11001123instance SwaggerMonoid Responses
11011124instance SwaggerMonoid Response
11021125instance SwaggerMonoid ExternalDocs
11031126instance SwaggerMonoid Operation
11041127instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1128+instance SwaggerMonoid SecurityDefinitions
11051129
11061130instance SwaggerMonoid MimeList
11071131deriving instance SwaggerMonoid URL
11081132
1109−instance SwaggerMonoid (SwaggerType t) where
1110− swaggerMempty = SwaggerString
1133+instance SwaggerMonoid OpenApiType where
1134+ swaggerMempty = OpenApiString
11111135 swaggerMappend _ y = y
11121136
11131137instance SwaggerMonoid ParamLocation where
@@ -1123,16 +1147,16 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
11231147 swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
11241148 swaggerMappend _ y = y
11251149
1126−instance SwaggerMonoid ParamAnySchema where
1127− swaggerMempty = ParamOther swaggerMempty
1128− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
1129− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
1130− swaggerMappend _ y = y
1131−
11321150-- =======================================================================
11331151-- Simple Generic-based ToJSON instances
11341152-- =======================================================================
11351153
1154+instance ToJSON Style where
1155+ toJSON = genericToJSON (jsonPrefix "Style")
1156+
1157+instance ToJSON OpenApiType where
1158+ toJSON = genericToJSON (jsonPrefix "Swagger")
1159+
11361160instance ToJSON ParamLocation where
11371161 toJSON = genericToJSON (jsonPrefix "Param")
11381162
@@ -1145,9 +1169,6 @@ instance ToJSON Contact where
11451169instance ToJSON License where
11461170 toJSON = genericToJSON (jsonPrefix "License")
11471171
1148−instance ToJSON Server where
1149− toJSON = genericToJSON (jsonPrefix "Server")
1150−
11511172instance ToJSON ServerVariable where
11521173 toJSON = genericToJSON (jsonPrefix "ServerVariable")
11531174
@@ -1157,9 +1178,6 @@ instance ToJSON ApiKeyLocation where
11571178instance ToJSON ApiKeyParams where
11581179 toJSON = genericToJSON (jsonPrefix "apiKey")
11591180
1160−instance ToJSON Scheme where
1161− toJSON = genericToJSON (jsonPrefix "")
1162−
11631181instance ToJSON Tag where
11641182 toJSON = genericToJSON (jsonPrefix "Tag")
11651183
@@ -1188,6 +1206,12 @@ instance ToJSON OAuth2AuthorizationCodeFlow where
11881206-- Simple Generic-based FromJSON instances
11891207-- =======================================================================
11901208
1209+instance FromJSON Style where
1210+ parseJSON = genericParseJSON (jsonPrefix "Style")
1211+
1212+instance FromJSON OpenApiType where
1213+ parseJSON = genericParseJSON (jsonPrefix "Swagger")
1214+
11911215instance FromJSON ParamLocation where
11921216 parseJSON = genericParseJSON (jsonPrefix "Param")
11931217
@@ -1200,9 +1224,6 @@ instance FromJSON Contact where
12001224instance FromJSON License where
12011225 parseJSON = genericParseJSON (jsonPrefix "License")
12021226
1203−instance FromJSON Server where
1204− parseJSON = genericParseJSON (jsonPrefix "Server")
1205−
12061227instance FromJSON ServerVariable where
12071228 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
12081229
@@ -1212,9 +1233,6 @@ instance FromJSON ApiKeyLocation where
12121233instance FromJSON ApiKeyParams where
12131234 parseJSON = genericParseJSON (jsonPrefix "apiKey")
12141235
1215−instance FromJSON Scheme where
1216− parseJSON = genericParseJSON (jsonPrefix "")
1217−
12181236instance FromJSON Tag where
12191237 parseJSON = genericParseJSON (jsonPrefix "Tag")
12201238
@@ -1240,7 +1258,14 @@ instance FromJSON OAuth2AuthorizationCodeFlow where
12401258-- Manual ToJSON instances
12411259-- =======================================================================
12421260
1243−instance (Eq p, ToJSON p, AesonDefaultValue p) =>ToJSON (OAuth2Flow p) 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
12441269 toJSON = sopSwaggerGenericToJSON
12451270 toEncoding = sopSwaggerGenericToEncoding
12461271
@@ -1249,34 +1274,50 @@ instance ToJSON OAuth2Flows where
12491274 toEncoding = sopSwaggerGenericToEncoding
12501275
12511276instance ToJSON SecuritySchemeType where
1252− toJSON SecuritySchemeHttp
1253− = 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+ ]
12541290 toJSON (SecuritySchemeApiKey params)
12551291 = toJSON params
12561292 <+> object [ "type" .= ("apiKey" :: Text) ]
1257− toJSON (SecuritySchemeOAuth2 params)
1258− = toJSON params
1259− <+> object [ "type" .= ("oauth2" :: Text) ]
1293+ toJSON (SecuritySchemeOAuth2 params) = object
1294+ [ "type" .= ("oauth2" :: Text)
1295+ , "flows" .= toJSON params
1296+ ]
12601297 toJSON (SecuritySchemeOpenIdConnect url) = object
12611298 [ "type" .= ("openIdConnect" :: Text)
12621299 , "openIdConnectUrl" .= url
12631300 ]
12641301
1265−instance ToJSON Swagger where
1302+instance ToJSON OpenApi where
12661303 toJSON a = sopSwaggerGenericToJSON a &
1267− if InsOrdHashMap.null (_swaggerPaths a)
1304+ if InsOrdHashMap.null (_openApiPaths a)
12681305 then (<+> object ["paths" .= object []])
12691306 else id
12701307 toEncoding = sopSwaggerGenericToEncoding
12711308
1272−instance ToJSON SecurityScheme where
1309+instance ToJSON Server where
12731310 toJSON = sopSwaggerGenericToJSON
12741311 toEncoding = sopSwaggerGenericToEncoding
12751312
1276−instance ToJSON Schema where
1313+instance ToJSON SecurityScheme where
12771314 toJSON = sopSwaggerGenericToJSON
12781315 toEncoding = sopSwaggerGenericToEncoding
12791316
1317+instance ToJSON Schema where
1318+ toJSON = sopSwaggerGenericToJSONWithOpts $
1319+ mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1320+
12801321instance ToJSON Header where
12811322 toJSON = sopSwaggerGenericToJSON
12821323 toEncoding = sopSwaggerGenericToEncoding
@@ -1284,31 +1325,26 @@ instance ToJSON Header where
12841325-- | As for nullary schema for 0-arity type constructors, see
12851326-- <https://github.com/GetShopTV/swagger2/issues/167>.
12861327--
1287−-- >>> encode (SwaggerItemsArray [])
1288−-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1328+-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1329+-- {
1330+-- "example": [],
1331+-- "items": {},
1332+-- "maxItems": 0
1333+-- }
12891334--
1290−instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
1291− toJSON (SwaggerItemsPrimitive fmt schema) = object
1292− [ "collectionFormat" .= fmt
1293− , "items" .= schema ]
1294− toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1295− toJSON (SwaggerItemsArray []) = object
1335+instance ToJSON OpenApiItems where
1336+ toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1337+ toJSON (OpenApiItemsArray []) = object
12961338 [ "items" .= object []
12971339 , "maxItems" .= (0 :: Int)
12981340 , "example" .= Array mempty
12991341 ]
1300− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1342+ toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
13011343
13021344instance ToJSON Components where
13031345 toJSON = sopSwaggerGenericToJSON
13041346 toEncoding = sopSwaggerGenericToEncoding
13051347
1306−instance ToJSON Host where
1307− toJSON (Host host mport) = toJSON $
1308− case mport of
1309− Nothing -> host
1310− Just port -> host ++ ":" ++ show port
1311−
13121348instance ToJSON MimeList where
13131349 toJSON (MimeList xs) = toJSON (map show xs)
13141350
@@ -1316,14 +1352,6 @@ instance ToJSON Param where
13161352 toJSON = sopSwaggerGenericToJSON
13171353 toEncoding = sopSwaggerGenericToEncoding
13181354
1319−instance ToJSON ParamAnySchema where
1320− toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1321− toJSON (ParamOther s) = toJSON s
1322−
1323−instance ToJSON ParamOtherSchema where
1324− toJSON = sopSwaggerGenericToJSON
1325− toEncoding = sopSwaggerGenericToEncoding
1326−
13271355instance ToJSON Responses where
13281356 toJSON = sopSwaggerGenericToJSON
13291357 toEncoding = sopSwaggerGenericToEncoding
@@ -1356,6 +1384,13 @@ instance ToJSON Encoding where
13561384 toJSON = sopSwaggerGenericToJSON
13571385 toEncoding = sopSwaggerGenericToEncoding
13581386
1387+instance ToJSON Link where
1388+ toJSON = sopSwaggerGenericToJSON
1389+ toEncoding = sopSwaggerGenericToEncoding
1390+
1391+instance ToJSON SecurityDefinitions where
1392+ toJSON (SecurityDefinitions sd) = toJSON sd
1393+
13591394instance ToJSON Reference where
13601395 toJSON (Reference ref) = object [ "$ref" .= ref ]
13611396
@@ -1369,37 +1404,31 @@ instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/compone
13691404instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
13701405instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
13711406instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1372−
1373−instance ToJSON (SwaggerType t) where
1374− toJSON SwaggerArray = "array"
1375− toJSON SwaggerString = "string"
1376− toJSON SwaggerInteger = "integer"
1377− toJSON SwaggerNumber = "number"
1378− toJSON SwaggerBoolean = "boolean"
1379− toJSON SwaggerFile = "file"
1380− toJSON SwaggerNull = "null"
1381− toJSON SwaggerObject = "object"
1382−
1383−instance ToJSON (CollectionFormat t) where
1384− toJSON CollectionCSV = "csv"
1385− toJSON CollectionSSV = "ssv"
1386− toJSON CollectionTSV = "tsv"
1387− toJSON CollectionPipes = "pipes"
1388− toJSON CollectionMulti = "multi"
1389−
1390−instance ToJSON (ParamSchema k) where
1391− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1392− toJSON = sopSwaggerGenericToJSONWithOpts $
1393− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1407+instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1408+instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
13941409
13951410instance ToJSON AdditionalProperties where
13961411 toJSON (AdditionalPropertiesAllowed b) = toJSON b
13971412 toJSON (AdditionalPropertiesSchema s) = toJSON s
13981413
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+
13991421-- =======================================================================
14001422-- Manual FromJSON instances
14011423-- =======================================================================
14021424
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+
14031432instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
14041433 parseJSON = sopSwaggerGenericParseJSON
14051434
@@ -1410,14 +1439,22 @@ instance FromJSON SecuritySchemeType where
14101439 parseJSON js@(Object o) = do
14111440 (t :: Text) <- o .: "type"
14121441 case t of
1413− "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
14141448 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1415− "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
1449+ "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
14161450 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
14171451 _ -> empty
14181452 parseJSON _ = empty
14191453
1420−instance FromJSON Swagger where
1454+instance FromJSON OpenApi where
1455+ parseJSON = sopSwaggerGenericParseJSON
1456+
1457+instance FromJSON Server where
14211458 parseJSON = sopSwaggerGenericParseJSON
14221459
14231460instance FromJSON SecurityScheme where
@@ -1426,78 +1463,36 @@ instance FromJSON SecurityScheme where
14261463instance FromJSON Schema where
14271464 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
14281465 where nullaryCleanup :: Schema -> Schema
1429− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1430− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1466+ nullaryCleanup s =
1467+ if _schemaItems s == Just (OpenApiItemsArray [])
14311468 then s { _schemaExample = Nothing
1432− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1469+ , _schemaMaxItems = Nothing
1470+ }
14331471 else s
14341472
14351473instance FromJSON Header where
14361474 parseJSON = sopSwaggerGenericParseJSON
14371475
1438−instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1439− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1440− <$> o .:? "collectionFormat"
1441− <*> (o .: "items" >>= parseJSON)
1442−
1443−instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1444− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1445− <$> o .:? "collectionFormat"
1446− <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1447−
1448−-- |
1449−--
1450−-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1451−-- Just (SwaggerItemsArray [])
1452−--
1453−-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1454−-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1455−--
1456−-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1457−-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1458−--
1459−instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1476+instance FromJSON OpenApiItems where
14601477 parseJSON js@(Object obj)
1461− | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1462− | otherwise = SwaggerItemsObject <$> parseJSON js
1463− 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
14641481 parseJSON _ = empty
14651482
14661483instance FromJSON Components where
14671484 parseJSON = sopSwaggerGenericParseJSON
14681485
1469−instance FromJSON Host where
1470− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1471− [host] -> return $ Host host Nothing
1472− [host, port] -> case readMaybe port of
1473− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1474− Just p -> return $ Host host (Just (fromInteger p))
1475− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1476− parseJSON _ = empty
1477−
14781486instance FromJSON MimeList where
1479− parseJSON js = (MimeList . map fromString) <$> parseJSON js
1487+ parseJSON js = MimeList . map fromString <$> parseJSON js
14801488
14811489instance FromJSON Param where
14821490 parseJSON = sopSwaggerGenericParseJSON
14831491
1484−instance FromJSON ParamAnySchema where
1485− parseJSON js@(Object o) = do
1486− (i :: Text) <- o .: "in"
1487− case i of
1488− "body" -> do
1489− schema <- o .: "schema"
1490− ParamBody <$> parseJSON schema
1491− _ -> ParamOther <$> parseJSON js
1492− parseJSON _ = empty
1493−
1494−instance FromJSON ParamOtherSchema where
1495− parseJSON = sopSwaggerGenericParseJSON
1496−
14971492instance FromJSON Responses where
14981493 parseJSON (Object o) = Responses
14991494 <$> o .:? "default"
1500− <*> (parseJSON (Object (HashMap.delete "default" o)))
1495+ <*> parseJSON (Object (deleteKey "default" o))
15011496 parseJSON _ = empty
15021497
15031498instance FromJSON Example where
@@ -1512,6 +1507,9 @@ instance FromJSON Operation where
15121507instance FromJSON PathItem where
15131508 parseJSON = sopSwaggerGenericParseJSON
15141509
1510+instance FromJSON SecurityDefinitions where
1511+ parseJSON js = SecurityDefinitions <$> parseJSON js
1512+
15151513instance FromJSON RequestBody where
15161514 parseJSON = sopSwaggerGenericParseJSON
15171515
@@ -1521,6 +1519,9 @@ instance FromJSON MediaTypeObject where
15211519instance FromJSON Encoding where
15221520 parseJSON = sopSwaggerGenericParseJSON
15231521
1522+instance FromJSON Link where
1523+ parseJSON = sopSwaggerGenericParseJSON
1524+
15241525instance FromJSON Reference where
15251526 parseJSON (Object o) = Reference <$> o .: "$ref"
15261527 parseJSON _ = empty
@@ -1544,44 +1545,30 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
15441545instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
15451546instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
15461547instance 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/"
15471550
15481551instance FromJSON Xml where
15491552 parseJSON = genericParseJSON (jsonPrefix "xml")
15501553
1551−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1552− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1553−
1554−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1555− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1556−
1557−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1558− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1559−
1560−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1561− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1562−
1563−-- NOTE: There aren't collections of 'Schema'
1564−--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1565−-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1566−
1567−instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1568− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1569−
1570−instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1571− parseJSON = sopSwaggerGenericParseJSON
1572−instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1573− parseJSON = sopSwaggerGenericParseJSON
1574−instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1575− parseJSON = sopSwaggerGenericParseJSON
1576−
15771554instance FromJSON AdditionalProperties where
15781555 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
15791556 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
15801557
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"
15811568instance HasSwaggerAesonOptions Components where
15821569 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
15831570instance HasSwaggerAesonOptions Header where
1584− swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1571+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header"
15851572instance AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) where
15861573 swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "params"
15871574instance HasSwaggerAesonOptions OAuth2Flows where
@@ -1589,9 +1576,7 @@ instance HasSwaggerAesonOptions OAuth2Flows where
15891576instance HasSwaggerAesonOptions Operation where
15901577 swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
15911578instance HasSwaggerAesonOptions Param where
1592− swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1593−instance HasSwaggerAesonOptions ParamOtherSchema where
1594− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1579+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param"
15951580instance HasSwaggerAesonOptions PathItem where
15961581 swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
15971582instance HasSwaggerAesonOptions Response where
@@ -1606,32 +1591,29 @@ instance HasSwaggerAesonOptions SecurityScheme where
16061591 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
16071592instance HasSwaggerAesonOptions Schema where
16081593 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1609−instance HasSwaggerAesonOptions Swagger where
1610− swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.3")]
1594+instance HasSwaggerAesonOptions OpenApi where
1595+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
16111596instance HasSwaggerAesonOptions Example where
16121597 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
16131598instance HasSwaggerAesonOptions Encoding where
16141599 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
16151600
1616−instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1617− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1618−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1619− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1620−-- NOTE: Schema doesn't have 'items' sub object!
1621−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1622− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1601+instance HasSwaggerAesonOptions Link where
1602+ swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
16231603
1604+instance AesonDefaultValue Server
16241605instance AesonDefaultValue Components
1625−instance AesonDefaultValue (ParamSchema s)
16261606instance AesonDefaultValue OAuth2ImplicitFlow
16271607instance AesonDefaultValue OAuth2PasswordFlow
16281608instance AesonDefaultValue OAuth2ClientCredentialsFlow
16291609instance AesonDefaultValue OAuth2AuthorizationCodeFlow
16301610instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
16311611instance AesonDefaultValue Responses
1632−instance AesonDefaultValue ParamAnySchema
16331612instance AesonDefaultValue SecuritySchemeType
1634−instance AesonDefaultValue (SwaggerType a)
1613+instance AesonDefaultValue OpenApiType
16351614instance AesonDefaultValue MimeList where defaultValue = Just mempty
16361615instance AesonDefaultValue Info
16371616instance AesonDefaultValue ParamLocation
1617+instance AesonDefaultValue Link
1618+instance AesonDefaultValue SecurityDefinitions where
1619+ defaultValue = Just mempty