@@ -1,6 +1,6 @@
1{-# LANGUAGE DataKinds #-}
2{-# LANGUAGE DataKinds #-}
2{-# LANGUAGE DeriveDataTypeable #-}
3{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4{-# LANGUAGE DeriveGeneric #-}
4{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveTraversable #-}
5{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleContexts #-}
@@ -14,87 +14,91 @@
14{-# LANGUAGE TemplateHaskell #-}
14{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE UndecidableInstances #-}
16{-# LANGUAGE UndecidableInstances #-}
17−module Data.Swagger.Internal where
17+module Data.OpenApi.Internal where
19import Prelude ()
19import Prelude ()
20import Prelude.Compat
20import Prelude.Compat
22−import Control.Lens ((&), (.~), (?~))
23import Control.Applicative
22import Control.Applicative
23+import Control.Lens ((&), (.~), (?~))
24−import Data.Aeson hiding (Encoding)
24+import Data.Aeson hiding (Encoding)
25+#if MIN_VERSION_aeson(2,0,0)
26+import qualified Data.Aeson.KeyMap as KeyMap
25−import qualified Data.Aeson.Types as JSON
28+import qualified Data.Aeson.Types as JSON
26−import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
29+import Data.Data (Constr, Data (..), DataType, Fixity (..), Typeable,
30+ constrIndex, mkConstr, mkDataType)
27−import Data.Hashable (Hashable)
31+import Data.Hashable (Hashable (..))
28−import qualified Data.HashMap.Strict as HashMap
32+import qualified Data.HashMap.Strict as HashMap
29−import Data.HashSet.InsOrd (InsOrdHashSet)
33+import Data.HashSet.InsOrd (InsOrdHashSet)
30−import Data.Map (Map)
34+import Data.Map (Map)
31−import qualified Data.Map as Map
35+import qualified Data.Map as Map
32−import Data.Monoid (Monoid (..))
36+import Data.Monoid (Monoid (..))
37+import Data.Scientific (Scientific)
33−import Data.Semigroup.Compat (Semigroup (..))
38+import Data.Semigroup.Compat (Semigroup (..))
34−import Data.Scientific (Scientific)
35−import Data.String (IsString(..))
39+import Data.String (IsString (..))
36−import Data.Text (Text)
40+import Data.Text (Text)
37−import qualified Data.Text as Text
41+import qualified Data.Text as Text
42+import Data.Text.Encoding (encodeUtf8)
38−import GHC.Generics (Generic)
43+import GHC.Generics (Generic)
44+import Network.HTTP.Media (MediaType, mainType, parameters, parseAccept, subType, (//),
39−import Network.Socket (HostName, PortNumber)
46+import Network.Socket (HostName, PortNumber)
40−import Network.HTTP.Media (MediaType)
41−import Text.Read (readMaybe)
47+import Text.Read (readMaybe)
43import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
44import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
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
46import Generics.SOP.TH (deriveGeneric)
58import Generics.SOP.TH (deriveGeneric)
47−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
48− ,sopSwaggerGenericToJSONWithOpts
49− ,sopSwaggerGenericParseJSON
50− ,HasSwaggerAesonOptions(..)
51− ,AesonDefaultValue(..)
52− ,mkSwaggerAesonOptions
55−import Data.Swagger.Internal.Utils
56−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
59-- >>> :seti -XDataKinds
61-- >>> :seti -XDataKinds
60-- >>> import Data.Aeson
62-- >>> import Data.Aeson
63+-- >>> import Data.ByteString.Lazy.Char8 as BSL
64+-- >>> import Data.OpenApi.Internal.Utils
62-- | A list of definitions that can be used in references.
66-- | A list of definitions that can be used in references.
63type Definitions = InsOrdHashMap Text
67type Definitions = InsOrdHashMap Text
65-- | This is the root document object for the API specification.
69-- | This is the root document object for the API specification.
66−data Swagger = Swagger
70+data OpenApi = OpenApi
67 { -- | Provides metadata about the API.
71 { -- | Provides metadata about the API.
68 -- The metadata can be used by the clients if needed.
72 -- The metadata can be used by the clients if needed.
69− _swaggerInfo :: Info
73+ _openApiInfo :: Info
71 -- | An array of Server Objects, which provide connectivity information
75 -- | An array of Server Objects, which provide connectivity information
72 -- to a target server. If the servers property is not provided, or is an empty array,
76 -- to a target server. If the servers property is not provided, or is an empty array,
73 -- the default value would be a 'Server' object with a url value of @/@.
77 -- the default value would be a 'Server' object with a url value of @/@.
74− , _swaggerServers :: [Server]
78+ , _openApiServers :: [Server]
76 -- | The available paths and operations for the API.
80 -- | The available paths and operations for the API.
77− , _swaggerPaths :: InsOrdHashMap FilePath PathItem
81+ , _openApiPaths :: InsOrdHashMap FilePath PathItem
79 -- | An element to hold various schemas for the specification.
83 -- | An element to hold various schemas for the specification.
80− , _swaggerComponents :: Components
84+ , _openApiComponents :: Components
82 -- | A declaration of which security mechanisms can be used across the API.
86 -- | A declaration of which security mechanisms can be used across the API.
83 -- The list of values includes alternative security requirement objects that can be used.
87 -- The list of values includes alternative security requirement objects that can be used.
84 -- Only one of the security requirement objects need to be satisfied to authorize a request.
88 -- Only one of the security requirement objects need to be satisfied to authorize a request.
85 -- Individual operations can override this definition.
89 -- Individual operations can override this definition.
86 -- To make security optional, an empty security requirement can be included in the array.
90 -- To make security optional, an empty security requirement can be included in the array.
87− , _swaggerSecurity :: [SecurityRequirement]
91+ , _openApiSecurity :: [SecurityRequirement]
89 -- | A list of tags used by the specification with additional metadata.
93 -- | A list of tags used by the specification with additional metadata.
90 -- The order of the tags can be used to reflect on their order by the parsing tools.
94 -- The order of the tags can be used to reflect on their order by the parsing tools.
91 -- Not all tags that are used by the 'Operation' Object must be declared.
95 -- Not all tags that are used by the 'Operation' Object must be declared.
92 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
96 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
93 -- Each tag name in the list MUST be unique.
97 -- Each tag name in the list MUST be unique.
94− , _swaggerTags :: InsOrdHashSet Tag
98+ , _openApiTags :: InsOrdHashSet Tag
96 -- | Additional external documentation.
100 -- | Additional external documentation.
97− , _swaggerExternalDocs :: Maybe ExternalDocs
101+ , _openApiExternalDocs :: Maybe ExternalDocs
98 } deriving (Eq, Show, Generic, Data, Typeable)
102 } deriving (Eq, Show, Generic, Data, Typeable)
100-- | The object provides metadata about the API.
104-- | The object provides metadata about the API.
@@ -191,10 +195,10 @@ data Components = Components
191 , _componentsParameters :: Definitions Param
195 , _componentsParameters :: Definitions Param
192 , _componentsExamples :: Definitions Example
196 , _componentsExamples :: Definitions Example
193 , _componentsRequestBodies :: Definitions RequestBody
197 , _componentsRequestBodies :: Definitions RequestBody
194− , _componentsHeader :: Definitions Header
198+ , _componentsHeaders :: Definitions Header
195− , _componentsSecuritySchemes :: Definitions SecurityScheme
199+ , _componentsSecuritySchemes :: SecurityDefinitions
196−-- , _componentsLinks
200+ , _componentsLinks :: Definitions Link
197−-- , _componentsCallbacks
201+ , _componentsCallbacks :: Definitions Callback
198 } deriving (Eq, Show, Generic, Data, Typeable)
202 } deriving (Eq, Show, Generic, Data, Typeable)
200-- | Describes the operations available on a single path.
204-- | Describes the operations available on a single path.
@@ -284,7 +288,11 @@ data Operation = Operation
284 -- | The list of possible responses as they are returned from executing this operation.
288 -- | The list of possible responses as they are returned from executing this operation.
285 , _operationResponses :: Responses
289 , _operationResponses :: Responses
287− -- 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)
289 -- | Declares this operation to be deprecated.
297 -- | Declares this operation to be deprecated.
290 -- Usage of the declared operation should be refrained.
298 -- Usage of the declared operation should be refrained.
@@ -304,6 +312,22 @@ data Operation = Operation
304 , _operationServers :: [Server]
312 , _operationServers :: [Server]
305 } deriving (Eq, Show, Generic, Data, Typeable)
313 } deriving (Eq, Show, Generic, Data, Typeable)
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."
321+ toConstr _ = mediaTypeConstr
323+ dataTypeOf _ = mediaTypeData
325+mediaTypeConstr = mkConstr mediaTypeData "MediaType" [] Prefix
326+mediaTypeData = mkDataType "MediaType" [mediaTypeConstr]
328+instance Hashable MediaType where
329+ hashWithSalt salt mt = salt `hashWithSalt` show mt
307-- | Describes a single request body.
331-- | Describes a single request body.
308data RequestBody = RequestBody
332data RequestBody = RequestBody
309 { -- | A brief description of the request body. This could contain examples of use.
333 { -- | A brief description of the request body. This could contain examples of use.
@@ -313,9 +337,11 @@ data RequestBody = RequestBody
313 -- | The content of the request body.
337 -- | The content of the request body.
314 -- The key is a media type or media type range and the value describes it.
338 -- The key is a media type or media type range and the value describes it.
315 -- For requests that match multiple keys, only the most specific key is applicable.
339 -- For requests that match multiple keys, only the most specific key is applicable.
316− -- e.g. @text/plain@ overrides @text/*@
340+ -- e.g. @text/plain@ overrides @text/\*@
317− , _requestBodyContent :: InsOrdHashMap {-MediaType-} Text MediaTypeObject -- FIXME Data MediaType
341+ , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
343+ -- | Determines if the request body is required in the request.
344+ -- Defaults to 'False'.
319 , _requestBodyRequired :: Maybe Bool
345 , _requestBodyRequired :: Maybe Bool
320 } deriving (Eq, Show, Generic, Data, Typeable)
346 } deriving (Eq, Show, Generic, Data, Typeable)
@@ -368,8 +394,8 @@ data Encoding = Encoding
368 -- for other primitive types – @text/plain@; for object - @application/json@;
394 -- for other primitive types – @text/plain@; for object - @application/json@;
369 -- for array – the default is defined based on the inner type.
395 -- for array – the default is defined based on the inner type.
370 -- The value can be a specific media type (e.g. @application/json@),
396 -- The value can be a specific media type (e.g. @application/json@),
371− -- a wildcard media type (e.g. @image/*@), or a comma-separated list of the two types.
397+ -- a wildcard media type (e.g. @image/\*@), or a comma-separated list of the two types.
372− _encodingContentType :: Maybe Text
398+ _encodingContentType :: Maybe MediaType
374 -- | A map allowing additional information to be provided as headers,
400 -- | A map allowing additional information to be provided as headers,
375 -- for example @Content-Disposition@. @Content-Type@ is described separately
401 -- for example @Content-Disposition@. @Content-Type@ is described separately
@@ -408,18 +434,15 @@ mimeListConstr :: Constr
408mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
434mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
410mimeListDataType :: DataType
436mimeListDataType :: DataType
411−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
437+mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
413instance Data MimeList where
439instance Data MimeList where
414 gunfold k z c = case constrIndex c of
440 gunfold k z c = case constrIndex c of
415− 1 -> k (z (\xs -> MimeList (map fromString xs)))
441+ 1 -> k (z (MimeList . map fromString))
416 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
442 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
417 toConstr (MimeList _) = mimeListConstr
443 toConstr (MimeList _) = mimeListConstr
418 dataTypeOf _ = mimeListDataType
444 dataTypeOf _ = mimeListDataType
423-- | Describes a single operation parameter.
446-- | Describes a single operation parameter.
424-- A unique parameter is defined by a combination of a name and location.
447-- A unique parameter is defined by a combination of a name and location.
425data Param = Param
448data Param = Param
@@ -429,7 +452,7 @@ data Param = Param
430 -- | A brief description of the parameter.
453 -- | A brief description of the parameter.
431 -- This could contain examples of use.
454 -- This could contain examples of use.
432− -- GFM syntax can be used for rich text representation.
455+ -- CommonMark syntax MAY be used for rich text representation.
433 , _paramDescription :: Maybe Text
456 , _paramDescription :: Maybe Text
435 -- | Determines whether this parameter is mandatory.
458 -- | Determines whether this parameter is mandatory.
@@ -449,6 +472,13 @@ data Param = Param
449 -- a parameter with an empty value. Default value is @false@.
472 -- a parameter with an empty value. Default value is @false@.
450 , _paramAllowEmptyValue :: Maybe Bool
473 , _paramAllowEmptyValue :: Maybe Bool
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
452 -- | Parameter schema.
482 -- | Parameter schema.
453 , _paramSchema :: Maybe (Referenced Schema)
483 , _paramSchema :: Maybe (Referenced Schema)
@@ -479,6 +509,10 @@ data Param = Param
479 -- Furthermore, if referencing a schema that contains an example,
509 -- Furthermore, if referencing a schema that contains an example,
480 -- the examples value SHALL override the example provided by the schema.
510 -- the examples value SHALL override the example provided by the schema.
481 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
511 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
514+ -- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
515+ -- should be singleton. mutually exclusive with _paramSchema.
482 } deriving (Eq, Show, Generic, Data, Typeable)
516 } deriving (Eq, Show, Generic, Data, Typeable)
484data Example = Example
518data Example = Example
@@ -503,27 +537,63 @@ data Example = Example
503 , _exampleExternalValue :: Maybe URL
537 , _exampleExternalValue :: Maybe URL
504 } deriving (Eq, Show, Generic, Typeable, Data)
538 } deriving (Eq, Show, Generic, Typeable, Data)
540+data ExpressionOrValue
543+ deriving (Eq, Show, Generic, Typeable, Data)
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.
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
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
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
566+ -- | A literal value or @{expression}@ to use as a request body when calling the target operation.
567+ , _linkRequestBody :: Maybe ExpressionOrValue
569+ -- | A description of the link.
570+ , _linkDescription :: Maybe Text
572+ -- | A server object to be used by the target operation.
573+ , _linkServer :: Maybe Server
574+ } deriving (Eq, Show, Generic, Typeable, Data)
506−-- | Items for @'SwaggerArray'@ schemas.
576+-- | Items for @'OpenApiArray'@ schemas.
508-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
578-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
509-- it will incorporate Json Schema mostly verbatim.
579-- it will incorporate Json Schema mostly verbatim.
511−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
581+-- @'OpenApiItemsObject'@ should be used to specify homogenous array @'Schema'@s.
513−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
583+-- @'OpenApiItemsArray'@ should be used to specify tuple @'Schema'@s.
514−data SwaggerItems where
584+data OpenApiItems where
515− SwaggerItemsObject :: Referenced Schema -> SwaggerItems
585+ OpenApiItemsObject :: Referenced Schema -> OpenApiItems
516− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems
586+ OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems
517 deriving (Eq, Show, Typeable, Data)
587 deriving (Eq, Show, Typeable, Data)
519−data SwaggerType where
589+data OpenApiType where
520− SwaggerString :: SwaggerType
590+ OpenApiString :: OpenApiType
521− SwaggerNumber :: SwaggerType
591+ OpenApiNumber :: OpenApiType
522− SwaggerInteger :: SwaggerType
592+ OpenApiInteger :: OpenApiType
523− SwaggerBoolean :: SwaggerType
593+ OpenApiBoolean :: OpenApiType
524− SwaggerArray :: SwaggerType
594+ OpenApiArray :: OpenApiType
525− SwaggerNull :: SwaggerType
595+ OpenApiNull :: OpenApiType
526− SwaggerObject :: SwaggerType
596+ OpenApiObject :: OpenApiType
527 deriving (Eq, Show, Typeable, Generic, Data)
597 deriving (Eq, Show, Typeable, Generic, Data)
529data ParamLocation
599data ParamLocation
@@ -568,9 +638,33 @@ data Schema = Schema
568 , _schemaMaxProperties :: Maybe Integer
638 , _schemaMaxProperties :: Maybe Integer
569 , _schemaMinProperties :: Maybe Integer
639 , _schemaMinProperties :: Maybe Integer
571− , _schemaParamSchema :: ParamSchema
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
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
572 } deriving (Eq, Show, Generic, Data, Typeable)
663 } deriving (Eq, Show, Generic, Data, Typeable)
665+-- | Regex pattern for @string@ type.
574data Discriminator = Discriminator
668data Discriminator = Discriminator
575 { -- | The name of the property in the payload that will hold the discriminator value.
669 { -- | The name of the property in the payload that will hold the discriminator value.
576 _discriminatorPropertyName :: Text
670 _discriminatorPropertyName :: Text
@@ -586,37 +680,9 @@ data NamedSchema = NamedSchema
586 , _namedSchemaSchema :: Schema
680 , _namedSchemaSchema :: Schema
587 } deriving (Eq, Show, Generic, Data, Typeable)
681 } deriving (Eq, Show, Generic, Data, Typeable)
589−-- | Regex pattern for @string@ type.
592−data ParamSchema = ParamSchema
593− { -- | Declares the value of the parameter that the server will use if none is provided,
594− -- for example a @"count"@ to control the number of results per page might default to @100@
595− -- if not supplied by the client in the request.
596− -- (Note: "default" has no meaning for required parameters.)
597− -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
598− _paramSchemaDefault :: Maybe Value
600− , _paramSchemaType :: Maybe SwaggerType
601− , _paramSchemaFormat :: Maybe Format
602− , _paramSchemaItems :: Maybe SwaggerItems
603− , _paramSchemaMaximum :: Maybe Scientific
604− , _paramSchemaExclusiveMaximum :: Maybe Bool
605− , _paramSchemaMinimum :: Maybe Scientific
606− , _paramSchemaExclusiveMinimum :: Maybe Bool
607− , _paramSchemaMaxLength :: Maybe Integer
608− , _paramSchemaMinLength :: Maybe Integer
609− , _paramSchemaPattern :: Maybe Pattern
610− , _paramSchemaMaxItems :: Maybe Integer
611− , _paramSchemaMinItems :: Maybe Integer
612− , _paramSchemaUniqueItems :: Maybe Bool
613− , _paramSchemaEnum :: Maybe [Value]
614− , _paramSchemaMultipleOf :: Maybe Scientific
615− } deriving (Eq, Show, Generic, Typeable, Data)
617data Xml = Xml
683data Xml = Xml
618 { -- | Replaces the name of the element/attribute used for the described schema property.
684 { -- | Replaces the name of the element/attribute used for the described schema property.
619− -- 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.
620 -- When defined alongside type being array (outside the items),
686 -- When defined alongside type being array (outside the items),
621 -- it will affect the wrapping element and only if wrapped is true.
687 -- it will affect the wrapping element and only if wrapped is true.
622 -- If wrapped is false, it will be ignored.
688 -- If wrapped is false, it will be ignored.
@@ -668,25 +734,44 @@ data Response = Response
668 -- | A map containing descriptions of potential response payloads.
734 -- | A map containing descriptions of potential response payloads.
669 -- The key is a media type or media type range and the value describes it.
735 -- The key is a media type or media type range and the value describes it.
670 -- For responses that match multiple keys, only the most specific key is applicable.
736 -- For responses that match multiple keys, only the most specific key is applicable.
671− -- e.g. @text/plain@ overrides @text/*@.
737+ -- e.g. @text/plain@ overrides @text/\*@.
672− , _responseContent :: InsOrdHashMap Text MediaTypeObject
738+ , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
674 -- | Maps a header name to its definition.
740 -- | Maps a header name to its definition.
675 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
741 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
677− -- 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)
678 } deriving (Eq, Show, Generic, Data, Typeable)
747 } deriving (Eq, Show, Generic, Data, Typeable)
680instance IsString Response where
749instance IsString Response where
681− fromString s = Response (fromString s) mempty mempty
750+ fromString s = Response (fromString s) mempty mempty mempty
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)
683type HeaderName = Text
760type HeaderName = Text
685−
762+-- | Header fields have the same meaning as for 'Param'.
686−-- TODO this is mostly a copy of 'Param'.
763+--
764+-- Style is always treated as 'StyleSimple', as it is the only value allowed for headers.
687data Header = Header
765data Header = Header
688 { -- | A short description of the header.
766 { -- | A short description of the header.
689− _headerDescription :: Maybe Text
767+ _headerDescription :: Maybe HeaderName
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)
691 , _headerSchema :: Maybe (Referenced Schema)
776 , _headerSchema :: Maybe (Referenced Schema)
692 } deriving (Eq, Show, Generic, Data, Typeable)
777 } deriving (Eq, Show, Generic, Data, Typeable)
@@ -712,17 +797,17 @@ type AuthorizationURL = Text
712-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
797-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
713type TokenURL = Text
798type TokenURL = Text
715−data OAuth2ImplicitFlow = OAuth2ImplicitFlow
800+newtype OAuth2ImplicitFlow
716− { _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL
801+ = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
717− } deriving (Eq, Show, Generic, Data, Typeable)
802+ deriving (Eq, Show, Generic, Data, Typeable)
719−data OAuth2PasswordFlow = OAuth2PasswordFlow
804+newtype OAuth2PasswordFlow
720− { _oAuth2PasswordFlowTokenUrl :: TokenURL
805+ = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
721− } deriving (Eq, Show, Generic, Data, Typeable)
806+ deriving (Eq, Show, Generic, Data, Typeable)
723−data OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow
808+newtype OAuth2ClientCredentialsFlow
724− { _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL
809+ = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
725− } deriving (Eq, Show, Generic, Data, Typeable)
810+ deriving (Eq, Show, Generic, Data, Typeable)
727data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
812data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
728 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
813 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
@@ -755,8 +840,50 @@ data OAuth2Flows = OAuth2Flows
755 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
840 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
756 } deriving (Eq, Show, Generic, Data, Typeable)
841 } deriving (Eq, Show, Generic, Data, Typeable)
843+type BearerFormat = Text
846+ = HttpSchemeBearer (Maybe BearerFormat)
848+ | HttpSchemeCustom Text
849+ deriving (Eq, Show, Generic, Data, Typeable)
853+-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer Nothing))
855+-- "scheme": "bearer",
859+-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt")))
861+-- "bearerFormat": "jwt",
862+-- "scheme": "bearer",
866+-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp HttpSchemeBasic)
868+-- "scheme": "basic",
872+-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeCustom "CANARY"))
874+-- "scheme": "CANARY",
878+-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie))
758data SecuritySchemeType
885data SecuritySchemeType
759− = SecuritySchemeHttp
886+ = SecuritySchemeHttp HttpSchemeType
760 | SecuritySchemeApiKey ApiKeyParams
887 | SecuritySchemeApiKey ApiKeyParams
761 | SecuritySchemeOAuth2 OAuth2Flows
888 | SecuritySchemeOAuth2 OAuth2Flows
762 | SecuritySchemeOpenIdConnect URL
889 | SecuritySchemeOpenIdConnect URL
@@ -791,7 +918,7 @@ data Tag = Tag
791 _tagName :: TagName
918 _tagName :: TagName
793 -- | A short description for the tag.
920 -- | A short description for the tag.
794− -- GFM syntax can be used for rich text representation.
921+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
795 , _tagDescription :: Maybe Text
922 , _tagDescription :: Maybe Text
797 -- | Additional external documentation for this tag.
924 -- | Additional external documentation for this tag.
@@ -806,7 +933,7 @@ instance IsString Tag where
806-- | Allows referencing an external resource for extended documentation.
933-- | Allows referencing an external resource for extended documentation.
807data ExternalDocs = ExternalDocs
934data ExternalDocs = ExternalDocs
808 { -- | A short description of the target documentation.
935 { -- | A short description of the target documentation.
809− -- GFM syntax can be used for rich text representation.
936+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
810 _externalDocsDescription :: Maybe Text
937 _externalDocsDescription :: Maybe Text
812 -- | The URL for the target documentation.
939 -- | The URL for the target documentation.
@@ -853,18 +980,18 @@ deriveGeneric ''MediaTypeObject
853deriveGeneric ''Responses
980deriveGeneric ''Responses
854deriveGeneric ''SecurityScheme
981deriveGeneric ''SecurityScheme
855deriveGeneric ''Schema
982deriveGeneric ''Schema
856−deriveGeneric ''ParamSchema
983+deriveGeneric ''OpenApi
857−deriveGeneric ''Swagger
858deriveGeneric ''Example
984deriveGeneric ''Example
859deriveGeneric ''Encoding
985deriveGeneric ''Encoding
861-- =======================================================================
988-- =======================================================================
862-- Monoid instances
989-- Monoid instances
863-- =======================================================================
990-- =======================================================================
865−instance Semigroup Swagger where
992+instance Semigroup OpenApi where
866 (<>) = genericMappend
993 (<>) = genericMappend
867−instance Monoid Swagger where
994+instance Monoid OpenApi where
868 mempty = genericMempty
995 mempty = genericMempty
869 mappend = (<>)
996 mappend = (<>)
@@ -898,12 +1025,6 @@ instance Monoid Schema where
898 mempty = genericMempty
1025 mempty = genericMempty
899 mappend = (<>)
1026 mappend = (<>)
901−instance Semigroup ParamSchema where
902− (<>) = genericMappend
903−instance Monoid ParamSchema where
904− mempty = genericMempty
907instance Semigroup Param where
1028instance Semigroup Param where
908 (<>) = genericMappend
1029 (<>) = genericMappend
909instance Monoid Param where
1030instance Monoid Param where
@@ -998,19 +1119,19 @@ instance SwaggerMonoid Info
998instance SwaggerMonoid Components
1119instance SwaggerMonoid Components
999instance SwaggerMonoid PathItem
1120instance SwaggerMonoid PathItem
1000instance SwaggerMonoid Schema
1121instance SwaggerMonoid Schema
1001−instance SwaggerMonoid ParamSchema
1002instance SwaggerMonoid Param
1122instance SwaggerMonoid Param
1003instance SwaggerMonoid Responses
1123instance SwaggerMonoid Responses
1004instance SwaggerMonoid Response
1124instance SwaggerMonoid Response
1005instance SwaggerMonoid ExternalDocs
1125instance SwaggerMonoid ExternalDocs
1006instance SwaggerMonoid Operation
1126instance SwaggerMonoid Operation
1007instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1127instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1128+instance SwaggerMonoid SecurityDefinitions
1009instance SwaggerMonoid MimeList
1130instance SwaggerMonoid MimeList
1010deriving instance SwaggerMonoid URL
1131deriving instance SwaggerMonoid URL
1012−instance SwaggerMonoid SwaggerType where
1133+instance SwaggerMonoid OpenApiType where
1013− swaggerMempty = SwaggerString
1134+ swaggerMempty = OpenApiString
1014 swaggerMappend _ y = y
1135 swaggerMappend _ y = y
1016instance SwaggerMonoid ParamLocation where
1137instance SwaggerMonoid ParamLocation where
@@ -1033,7 +1154,7 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
1033instance ToJSON Style where
1154instance ToJSON Style where
1034 toJSON = genericToJSON (jsonPrefix "Style")
1155 toJSON = genericToJSON (jsonPrefix "Style")
1036−instance ToJSON SwaggerType where
1157+instance ToJSON OpenApiType where
1037 toJSON = genericToJSON (jsonPrefix "Swagger")
1158 toJSON = genericToJSON (jsonPrefix "Swagger")
1039instance ToJSON ParamLocation where
1160instance ToJSON ParamLocation where
@@ -1088,7 +1209,7 @@ instance ToJSON OAuth2AuthorizationCodeFlow where
1088instance FromJSON Style where
1209instance FromJSON Style where
1089 parseJSON = genericParseJSON (jsonPrefix "Style")
1210 parseJSON = genericParseJSON (jsonPrefix "Style")
1091−instance FromJSON SwaggerType where
1212+instance FromJSON OpenApiType where
1092 parseJSON = genericParseJSON (jsonPrefix "Swagger")
1213 parseJSON = genericParseJSON (jsonPrefix "Swagger")
1094instance FromJSON ParamLocation where
1215instance FromJSON ParamLocation where
@@ -1137,7 +1258,14 @@ instance FromJSON OAuth2AuthorizationCodeFlow where
1137-- Manual ToJSON instances
1258-- Manual ToJSON instances
1138-- =======================================================================
1259-- =======================================================================
1261+instance ToJSON MediaType where
1262+ toJSON = toJSON . show
1263+ toEncoding = toEncoding . show
1265+instance ToJSONKey MediaType where
1266+ toJSONKey = JSON.toJSONKeyText (Text.pack . show)
1140−instance (Eq p, ToJSON p, AesonDefaultValue p) =>ToJSON (OAuth2Flow p) where
1268+instance (Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) where
1141 toJSON = sopSwaggerGenericToJSON
1269 toJSON = sopSwaggerGenericToJSON
1142 toEncoding = sopSwaggerGenericToEncoding
1270 toEncoding = sopSwaggerGenericToEncoding
@@ -1146,8 +1274,19 @@ instance ToJSON OAuth2Flows where
1146 toEncoding = sopSwaggerGenericToEncoding
1274 toEncoding = sopSwaggerGenericToEncoding
1148instance ToJSON SecuritySchemeType where
1276instance ToJSON SecuritySchemeType where
1149− toJSON SecuritySchemeHttp
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
1283+ object [ "type" .= ("http" :: Text)
1284+ , "scheme" .= ("basic" :: Text)
1286+ HttpSchemeCustom t ->
1150− = object [ "type" .= ("http" :: Text) ]
1287+ object [ "type" .= ("http" :: Text)
1151 toJSON (SecuritySchemeApiKey params)
1290 toJSON (SecuritySchemeApiKey params)
1152 = toJSON params
1291 = toJSON params
1153 <+> object [ "type" .= ("apiKey" :: Text) ]
1292 <+> object [ "type" .= ("apiKey" :: Text) ]
@@ -1160,9 +1299,9 @@ instance ToJSON SecuritySchemeType where
1160 , "openIdConnectUrl" .= url
1299 , "openIdConnectUrl" .= url
1163−instance ToJSON Swagger where
1302+instance ToJSON OpenApi where
1164 toJSON a = sopSwaggerGenericToJSON a &
1303 toJSON a = sopSwaggerGenericToJSON a &
1165− if InsOrdHashMap.null (_swaggerPaths a)
1304+ if InsOrdHashMap.null (_openApiPaths a)
1166 then (<+> object ["paths" .= object []])
1305 then (<+> object ["paths" .= object []])
1168 toEncoding = sopSwaggerGenericToEncoding
1307 toEncoding = sopSwaggerGenericToEncoding
@@ -1176,8 +1315,8 @@ instance ToJSON SecurityScheme where
1176 toEncoding = sopSwaggerGenericToEncoding
1315 toEncoding = sopSwaggerGenericToEncoding
1178instance ToJSON Schema where
1317instance ToJSON Schema where
1179− toJSON = sopSwaggerGenericToJSON
1318+ toJSON = sopSwaggerGenericToJSONWithOpts $
1180− toEncoding = sopSwaggerGenericToEncoding
1319+ mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1182instance ToJSON Header where
1321instance ToJSON Header where
1183 toJSON = sopSwaggerGenericToJSON
1322 toJSON = sopSwaggerGenericToJSON
@@ -1186,17 +1325,21 @@ instance ToJSON Header where
1186-- | As for nullary schema for 0-arity type constructors, see
1325-- | As for nullary schema for 0-arity type constructors, see
1187-- <https://github.com/GetShopTV/swagger2/issues/167>.
1326-- <https://github.com/GetShopTV/swagger2/issues/167>.
1189−-- >>> encode (SwaggerItemsArray [])
1328+-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1190−-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1332+-- "maxItems": 0
1192−instance ToJSON SwaggerItems where
1335+instance ToJSON OpenApiItems where
1193− toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1336+ toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1194− toJSON (SwaggerItemsArray []) = object
1337+ toJSON (OpenApiItemsArray []) = object
1195 [ "items" .= object []
1338 [ "items" .= object []
1196 , "maxItems" .= (0 :: Int)
1339 , "maxItems" .= (0 :: Int)
1197 , "example" .= Array mempty
1340 , "example" .= Array mempty
1199− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1342+ toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
1201instance ToJSON Components where
1344instance ToJSON Components where
1202 toJSON = sopSwaggerGenericToJSON
1345 toJSON = sopSwaggerGenericToJSON
@@ -1241,6 +1384,10 @@ instance ToJSON Encoding where
1241 toJSON = sopSwaggerGenericToJSON
1384 toJSON = sopSwaggerGenericToJSON
1242 toEncoding = sopSwaggerGenericToEncoding
1385 toEncoding = sopSwaggerGenericToEncoding
1387+instance ToJSON Link where
1388+ toJSON = sopSwaggerGenericToJSON
1389+ toEncoding = sopSwaggerGenericToEncoding
1244instance ToJSON SecurityDefinitions where
1391instance ToJSON SecurityDefinitions where
1245 toJSON (SecurityDefinitions sd) = toJSON sd
1392 toJSON (SecurityDefinitions sd) = toJSON sd
@@ -1257,20 +1404,31 @@ instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/compone
1257instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1404instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1258instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1405instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1259instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1406instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1260−
1407+instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1261−instance ToJSON ParamSchema where
1408+instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
1262− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1263− toJSON = sopSwaggerGenericToJSONWithOpts $
1264− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1266instance ToJSON AdditionalProperties where
1410instance ToJSON AdditionalProperties where
1267 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1411 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1268 toJSON (AdditionalPropertiesSchema s) = toJSON s
1412 toJSON (AdditionalPropertiesSchema s) = toJSON s
1414+instance ToJSON ExpressionOrValue where
1415+ toJSON (Expression expr) = toJSON expr
1416+ toJSON (Value val) = toJSON val
1418+instance ToJSON Callback where
1419+ toJSON (Callback ps) = toJSON ps
1270-- =======================================================================
1421-- =======================================================================
1271-- Manual FromJSON instances
1422-- Manual FromJSON instances
1272-- =======================================================================
1423-- =======================================================================
1425+instance FromJSON MediaType where
1426+ parseJSON = withText "MediaType" $ \str ->
1427+ maybe (fail $ "Invalid media type literal " <> Text.unpack str) pure $ parseAccept $ encodeUtf8 str
1429+instance FromJSONKey MediaType where
1430+ fromJSONKey = FromJSONKeyTextParser (parseJSON . String)
1274instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1432instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1275 parseJSON = sopSwaggerGenericParseJSON
1433 parseJSON = sopSwaggerGenericParseJSON
@@ -1281,14 +1439,19 @@ instance FromJSON SecuritySchemeType where
1281 parseJSON js@(Object o) = do
1439 parseJSON js@(Object o) = do
1282 (t :: Text) <- o .: "type"
1440 (t :: Text) <- o .: "type"
1283 case t of
1441 case t of
1443+ scheme <- o .: "scheme"
1284− "http" -> pure SecuritySchemeHttp
1444+ SecuritySchemeHttp <$> case scheme of
1445+ "bearer" -> HttpSchemeBearer <$> (o .:! "bearerFormat")
1446+ "basic" -> pure HttpSchemeBasic
1447+ t -> pure $ HttpSchemeCustom t
1285 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1448 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1286 "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1449 "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1287 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1450 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1288 _ -> empty
1451 _ -> empty
1289 parseJSON _ = empty
1452 parseJSON _ = empty
1291−instance FromJSON Swagger where
1454+instance FromJSON OpenApi where
1292 parseJSON = sopSwaggerGenericParseJSON
1455 parseJSON = sopSwaggerGenericParseJSON
1294instance FromJSON Server where
1457instance FromJSON Server where
@@ -1300,27 +1463,28 @@ instance FromJSON SecurityScheme where
1300instance FromJSON Schema where
1463instance FromJSON Schema where
1301 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1464 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1302 where nullaryCleanup :: Schema -> Schema
1465 where nullaryCleanup :: Schema -> Schema
1303− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1466+ nullaryCleanup s =
1304− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1467+ if _schemaItems s == Just (OpenApiItemsArray [])
1305 then s { _schemaExample = Nothing
1468 then s { _schemaExample = Nothing
1306− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1469+ , _schemaMaxItems = Nothing
1309instance FromJSON Header where
1473instance FromJSON Header where
1310 parseJSON = sopSwaggerGenericParseJSON
1474 parseJSON = sopSwaggerGenericParseJSON
1312−instance FromJSON SwaggerItems where
1476+instance FromJSON OpenApiItems where
1313 parseJSON js@(Object obj)
1477 parseJSON js@(Object obj)
1314− | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1478+ | null obj = pure $ OpenApiItemsArray [] -- Nullary schema.
1315− | otherwise = SwaggerItemsObject <$> parseJSON js
1479+ | otherwise = OpenApiItemsObject <$> parseJSON js
1316− parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1480+ parseJSON js@(Array _) = OpenApiItemsArray <$> parseJSON js
1317 parseJSON _ = empty
1481 parseJSON _ = empty
1319instance FromJSON Components where
1483instance FromJSON Components where
1320 parseJSON = sopSwaggerGenericParseJSON
1484 parseJSON = sopSwaggerGenericParseJSON
1322instance FromJSON MimeList where
1486instance FromJSON MimeList where
1323− parseJSON js = (MimeList . map fromString) <$> parseJSON js
1487+ parseJSON js = MimeList . map fromString <$> parseJSON js
1325instance FromJSON Param where
1489instance FromJSON Param where
1326 parseJSON = sopSwaggerGenericParseJSON
1490 parseJSON = sopSwaggerGenericParseJSON
@@ -1328,7 +1492,7 @@ instance FromJSON Param where
1328instance FromJSON Responses where
1492instance FromJSON Responses where
1329 parseJSON (Object o) = Responses
1493 parseJSON (Object o) = Responses
1330 <$> o .:? "default"
1494 <$> o .:? "default"
1331− <*> (parseJSON (Object (HashMap.delete "default" o)))
1495+ <*> parseJSON (Object (deleteKey "default" o))
1332 parseJSON _ = empty
1496 parseJSON _ = empty
1334instance FromJSON Example where
1498instance FromJSON Example where
@@ -1355,6 +1519,9 @@ instance FromJSON MediaTypeObject where
1355instance FromJSON Encoding where
1519instance FromJSON Encoding where
1356 parseJSON = sopSwaggerGenericParseJSON
1520 parseJSON = sopSwaggerGenericParseJSON
1522+instance FromJSON Link where
1523+ parseJSON = sopSwaggerGenericParseJSON
1358instance FromJSON Reference where
1525instance FromJSON Reference where
1359 parseJSON (Object o) = Reference <$> o .: "$ref"
1526 parseJSON (Object o) = Reference <$> o .: "$ref"
1360 parseJSON _ = empty
1527 parseJSON _ = empty
@@ -1378,17 +1545,24 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
1378instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1545instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1379instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1546instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1380instance FromJSON (Referenced Header) where parseJSON = referencedParseJSON "#/components/headers/"
1547instance 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/"
1382instance FromJSON Xml where
1551instance FromJSON Xml where
1383 parseJSON = genericParseJSON (jsonPrefix "xml")
1552 parseJSON = genericParseJSON (jsonPrefix "xml")
1385−instance FromJSON ParamSchema where
1386− parseJSON = sopSwaggerGenericParseJSON
1388instance FromJSON AdditionalProperties where
1554instance FromJSON AdditionalProperties where
1389 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1555 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1390 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1556 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
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
1563+instance FromJSON Callback where
1564+ parseJSON = fmap Callback . parseJSON
1392instance HasSwaggerAesonOptions Server where
1566instance HasSwaggerAesonOptions Server where
1393 swaggerAesonOptions _ = mkSwaggerAesonOptions "server"
1567 swaggerAesonOptions _ = mkSwaggerAesonOptions "server"
1394instance HasSwaggerAesonOptions Components where
1568instance HasSwaggerAesonOptions Components where
@@ -1417,19 +1591,18 @@ instance HasSwaggerAesonOptions SecurityScheme where
1417 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1591 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1418instance HasSwaggerAesonOptions Schema where
1592instance HasSwaggerAesonOptions Schema where
1419 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1593 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1420−instance HasSwaggerAesonOptions Swagger where
1594+instance HasSwaggerAesonOptions OpenApi where
1421 swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1595 swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1422instance HasSwaggerAesonOptions Example where
1596instance HasSwaggerAesonOptions Example where
1423 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1597 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1424instance HasSwaggerAesonOptions Encoding where
1598instance HasSwaggerAesonOptions Encoding where
1425 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1599 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1427−instance HasSwaggerAesonOptions ParamSchema where
1601+instance HasSwaggerAesonOptions Link where
1428− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1602+ swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
1430instance AesonDefaultValue Server
1604instance AesonDefaultValue Server
1431instance AesonDefaultValue Components
1605instance AesonDefaultValue Components
1432−instance AesonDefaultValue ParamSchema
1433instance AesonDefaultValue OAuth2ImplicitFlow
1606instance AesonDefaultValue OAuth2ImplicitFlow
1434instance AesonDefaultValue OAuth2PasswordFlow
1607instance AesonDefaultValue OAuth2PasswordFlow
1435instance AesonDefaultValue OAuth2ClientCredentialsFlow
1608instance AesonDefaultValue OAuth2ClientCredentialsFlow
@@ -1437,7 +1610,10 @@ instance AesonDefaultValue OAuth2AuthorizationCodeFlow
1437instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1610instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1438instance AesonDefaultValue Responses
1611instance AesonDefaultValue Responses
1439instance AesonDefaultValue SecuritySchemeType
1612instance AesonDefaultValue SecuritySchemeType
1440−instance AesonDefaultValue SwaggerType
1613+instance AesonDefaultValue OpenApiType
1441instance AesonDefaultValue MimeList where defaultValue = Just mempty
1614instance AesonDefaultValue MimeList where defaultValue = Just mempty
1442instance AesonDefaultValue Info
1615instance AesonDefaultValue Info
1443instance AesonDefaultValue ParamLocation
1616instance AesonDefaultValue ParamLocation
1617+instance AesonDefaultValue Link
1618+instance AesonDefaultValue SecurityDefinitions where
1619+ defaultValue = Just mempty