@@ -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.
@@ -179,6 +183,9 @@ data ServerVariable = ServerVariable
179 , _serverVariableDescription :: Maybe Text
183 , _serverVariableDescription :: Maybe Text
180 } deriving (Eq, Show, Generic, Data, Typeable)
184 } deriving (Eq, Show, Generic, Data, Typeable)
186+instance IsString Server where
187+ fromString s = Server (fromString s) Nothing mempty
182-- | Holds a set of reusable objects for different aspects of the OAS.
189-- | Holds a set of reusable objects for different aspects of the OAS.
183-- All objects defined within the components object will have no effect on the API
190-- All objects defined within the components object will have no effect on the API
184-- unless they are explicitly referenced from properties outside the components object.
191-- unless they are explicitly referenced from properties outside the components object.
@@ -188,42 +195,12 @@ data Components = Components
188 , _componentsParameters :: Definitions Param
195 , _componentsParameters :: Definitions Param
189 , _componentsExamples :: Definitions Example
196 , _componentsExamples :: Definitions Example
190 , _componentsRequestBodies :: Definitions RequestBody
197 , _componentsRequestBodies :: Definitions RequestBody
191− , _componentsHeader :: Definitions Header
198+ , _componentsHeaders :: Definitions Header
192− , _componentsSecuritySchemes :: Definitions SecurityScheme
199+ , _componentsSecuritySchemes :: SecurityDefinitions
193−-- , _componentsLinks
200+ , _componentsLinks :: Definitions Link
194−-- , _componentsCallbacks
201+ , _componentsCallbacks :: Definitions Callback
195 } deriving (Eq, Show, Generic, Data, Typeable)
202 } deriving (Eq, Show, Generic, Data, Typeable)
197−-- | The host (name or ip) serving the API. It MAY include a port.
199− { _hostName :: HostName -- ^ Host name.
200− , _hostPort :: Maybe PortNumber -- ^ Optional port.
201− } deriving (Eq, Show, Generic, Typeable)
203−instance IsString Host where
204− fromString s = Host s Nothing
207−hostConstr = mkConstr hostDataType "Host" [] Prefix
209−hostDataType :: DataType
210−hostDataType = mkDataType "Data.Swagger.Host" [hostConstr]
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
219−-- | The transfer protocol of the API.
225− deriving (Eq, Show, Generic, Data, Typeable)
227-- | Describes the operations available on a single path.
204-- | Describes the operations available on a single path.
228-- A @'PathItem'@ may be empty, due to ACL constraints.
205-- A @'PathItem'@ may be empty, due to ACL constraints.
229-- The path itself is still exposed to the documentation viewer
206-- The path itself is still exposed to the documentation viewer
@@ -311,7 +288,11 @@ data Operation = Operation
311 -- | 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.
312 , _operationResponses :: Responses
289 , _operationResponses :: Responses
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)
316 -- | Declares this operation to be deprecated.
297 -- | Declares this operation to be deprecated.
317 -- Usage of the declared operation should be refrained.
298 -- Usage of the declared operation should be refrained.
@@ -331,6 +312,22 @@ data Operation = Operation
331 , _operationServers :: [Server]
312 , _operationServers :: [Server]
332 } 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
334-- | Describes a single request body.
331-- | Describes a single request body.
335data RequestBody = RequestBody
332data RequestBody = RequestBody
336 { -- | 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.
@@ -340,9 +337,11 @@ data RequestBody = RequestBody
340 -- | The content of the request body.
337 -- | The content of the request body.
341 -- 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.
342 -- 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.
343− -- e.g. @text/plain@ overrides @text/*@
340+ -- e.g. @text/plain@ overrides @text/\*@
344− , _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'.
346 , _requestBodyRequired :: Maybe Bool
345 , _requestBodyRequired :: Maybe Bool
347 } deriving (Eq, Show, Generic, Data, Typeable)
346 } deriving (Eq, Show, Generic, Data, Typeable)
@@ -365,6 +364,29 @@ data MediaTypeObject = MediaTypeObject
365 , _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
364 , _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
366 } deriving (Eq, Show, Generic, Data, Typeable)
365 } deriving (Eq, Show, Generic, Data, Typeable)
367+-- | In order to support common ways of serializing simple parameters, a set of style values are defined.
370+ -- ^ Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
372+ -- ^ Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
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.
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.
387+ -- ^ Provides a simple way of rendering nested objects using form parameters.
388+ deriving (Eq, Show, Generic, Data, Typeable)
368data Encoding = Encoding
390data Encoding = Encoding
369 { -- | The Content-Type for encoding a specific property.
391 { -- | The Content-Type for encoding a specific property.
370 -- Default value depends on the property type: for @string@
392 -- Default value depends on the property type: for @string@
@@ -372,8 +394,8 @@ data Encoding = Encoding
372 -- for other primitive types – @text/plain@; for object - @application/json@;
394 -- for other primitive types – @text/plain@; for object - @application/json@;
373 -- for array – the default is defined based on the inner type.
395 -- for array – the default is defined based on the inner type.
374 -- 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@),
375− -- 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.
376− _encodingContentType :: Maybe Text
398+ _encodingContentType :: Maybe MediaType
378 -- | A map allowing additional information to be provided as headers,
400 -- | A map allowing additional information to be provided as headers,
379 -- for example @Content-Disposition@. @Content-Type@ is described separately
401 -- for example @Content-Disposition@. @Content-Type@ is described separately
@@ -382,11 +404,11 @@ data Encoding = Encoding
382 , _encodingHeaders :: InsOrdHashMap Text (Referenced Header)
404 , _encodingHeaders :: InsOrdHashMap Text (Referenced Header)
384 -- | Describes how a specific property value will be serialized depending on its type.
406 -- | 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.
386 -- The behavior follows the same values as query parameters, including default values.
408 -- The behavior follows the same values as query parameters, including default values.
387 -- This property SHALL be ignored if the request body media type
409 -- This property SHALL be ignored if the request body media type
388 -- is not @application/x-www-form-urlencoded@.
410 -- is not @application/x-www-form-urlencoded@.
389− , _encodingStyle :: Maybe Text -- TODO enum
411+ , _encodingStyle :: Maybe Style
391 -- | When this is true, property values of type @array@ or @object@ generate
413 -- | When this is true, property values of type @array@ or @object@ generate
392 -- separate parameters for each value of the array,
414 -- separate parameters for each value of the array,
@@ -412,11 +434,11 @@ mimeListConstr :: Constr
412mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
434mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
414mimeListDataType :: DataType
436mimeListDataType :: DataType
415−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
437+mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
417instance Data MimeList where
439instance Data MimeList where
418 gunfold k z c = case constrIndex c of
440 gunfold k z c = case constrIndex c of
419− 1 -> k (z (\xs -> MimeList (map fromString xs)))
441+ 1 -> k (z (MimeList . map fromString))
420 _ -> 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."
421 toConstr (MimeList _) = mimeListConstr
443 toConstr (MimeList _) = mimeListConstr
422 dataTypeOf _ = mimeListDataType
444 dataTypeOf _ = mimeListDataType
@@ -430,7 +452,7 @@ data Param = Param
431 -- | A brief description of the parameter.
453 -- | A brief description of the parameter.
432 -- This could contain examples of use.
454 -- 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.
434 , _paramDescription :: Maybe Text
456 , _paramDescription :: Maybe Text
436 -- | Determines whether this parameter is mandatory.
458 -- | Determines whether this parameter is mandatory.
@@ -438,27 +460,60 @@ data Param = Param
438 -- Otherwise, the property MAY be included and its default value is @False@.
460 -- Otherwise, the property MAY be included and its default value is @False@.
439 , _paramRequired :: Maybe Bool
461 , _paramRequired :: Maybe Bool
441− -- | Parameter schema.
463+ -- | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
442− , _paramSchema :: ParamAnySchema
464+ -- Default value is @false@.
443− } deriving (Eq, Show, Generic, Data, Typeable)
465+ , _paramDeprecated :: Maybe Bool
446− = ParamBody (Referenced Schema)
447− | ParamOther ParamOtherSchema
448− deriving (Eq, Show, Generic, Data, Typeable)
450−data ParamOtherSchema = ParamOtherSchema
451− { -- | The location of the parameter.
467+ -- | The location of the parameter.
452− _paramOtherSchemaIn :: ParamLocation
468+ , _paramIn :: ParamLocation
454 -- | Sets the ability to pass empty-valued parameters.
470 -- | Sets the ability to pass empty-valued parameters.
455− -- This is valid only for either @'ParamQuery'@ or @'ParamFormData'@
471+ -- This is valid only for 'ParamQuery' parameters and allows sending
456− -- and allows you to send a parameter with a name only or an empty value.
472+ -- a parameter with an empty value. Default value is @false@.
457− -- Default value is @False@.
473+ , _paramAllowEmptyValue :: Maybe Bool
458− , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
460− , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
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
482+ -- | Parameter schema.
483+ , _paramSchema :: Maybe (Referenced Schema)
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
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
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
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)
514+ -- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
515+ -- should be singleton. mutually exclusive with _paramSchema.
461− } deriving (Eq, Show, Generic, Typeable, Data)
516+ } deriving (Eq, Show, Generic, Data, Typeable)
463data Example = Example
518data Example = Example
464 { -- | Short description for the example.
519 { -- | Short description for the example.
@@ -482,137 +537,64 @@ data Example = Example
482 , _exampleExternalValue :: Maybe URL
537 , _exampleExternalValue :: Maybe URL
483 } 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)
485−-- | Items for @'SwaggerArray'@ schemas.
576+-- | Items for @'OpenApiArray'@ schemas.
487−-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
578+-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
488−-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
579+-- it will incorporate Json Schema mostly verbatim.
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>.
492−-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
581+-- @'OpenApiItemsObject'@ should be used to specify homogenous array @'Schema'@s.
494−-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
583+-- @'OpenApiItemsArray'@ should be used to specify tuple @'Schema'@s.
495−data SwaggerItems t where
584+data OpenApiItems where
496− SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
585+ OpenApiItemsObject :: Referenced Schema -> OpenApiItems
497− SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
586+ OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems
498− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
587+ deriving (Eq, Show, Typeable, Data)
499− deriving (Typeable)
588+
500−
589+data OpenApiType where
501−deriving instance Eq (SwaggerItems t)
590+ OpenApiString :: OpenApiType
502−deriving instance Show (SwaggerItems t)
591+ OpenApiNumber :: OpenApiType
503−--deriving instance Typeable (SwaggerItems t)
592+ OpenApiInteger :: OpenApiType
504−
593+ OpenApiBoolean :: OpenApiType
505−swaggerItemsPrimitiveConstr :: Constr
594+ OpenApiArray :: OpenApiType
506−swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
595+ OpenApiNull :: OpenApiType
507−
596+ OpenApiObject :: OpenApiType
508−swaggerItemsObjectConstr :: Constr
597+ deriving (Eq, Show, Typeable, Generic, Data)
509−swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
511−swaggerItemsArrayConstr :: Constr
512−swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
514−swaggerItemsDataType :: DataType
515−swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
517−-- Note: unfortunately we have to write these Data instances by hand,
518−-- to get better contexts / avoid duplicate name when using standalone deriving
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
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
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
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)."
547− toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
548− toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
549− toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
551− dataTypeOf _ = swaggerItemsDataType
553−-- | Type used as a kind to avoid overlapping instances.
555− = SwaggerKindNormal t
556− | SwaggerKindParamOtherSchema
560−deriving instance Typeable 'SwaggerKindNormal
561−deriving instance Typeable 'SwaggerKindParamOtherSchema
562−deriving instance Typeable 'SwaggerKindSchema
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
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
580−deriving instance Eq (SwaggerType t)
581−deriving instance Show (SwaggerType t)
583−swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
584−swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
586−swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
587−swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
589−swaggerCommonTypes :: [SwaggerType k]
590−swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
592−swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
593−swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
595−swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
596−swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
598−swaggerTypeConstrs :: [Constr]
599−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
600− ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
602−instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
603− gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
604− toConstr = swaggerTypeConstr
605− dataTypeOf = swaggerTypeDataType
607−instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
608− gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
609− toConstr = swaggerTypeConstr
610− dataTypeOf = swaggerTypeDataType
612−instance Data (SwaggerType 'SwaggerKindSchema) where
613− gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
614− toConstr = swaggerTypeConstr
615− dataTypeOf = swaggerTypeDataType
617data ParamLocation
599data ParamLocation
618 = -- | Parameters that are appended to the URL.
600 = -- | Parameters that are appended to the URL.
@@ -630,42 +612,6 @@ data ParamLocation
631type Format = Text
613type Format = Text
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
649−deriving instance Eq (CollectionFormat t)
650−deriving instance Show (CollectionFormat t)
652−collectionFormatConstr :: CollectionFormat t -> Constr
653−collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
655−collectionFormatDataType :: DataType
656−collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
657− map collectionFormatConstr collectionCommonFormats
659−collectionCommonFormats :: [CollectionFormat t]
660−collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
662−instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
663− gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
664− toConstr = collectionFormatConstr
665− dataTypeOf _ = collectionFormatDataType
667−deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
669type ParamName = Text
615type ParamName = Text
671data Schema = Schema
617data Schema = Schema
@@ -692,9 +638,33 @@ data Schema = Schema
692 , _schemaMaxProperties :: Maybe Integer
638 , _schemaMaxProperties :: Maybe Integer
693 , _schemaMinProperties :: Maybe Integer
639 , _schemaMinProperties :: Maybe Integer
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
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
696 } deriving (Eq, Show, Generic, Data, Typeable)
663 } deriving (Eq, Show, Generic, Data, Typeable)
665+-- | Regex pattern for @string@ type.
698data Discriminator = Discriminator
668data Discriminator = Discriminator
699 { -- | 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.
700 _discriminatorPropertyName :: Text
670 _discriminatorPropertyName :: Text
@@ -710,41 +680,9 @@ data NamedSchema = NamedSchema
710 , _namedSchemaSchema :: Schema
680 , _namedSchemaSchema :: Schema
711 } deriving (Eq, Show, Generic, Data, Typeable)
681 } deriving (Eq, Show, Generic, Data, Typeable)
713−-- | Regex pattern for @string@ type.
716−-- TODO examples for params
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
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)
743−deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
745data Xml = Xml
683data Xml = Xml
746 { -- | 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.
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.
748 -- When defined alongside type being array (outside the items),
686 -- When defined alongside type being array (outside the items),
749 -- 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.
750 -- If wrapped is false, it will be ignored.
688 -- If wrapped is false, it will be ignored.
@@ -796,25 +734,46 @@ data Response = Response
796 -- | A map containing descriptions of potential response payloads.
734 -- | A map containing descriptions of potential response payloads.
797 -- 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.
798 -- 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.
799− -- e.g. @text/plain@ overrides @text/*@.
737+ -- e.g. @text/plain@ overrides @text/\*@.
800− , _responseContent :: InsOrdHashMap Text MediaTypeObject
738+ , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
802 -- | Maps a header name to its definition.
740 -- | Maps a header name to its definition.
803 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
741 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
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)
806 } deriving (Eq, Show, Generic, Data, Typeable)
747 } deriving (Eq, Show, Generic, Data, Typeable)
808instance IsString Response where
749instance IsString Response where
809− 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)
811type HeaderName = Text
760type HeaderName = Text
762+-- | Header fields have the same meaning as for 'Param'.
764+-- Style is always treated as 'StyleSimple', as it is the only value allowed for headers.
813data Header = Header
765data Header = Header
814 { -- | A short description of the header.
766 { -- | A short description of the header.
815− _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)
817− , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
776+ , _headerSchema :: Maybe (Referenced Schema)
818 } deriving (Eq, Show, Generic, Data, Typeable)
777 } deriving (Eq, Show, Generic, Data, Typeable)
820-- | The location of the API key.
779-- | The location of the API key.
@@ -838,26 +797,96 @@ type AuthorizationURL = Text
838-- | 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.
839type TokenURL = Text
798type TokenURL = Text
841−data OAuth2Flow
800+newtype OAuth2ImplicitFlow
842− = OAuth2Implicit AuthorizationURL
801+ = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
843− | OAuth2Password TokenURL
802+ deriving (Eq, Show, Generic, Data, Typeable)
844− | OAuth2Application TokenURL
803+
845− | OAuth2AccessCode AuthorizationURL TokenURL
804+newtype OAuth2PasswordFlow
805+ = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
806+ deriving (Eq, Show, Generic, Data, Typeable)
808+newtype OAuth2ClientCredentialsFlow
809+ = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
846 deriving (Eq, Show, Generic, Data, Typeable)
810 deriving (Eq, Show, Generic, Data, Typeable)
848−data OAuth2Params = OAuth2Params
812+data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
849− { -- | The flow used by the OAuth2 security scheme.
813+ { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
850− _oauth2Flow :: OAuth2Flow
814+ , _oAuth2AuthorizationCodeFlowTokenUrl :: TokenURL
815+ } deriving (Eq, Show, Generic, Data, Typeable)
817+data OAuth2Flow p = OAuth2Flow
818+ { _oAuth2Params :: p
820+ -- | The URL to be used for obtaining refresh tokens.
821+ , _oAath2RefreshUrl :: Maybe URL
852 -- | The available scopes for the OAuth2 security scheme.
823 -- | The available scopes for the OAuth2 security scheme.
824+ -- A map between the scope name and a short description for it.
825+ -- The map MAY be empty.
853− , _oauth2Scopes :: InsOrdHashMap Text Text
826+ , _oAuth2Scopes :: InsOrdHashMap Text Text
827+ } deriving (Eq, Show, Generic, Data, Typeable)
829+data OAuth2Flows = OAuth2Flows
830+ { -- | Configuration for the OAuth Implicit flow
831+ _oAuth2FlowsImplicit :: Maybe (OAuth2Flow OAuth2ImplicitFlow)
833+ -- | Configuration for the OAuth Resource Owner Password flow
834+ , _oAuth2FlowsPassword :: Maybe (OAuth2Flow OAuth2PasswordFlow)
836+ -- | Configuration for the OAuth Client Credentials flow
837+ , _oAuth2FlowsClientCredentials :: Maybe (OAuth2Flow OAuth2ClientCredentialsFlow)
839+ -- | Configuration for the OAuth Authorization Code flow
840+ , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
854 } 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))
856data SecuritySchemeType
885data SecuritySchemeType
857− = SecuritySchemeHttp
886+ = SecuritySchemeHttp HttpSchemeType
858 | SecuritySchemeApiKey ApiKeyParams
887 | SecuritySchemeApiKey ApiKeyParams
859− | SecuritySchemeOAuth2 OAuth2Params
888+ | SecuritySchemeOAuth2 OAuth2Flows
860−-- | SecuritySchemeOpenIdConnect -- FIXME
889+ | SecuritySchemeOpenIdConnect URL
861 deriving (Eq, Show, Generic, Data, Typeable)
890 deriving (Eq, Show, Generic, Data, Typeable)
863data SecurityScheme = SecurityScheme
892data SecurityScheme = SecurityScheme
@@ -868,18 +897,6 @@ data SecurityScheme = SecurityScheme
868 , _securitySchemeDescription :: Maybe Text
897 , _securitySchemeDescription :: Maybe Text
869 } deriving (Eq, Show, Generic, Data, Typeable)
898 } deriving (Eq, Show, Generic, Data, Typeable)
872−-- | merge scopes of two OAuth2 security schemes when their flows are identical.
873−-- In other case returns first security scheme
874−mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
875−mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
876− s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
877− = if flow1 == flow2 then
878− SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
881−mergeSecurityScheme s1 _ = s1
883newtype SecurityDefinitions
900newtype SecurityDefinitions
884 = SecurityDefinitions (Definitions SecurityScheme)
901 = SecurityDefinitions (Definitions SecurityScheme)
885 deriving (Eq, Show, Generic, Data, Typeable)
902 deriving (Eq, Show, Generic, Data, Typeable)
@@ -901,7 +918,7 @@ data Tag = Tag
901 _tagName :: TagName
918 _tagName :: TagName
903 -- | A short description for the tag.
920 -- | A short description for the tag.
904− -- GFM syntax can be used for rich text representation.
921+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
905 , _tagDescription :: Maybe Text
922 , _tagDescription :: Maybe Text
907 -- | Additional external documentation for this tag.
924 -- | Additional external documentation for this tag.
@@ -916,7 +933,7 @@ instance IsString Tag where
916-- | Allows referencing an external resource for extended documentation.
933-- | Allows referencing an external resource for extended documentation.
917data ExternalDocs = ExternalDocs
934data ExternalDocs = ExternalDocs
918 { -- | A short description of the target documentation.
935 { -- | A short description of the target documentation.
919− -- GFM syntax can be used for rich text representation.
936+ -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
920 _externalDocsDescription :: Maybe Text
937 _externalDocsDescription :: Maybe Text
922 -- | The URL for the target documentation.
939 -- | The URL for the target documentation.
@@ -949,12 +966,13 @@ data AdditionalProperties
949-- Generic instances
966-- Generic instances
950-------------------------------------------------------------------------------
967-------------------------------------------------------------------------------
969+deriveGeneric ''Server
952deriveGeneric ''Components
970deriveGeneric ''Components
953deriveGeneric ''Header
971deriveGeneric ''Header
954−deriveGeneric ''OAuth2Params
972+deriveGeneric ''OAuth2Flow
973+deriveGeneric ''OAuth2Flows
955deriveGeneric ''Operation
974deriveGeneric ''Operation
956deriveGeneric ''Param
975deriveGeneric ''Param
957−deriveGeneric ''ParamOtherSchema
958deriveGeneric ''PathItem
976deriveGeneric ''PathItem
959deriveGeneric ''Response
977deriveGeneric ''Response
960deriveGeneric ''RequestBody
978deriveGeneric ''RequestBody
@@ -962,18 +980,18 @@ deriveGeneric ''MediaTypeObject
962deriveGeneric ''Responses
980deriveGeneric ''Responses
963deriveGeneric ''SecurityScheme
981deriveGeneric ''SecurityScheme
964deriveGeneric ''Schema
982deriveGeneric ''Schema
965−deriveGeneric ''ParamSchema
983+deriveGeneric ''OpenApi
966−deriveGeneric ''Swagger
967deriveGeneric ''Example
984deriveGeneric ''Example
968deriveGeneric ''Encoding
985deriveGeneric ''Encoding
970-- =======================================================================
988-- =======================================================================
971-- Monoid instances
989-- Monoid instances
972-- =======================================================================
990-- =======================================================================
974−instance Semigroup Swagger where
992+instance Semigroup OpenApi where
975 (<>) = genericMappend
993 (<>) = genericMappend
976−instance Monoid Swagger where
994+instance Monoid OpenApi where
977 mempty = genericMempty
995 mempty = genericMempty
978 mappend = (<>)
996 mappend = (<>)
@@ -1007,24 +1025,12 @@ instance Monoid Schema where
1007 mempty = genericMempty
1025 mempty = genericMempty
1008 mappend = (<>)
1026 mappend = (<>)
1010−instance Semigroup (ParamSchema t) where
1011− (<>) = genericMappend
1012−instance Monoid (ParamSchema t) where
1013− mempty = genericMempty
1016instance Semigroup Param where
1028instance Semigroup Param where
1017 (<>) = genericMappend
1029 (<>) = genericMappend
1018instance Monoid Param where
1030instance Monoid Param where
1019 mempty = genericMempty
1031 mempty = genericMempty
1020 mappend = (<>)
1032 mappend = (<>)
1022−instance Semigroup ParamOtherSchema where
1023− (<>) = genericMappend
1024−instance Monoid ParamOtherSchema where
1025− mempty = genericMempty
1028instance Semigroup Header where
1034instance Semigroup Header where
1029 (<>) = genericMappend
1035 (<>) = genericMappend
1030instance Monoid Header where
1036instance Monoid Header where
@@ -1067,8 +1073,29 @@ instance Monoid Operation where
1067 mempty = genericMempty
1073 mempty = genericMempty
1068 mappend = (<>)
1074 mappend = (<>)
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 }
1081+-- swaggerMappend has First-like semantics, and here we need mappend'ing under Maybes.
1082+instance Semigroup OAuth2Flows where
1083+ l <> r = OAuth2Flows
1084+ { _oAuth2FlowsImplicit = _oAuth2FlowsImplicit l <> _oAuth2FlowsImplicit r
1085+ , _oAuth2FlowsPassword = _oAuth2FlowsPassword l <> _oAuth2FlowsPassword r
1086+ , _oAuth2FlowsClientCredentials = _oAuth2FlowsClientCredentials l <> _oAuth2FlowsClientCredentials r
1087+ , _oAuth2FlowsAuthorizationCode = _oAuth2FlowsAuthorizationCode l <> _oAuth2FlowsAuthorizationCode r
1090+instance Monoid OAuth2Flows where
1091+ mempty = genericMempty
1070instance Semigroup SecurityScheme where
1094instance Semigroup SecurityScheme where
1071− (<>) = mergeSecurityScheme
1095+ SecurityScheme (SecuritySchemeOAuth2 lFlows) lDesc
1096+ <> SecurityScheme (SecuritySchemeOAuth2 rFlows) rDesc =
1097+ SecurityScheme (SecuritySchemeOAuth2 $ lFlows <> rFlows) (swaggerMappend lDesc rDesc)
1073instance Semigroup SecurityDefinitions where
1100instance Semigroup SecurityDefinitions where
1074 (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
1101 (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
@@ -1078,6 +1105,12 @@ instance Monoid SecurityDefinitions where
1078 mempty = SecurityDefinitions InsOrdHashMap.empty
1105 mempty = SecurityDefinitions InsOrdHashMap.empty
1079 mappend = (<>)
1106 mappend = (<>)
1108+instance Semigroup RequestBody where
1109+ (<>) = genericMappend
1110+instance Monoid RequestBody where
1111+ mempty = genericMempty
1081-- =======================================================================
1114-- =======================================================================
1082-- SwaggerMonoid helper instances
1115-- SwaggerMonoid helper instances
1083-- =======================================================================
1116-- =======================================================================
@@ -1086,21 +1119,19 @@ instance SwaggerMonoid Info
1086instance SwaggerMonoid Components
1119instance SwaggerMonoid Components
1087instance SwaggerMonoid PathItem
1120instance SwaggerMonoid PathItem
1088instance SwaggerMonoid Schema
1121instance SwaggerMonoid Schema
1089−instance SwaggerMonoid (ParamSchema t)
1090instance SwaggerMonoid Param
1122instance SwaggerMonoid Param
1091−instance SwaggerMonoid ParamOtherSchema
1092instance SwaggerMonoid Responses
1123instance SwaggerMonoid Responses
1093instance SwaggerMonoid Response
1124instance SwaggerMonoid Response
1094instance SwaggerMonoid ExternalDocs
1125instance SwaggerMonoid ExternalDocs
1095instance SwaggerMonoid Operation
1126instance SwaggerMonoid Operation
1096−instance SwaggerMonoid SecurityDefinitions
1097instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1127instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1128+instance SwaggerMonoid SecurityDefinitions
1099instance SwaggerMonoid MimeList
1130instance SwaggerMonoid MimeList
1100deriving instance SwaggerMonoid URL
1131deriving instance SwaggerMonoid URL
1102−instance SwaggerMonoid (SwaggerType t) where
1133+instance SwaggerMonoid OpenApiType where
1103− swaggerMempty = SwaggerString
1134+ swaggerMempty = OpenApiString
1104 swaggerMappend _ y = y
1135 swaggerMappend _ y = y
1106instance SwaggerMonoid ParamLocation where
1137instance SwaggerMonoid ParamLocation where
@@ -1116,16 +1147,16 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
1116 swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
1147 swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
1117 swaggerMappend _ y = y
1148 swaggerMappend _ y = y
1119−instance SwaggerMonoid ParamAnySchema where
1120− swaggerMempty = ParamOther swaggerMempty
1121− swaggerMappend (ParamBody x) (ParamBody y) = ParamBody (swaggerMappend x y)
1122− swaggerMappend (ParamOther x) (ParamOther y) = ParamOther (swaggerMappend x y)
1123− swaggerMappend _ y = y
1125-- =======================================================================
1150-- =======================================================================
1126-- Simple Generic-based ToJSON instances
1151-- Simple Generic-based ToJSON instances
1127-- =======================================================================
1152-- =======================================================================
1154+instance ToJSON Style where
1155+ toJSON = genericToJSON (jsonPrefix "Style")
1157+instance ToJSON OpenApiType where
1158+ toJSON = genericToJSON (jsonPrefix "Swagger")
1129instance ToJSON ParamLocation where
1160instance ToJSON ParamLocation where
1130 toJSON = genericToJSON (jsonPrefix "Param")
1161 toJSON = genericToJSON (jsonPrefix "Param")
@@ -1138,9 +1169,6 @@ instance ToJSON Contact where
1138instance ToJSON License where
1169instance ToJSON License where
1139 toJSON = genericToJSON (jsonPrefix "License")
1170 toJSON = genericToJSON (jsonPrefix "License")
1141−instance ToJSON Server where
1142− toJSON = genericToJSON (jsonPrefix "Server")
1144instance ToJSON ServerVariable where
1172instance ToJSON ServerVariable where
1145 toJSON = genericToJSON (jsonPrefix "ServerVariable")
1173 toJSON = genericToJSON (jsonPrefix "ServerVariable")
@@ -1150,9 +1178,6 @@ instance ToJSON ApiKeyLocation where
1150instance ToJSON ApiKeyParams where
1178instance ToJSON ApiKeyParams where
1151 toJSON = genericToJSON (jsonPrefix "apiKey")
1179 toJSON = genericToJSON (jsonPrefix "apiKey")
1153−instance ToJSON Scheme where
1154− toJSON = genericToJSON (jsonPrefix "")
1156instance ToJSON Tag where
1181instance ToJSON Tag where
1157 toJSON = genericToJSON (jsonPrefix "Tag")
1182 toJSON = genericToJSON (jsonPrefix "Tag")
@@ -1165,10 +1190,28 @@ instance ToJSON Xml where
1165instance ToJSON Discriminator where
1190instance ToJSON Discriminator where
1166 toJSON = genericToJSON (jsonPrefix "Discriminator")
1191 toJSON = genericToJSON (jsonPrefix "Discriminator")
1193+instance ToJSON OAuth2ImplicitFlow where
1194+ toJSON = genericToJSON (jsonPrefix "OAuth2ImplicitFlow")
1196+instance ToJSON OAuth2PasswordFlow where
1197+ toJSON = genericToJSON (jsonPrefix "OAuth2PasswordFlow")
1199+instance ToJSON OAuth2ClientCredentialsFlow where
1200+ toJSON = genericToJSON (jsonPrefix "OAuth2ClientCredentialsFlow")
1202+instance ToJSON OAuth2AuthorizationCodeFlow where
1203+ toJSON = genericToJSON (jsonPrefix "OAuth2AuthorizationCodeFlow")
1168-- =======================================================================
1205-- =======================================================================
1169-- Simple Generic-based FromJSON instances
1206-- Simple Generic-based FromJSON instances
1170-- =======================================================================
1207-- =======================================================================
1209+instance FromJSON Style where
1210+ parseJSON = genericParseJSON (jsonPrefix "Style")
1212+instance FromJSON OpenApiType where
1213+ parseJSON = genericParseJSON (jsonPrefix "Swagger")
1172instance FromJSON ParamLocation where
1215instance FromJSON ParamLocation where
1173 parseJSON = genericParseJSON (jsonPrefix "Param")
1216 parseJSON = genericParseJSON (jsonPrefix "Param")
@@ -1181,9 +1224,6 @@ instance FromJSON Contact where
1181instance FromJSON License where
1224instance FromJSON License where
1182 parseJSON = genericParseJSON (jsonPrefix "License")
1225 parseJSON = genericParseJSON (jsonPrefix "License")
1184−instance FromJSON Server where
1185− parseJSON = genericParseJSON (jsonPrefix "Server")
1187instance FromJSON ServerVariable where
1227instance FromJSON ServerVariable where
1188 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
1228 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
@@ -1193,9 +1233,6 @@ instance FromJSON ApiKeyLocation where
1193instance FromJSON ApiKeyParams where
1233instance FromJSON ApiKeyParams where
1194 parseJSON = genericParseJSON (jsonPrefix "apiKey")
1234 parseJSON = genericParseJSON (jsonPrefix "apiKey")
1196−instance FromJSON Scheme where
1197− parseJSON = genericParseJSON (jsonPrefix "")
1199instance FromJSON Tag where
1236instance FromJSON Tag where
1200 parseJSON = genericParseJSON (jsonPrefix "Tag")
1237 parseJSON = genericParseJSON (jsonPrefix "Tag")
@@ -1205,54 +1242,82 @@ instance FromJSON ExternalDocs where
1205instance FromJSON Discriminator where
1242instance FromJSON Discriminator where
1206 parseJSON = genericParseJSON (jsonPrefix "Discriminator")
1243 parseJSON = genericParseJSON (jsonPrefix "Discriminator")
1245+instance FromJSON OAuth2ImplicitFlow where
1246+ parseJSON = genericParseJSON (jsonPrefix "OAuth2ImplicitFlow")
1248+instance FromJSON OAuth2PasswordFlow where
1249+ parseJSON = genericParseJSON (jsonPrefix "OAuth2PasswordFlow")
1251+instance FromJSON OAuth2ClientCredentialsFlow where
1252+ parseJSON = genericParseJSON (jsonPrefix "OAuth2ClientCredentialsFlow")
1254+instance FromJSON OAuth2AuthorizationCodeFlow where
1255+ parseJSON = genericParseJSON (jsonPrefix "OAuth2AuthorizationCodeFlow")
1208-- =======================================================================
1257-- =======================================================================
1209-- Manual ToJSON instances
1258-- Manual ToJSON instances
1210-- =======================================================================
1259-- =======================================================================
1212−instance ToJSON OAuth2Flow where
1261+instance ToJSON MediaType where
1213− toJSON (OAuth2Implicit authUrl) = object
1262+ toJSON = toJSON . show
1214− [ "flow" .= ("implicit" :: Text)
1263+ toEncoding = toEncoding . show
1215− , "authorizationUrl" .= authUrl ]
1264+
1216− toJSON (OAuth2Password tokenUrl) = object
1265+instance ToJSONKey MediaType where
1217− [ "flow" .= ("password" :: Text)
1266+ toJSONKey = JSON.toJSONKeyText (Text.pack . show)
1218− , "tokenUrl" .= tokenUrl ]
1267+
1219− toJSON (OAuth2Application tokenUrl) = object
1268+instance (Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) where
1220− [ "flow" .= ("application" :: Text)
1269+ toJSON = sopSwaggerGenericToJSON
1221− , "tokenUrl" .= tokenUrl ]
1270+ toEncoding = sopSwaggerGenericToEncoding
1222− toJSON (OAuth2AccessCode authUrl tokenUrl) = object
1271+
1223− [ "flow" .= ("accessCode" :: Text)
1224− , "authorizationUrl" .= authUrl
1225− , "tokenUrl" .= tokenUrl ]
1227−instance ToJSON OAuth2Params where
1272+instance ToJSON OAuth2Flows where
1228 toJSON = sopSwaggerGenericToJSON
1273 toJSON = sopSwaggerGenericToJSON
1229 toEncoding = sopSwaggerGenericToEncoding
1274 toEncoding = sopSwaggerGenericToEncoding
1231instance ToJSON SecuritySchemeType where
1276instance ToJSON SecuritySchemeType where
1232− 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 ->
1233− = object [ "type" .= ("http" :: Text) ]
1287+ object [ "type" .= ("http" :: Text)
1234 toJSON (SecuritySchemeApiKey params)
1290 toJSON (SecuritySchemeApiKey params)
1235 = toJSON params
1291 = toJSON params
1236 <+> object [ "type" .= ("apiKey" :: Text) ]
1292 <+> object [ "type" .= ("apiKey" :: Text) ]
1237− toJSON (SecuritySchemeOAuth2 params)
1293+ toJSON (SecuritySchemeOAuth2 params) = object
1239− <+> object [ "type" .= ("oauth2" :: Text) ]
1294+ [ "type" .= ("oauth2" :: Text)
1295+ , "flows" .= toJSON params
1297+ toJSON (SecuritySchemeOpenIdConnect url) = object
1298+ [ "type" .= ("openIdConnect" :: Text)
1299+ , "openIdConnectUrl" .= url
1241−instance ToJSON Swagger where
1302+instance ToJSON OpenApi where
1242 toJSON a = sopSwaggerGenericToJSON a &
1303 toJSON a = sopSwaggerGenericToJSON a &
1243− if InsOrdHashMap.null (_swaggerPaths a)
1304+ if InsOrdHashMap.null (_openApiPaths a)
1244 then (<+> object ["paths" .= object []])
1305 then (<+> object ["paths" .= object []])
1246 toEncoding = sopSwaggerGenericToEncoding
1307 toEncoding = sopSwaggerGenericToEncoding
1248−instance ToJSON SecurityScheme where
1309+instance ToJSON Server where
1249 toJSON = sopSwaggerGenericToJSON
1310 toJSON = sopSwaggerGenericToJSON
1250 toEncoding = sopSwaggerGenericToEncoding
1311 toEncoding = sopSwaggerGenericToEncoding
1252−instance ToJSON Schema where
1313+instance ToJSON SecurityScheme where
1253 toJSON = sopSwaggerGenericToJSON
1314 toJSON = sopSwaggerGenericToJSON
1254 toEncoding = sopSwaggerGenericToEncoding
1315 toEncoding = sopSwaggerGenericToEncoding
1317+instance ToJSON Schema where
1318+ toJSON = sopSwaggerGenericToJSONWithOpts $
1319+ mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1256instance ToJSON Header where
1321instance ToJSON Header where
1257 toJSON = sopSwaggerGenericToJSON
1322 toJSON = sopSwaggerGenericToJSON
1258 toEncoding = sopSwaggerGenericToEncoding
1323 toEncoding = sopSwaggerGenericToEncoding
@@ -1260,31 +1325,26 @@ instance ToJSON Header where
1260-- | As for nullary schema for 0-arity type constructors, see
1325-- | As for nullary schema for 0-arity type constructors, see
1261-- <https://github.com/GetShopTV/swagger2/issues/167>.
1326-- <https://github.com/GetShopTV/swagger2/issues/167>.
1263−-- >>> encode (SwaggerItemsArray [])
1328+-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1264−-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1332+-- "maxItems": 0
1266−instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
1335+instance ToJSON OpenApiItems where
1267− toJSON (SwaggerItemsPrimitive fmt schema) = object
1336+ toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1268− [ "collectionFormat" .= fmt
1269− , "items" .= schema ]
1270− toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1271− toJSON (SwaggerItemsArray []) = object
1337+ toJSON (OpenApiItemsArray []) = object
1272 [ "items" .= object []
1338 [ "items" .= object []
1273 , "maxItems" .= (0 :: Int)
1339 , "maxItems" .= (0 :: Int)
1274 , "example" .= Array mempty
1340 , "example" .= Array mempty
1276− toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1342+ toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
1278instance ToJSON Components where
1344instance ToJSON Components where
1279 toJSON = sopSwaggerGenericToJSON
1345 toJSON = sopSwaggerGenericToJSON
1280 toEncoding = sopSwaggerGenericToEncoding
1346 toEncoding = sopSwaggerGenericToEncoding
1282−instance ToJSON Host where
1283− toJSON (Host host mport) = toJSON $
1286− Just port -> host ++ ":" ++ show port
1288instance ToJSON MimeList where
1348instance ToJSON MimeList where
1289 toJSON (MimeList xs) = toJSON (map show xs)
1349 toJSON (MimeList xs) = toJSON (map show xs)
@@ -1292,14 +1352,6 @@ instance ToJSON Param where
1292 toJSON = sopSwaggerGenericToJSON
1352 toJSON = sopSwaggerGenericToJSON
1293 toEncoding = sopSwaggerGenericToEncoding
1353 toEncoding = sopSwaggerGenericToEncoding
1295−instance ToJSON ParamAnySchema where
1296− toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1297− toJSON (ParamOther s) = toJSON s
1299−instance ToJSON ParamOtherSchema where
1300− toJSON = sopSwaggerGenericToJSON
1301− toEncoding = sopSwaggerGenericToEncoding
1303instance ToJSON Responses where
1355instance ToJSON Responses where
1304 toJSON = sopSwaggerGenericToJSON
1356 toJSON = sopSwaggerGenericToJSON
1305 toEncoding = sopSwaggerGenericToEncoding
1357 toEncoding = sopSwaggerGenericToEncoding
@@ -1332,6 +1384,10 @@ instance ToJSON Encoding where
1332 toJSON = sopSwaggerGenericToJSON
1384 toJSON = sopSwaggerGenericToJSON
1333 toEncoding = sopSwaggerGenericToEncoding
1385 toEncoding = sopSwaggerGenericToEncoding
1387+instance ToJSON Link where
1388+ toJSON = sopSwaggerGenericToJSON
1389+ toEncoding = sopSwaggerGenericToEncoding
1335instance ToJSON SecurityDefinitions where
1391instance ToJSON SecurityDefinitions where
1336 toJSON (SecurityDefinitions sd) = toJSON sd
1392 toJSON (SecurityDefinitions sd) = toJSON sd
@@ -1348,64 +1404,57 @@ instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/compone
1348instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1404instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1349instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1405instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1350instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1406instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1351−
1407+instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1352−instance ToJSON (SwaggerType t) where
1408+instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
1353− toJSON SwaggerArray = "array"
1354− toJSON SwaggerString = "string"
1355− toJSON SwaggerInteger = "integer"
1356− toJSON SwaggerNumber = "number"
1357− toJSON SwaggerBoolean = "boolean"
1358− toJSON SwaggerFile = "file"
1359− toJSON SwaggerNull = "null"
1360− toJSON SwaggerObject = "object"
1362−instance ToJSON (CollectionFormat t) where
1363− toJSON CollectionCSV = "csv"
1364− toJSON CollectionSSV = "ssv"
1365− toJSON CollectionTSV = "tsv"
1366− toJSON CollectionPipes = "pipes"
1367− toJSON CollectionMulti = "multi"
1369−instance ToJSON (ParamSchema k) where
1370− -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1371− toJSON = sopSwaggerGenericToJSONWithOpts $
1372− mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1374instance ToJSON AdditionalProperties where
1410instance ToJSON AdditionalProperties where
1375 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1411 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1376 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
1378-- =======================================================================
1421-- =======================================================================
1379-- Manual FromJSON instances
1422-- Manual FromJSON instances
1380-- =======================================================================
1423-- =======================================================================
1382−instance FromJSON OAuth2Flow where
1425+instance FromJSON MediaType where
1383− parseJSON (Object o) = do
1426+ parseJSON = withText "MediaType" $ \str ->
1384− (flow :: Text) <- o .: "flow"
1427+ maybe (fail $ "Invalid media type literal " <> Text.unpack str) pure $ parseAccept $ encodeUtf8 str
1386− "implicit" -> OAuth2Implicit <$> o .: "authorizationUrl"
1429+instance FromJSONKey MediaType where
1387− "password" -> OAuth2Password <$> o .: "tokenUrl"
1430+ fromJSONKey = FromJSONKeyTextParser (parseJSON . String)
1388− "application" -> OAuth2Application <$> o .: "tokenUrl"
1431+
1389− "accessCode" -> OAuth2AccessCode
1432+instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1390− <$> o .: "authorizationUrl"
1433+ parseJSON = sopSwaggerGenericParseJSON
1391− <*> o .: "tokenUrl"
1393− parseJSON _ = empty
1395−instance FromJSON OAuth2Params where
1435+instance FromJSON OAuth2Flows where
1396 parseJSON = sopSwaggerGenericParseJSON
1436 parseJSON = sopSwaggerGenericParseJSON
1398instance FromJSON SecuritySchemeType where
1438instance FromJSON SecuritySchemeType where
1399 parseJSON js@(Object o) = do
1439 parseJSON js@(Object o) = do
1400 (t :: Text) <- o .: "type"
1440 (t :: Text) <- o .: "type"
1401 case t of
1441 case t of
1443+ scheme <- o .: "scheme"
1402− "http" -> pure SecuritySchemeHttp
1444+ SecuritySchemeHttp <$> case scheme of
1445+ "bearer" -> HttpSchemeBearer <$> (o .:! "bearerFormat")
1446+ "basic" -> pure HttpSchemeBasic
1447+ t -> pure $ HttpSchemeCustom t
1403 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1448 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1404− "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
1449+ "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1450+ "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1405 _ -> empty
1451 _ -> empty
1406 parseJSON _ = empty
1452 parseJSON _ = empty
1408−instance FromJSON Swagger where
1454+instance FromJSON OpenApi where
1455+ parseJSON = sopSwaggerGenericParseJSON
1457+instance FromJSON Server where
1409 parseJSON = sopSwaggerGenericParseJSON
1458 parseJSON = sopSwaggerGenericParseJSON
1411instance FromJSON SecurityScheme where
1460instance FromJSON SecurityScheme where
@@ -1414,78 +1463,36 @@ instance FromJSON SecurityScheme where
1414instance FromJSON Schema where
1463instance FromJSON Schema where
1415 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1464 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1416 where nullaryCleanup :: Schema -> Schema
1465 where nullaryCleanup :: Schema -> Schema
1417− nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1466+ nullaryCleanup s =
1418− if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1467+ if _schemaItems s == Just (OpenApiItemsArray [])
1419 then s { _schemaExample = Nothing
1468 then s { _schemaExample = Nothing
1420− , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1469+ , _schemaMaxItems = Nothing
1423instance FromJSON Header where
1473instance FromJSON Header where
1424 parseJSON = sopSwaggerGenericParseJSON
1474 parseJSON = sopSwaggerGenericParseJSON
1426−instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1476+instance FromJSON OpenApiItems where
1427− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1428− <$> o .:? "collectionFormat"
1429− <*> (o .: "items" >>= parseJSON)
1431−instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1432− parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1433− <$> o .:? "collectionFormat"
1434− <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1438−-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1439−-- Just (SwaggerItemsArray [])
1441−-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1442−-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1444−-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1445−-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1447−instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1448 parseJSON js@(Object obj)
1477 parseJSON js@(Object obj)
1449− | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1478+ | null obj = pure $ OpenApiItemsArray [] -- Nullary schema.
1450− | otherwise = SwaggerItemsObject <$> parseJSON js
1479+ | otherwise = OpenApiItemsObject <$> parseJSON js
1451− parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1480+ parseJSON js@(Array _) = OpenApiItemsArray <$> parseJSON js
1452 parseJSON _ = empty
1481 parseJSON _ = empty
1454instance FromJSON Components where
1483instance FromJSON Components where
1455 parseJSON = sopSwaggerGenericParseJSON
1484 parseJSON = sopSwaggerGenericParseJSON
1457−instance FromJSON Host where
1458− parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1459− [host] -> return $ Host host Nothing
1460− [host, port] -> case readMaybe port of
1461− Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1462− Just p -> return $ Host host (Just (fromInteger p))
1463− _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1464− parseJSON _ = empty
1466instance FromJSON MimeList where
1486instance FromJSON MimeList where
1467− parseJSON js = (MimeList . map fromString) <$> parseJSON js
1487+ parseJSON js = MimeList . map fromString <$> parseJSON js
1469instance FromJSON Param where
1489instance FromJSON Param where
1470 parseJSON = sopSwaggerGenericParseJSON
1490 parseJSON = sopSwaggerGenericParseJSON
1472−instance FromJSON ParamAnySchema where
1473− parseJSON js@(Object o) = do
1474− (i :: Text) <- o .: "in"
1477− schema <- o .: "schema"
1478− ParamBody <$> parseJSON schema
1479− _ -> ParamOther <$> parseJSON js
1480− parseJSON _ = empty
1482−instance FromJSON ParamOtherSchema where
1483− parseJSON = sopSwaggerGenericParseJSON
1485instance FromJSON Responses where
1492instance FromJSON Responses where
1486 parseJSON (Object o) = Responses
1493 parseJSON (Object o) = Responses
1487 <$> o .:? "default"
1494 <$> o .:? "default"
1488− <*> (parseJSON (Object (HashMap.delete "default" o)))
1495+ <*> parseJSON (Object (deleteKey "default" o))
1489 parseJSON _ = empty
1496 parseJSON _ = empty
1491instance FromJSON Example where
1498instance FromJSON Example where
@@ -1500,6 +1507,9 @@ instance FromJSON Operation where
1500instance FromJSON PathItem where
1507instance FromJSON PathItem where
1501 parseJSON = sopSwaggerGenericParseJSON
1508 parseJSON = sopSwaggerGenericParseJSON
1510+instance FromJSON SecurityDefinitions where
1511+ parseJSON js = SecurityDefinitions <$> parseJSON js
1503instance FromJSON RequestBody where
1513instance FromJSON RequestBody where
1504 parseJSON = sopSwaggerGenericParseJSON
1514 parseJSON = sopSwaggerGenericParseJSON
@@ -1509,8 +1519,8 @@ instance FromJSON MediaTypeObject where
1509instance FromJSON Encoding where
1519instance FromJSON Encoding where
1510 parseJSON = sopSwaggerGenericParseJSON
1520 parseJSON = sopSwaggerGenericParseJSON
1512−instance FromJSON SecurityDefinitions where
1522+instance FromJSON Link where
1513− parseJSON js = SecurityDefinitions <$> parseJSON js
1523+ parseJSON = sopSwaggerGenericParseJSON
1515instance FromJSON Reference where
1525instance FromJSON Reference where
1516 parseJSON (Object o) = Reference <$> o .: "$ref"
1526 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1535,52 +1545,38 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
1535instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1545instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1536instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1546instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1537instance 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/"
1539instance FromJSON Xml where
1551instance FromJSON Xml where
1540 parseJSON = genericParseJSON (jsonPrefix "xml")
1552 parseJSON = genericParseJSON (jsonPrefix "xml")
1542−instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1543− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1545−instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1546− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1548−instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1549− parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1551−instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1552− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1554−-- NOTE: There aren't collections of 'Schema'
1555−--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1556−-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1558−instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1559− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1561−instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1562− parseJSON = sopSwaggerGenericParseJSON
1563−instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1564− parseJSON = sopSwaggerGenericParseJSON
1565−instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1566− parseJSON = sopSwaggerGenericParseJSON
1568instance FromJSON AdditionalProperties where
1554instance FromJSON AdditionalProperties where
1569 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1555 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1570 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
1566+instance HasSwaggerAesonOptions Server where
1567+ swaggerAesonOptions _ = mkSwaggerAesonOptions "server"
1572instance HasSwaggerAesonOptions Components where
1568instance HasSwaggerAesonOptions Components where
1573 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
1569 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
1574instance HasSwaggerAesonOptions Header where
1570instance HasSwaggerAesonOptions Header where
1575− swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1571+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header"
1576−instance HasSwaggerAesonOptions OAuth2Params where
1572+instance AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) where
1577− swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
1573+ swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "params"
1574+instance HasSwaggerAesonOptions OAuth2Flows where
1575+ swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2Flows"
1578instance HasSwaggerAesonOptions Operation where
1576instance HasSwaggerAesonOptions Operation where
1579 swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
1577 swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
1580instance HasSwaggerAesonOptions Param where
1578instance HasSwaggerAesonOptions Param where
1581− swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1579+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param"
1582−instance HasSwaggerAesonOptions ParamOtherSchema where
1583− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1584instance HasSwaggerAesonOptions PathItem where
1580instance HasSwaggerAesonOptions PathItem where
1585 swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
1581 swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
1586instance HasSwaggerAesonOptions Response where
1582instance HasSwaggerAesonOptions Response where
@@ -1595,29 +1591,29 @@ instance HasSwaggerAesonOptions SecurityScheme where
1595 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1591 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1596instance HasSwaggerAesonOptions Schema where
1592instance HasSwaggerAesonOptions Schema where
1597 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1593 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1598−instance HasSwaggerAesonOptions Swagger where
1594+instance HasSwaggerAesonOptions OpenApi where
1599− swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.3")]
1595+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1600instance HasSwaggerAesonOptions Example where
1596instance HasSwaggerAesonOptions Example where
1601 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1597 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1602instance HasSwaggerAesonOptions Encoding where
1598instance HasSwaggerAesonOptions Encoding where
1603 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1599 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1605−instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1601+instance HasSwaggerAesonOptions Link where
1606− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1607−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1608− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1609−-- NOTE: Schema doesn't have 'items' sub object!
1610−instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1611− swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1602+ swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
1604+instance AesonDefaultValue Server
1613instance AesonDefaultValue Components
1605instance AesonDefaultValue Components
1614−instance AesonDefaultValue (ParamSchema s)
1606+instance AesonDefaultValue OAuth2ImplicitFlow
1615−instance AesonDefaultValue OAuth2Flow
1607+instance AesonDefaultValue OAuth2PasswordFlow
1608+instance AesonDefaultValue OAuth2ClientCredentialsFlow
1609+instance AesonDefaultValue OAuth2AuthorizationCodeFlow
1610+instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1616instance AesonDefaultValue Responses
1611instance AesonDefaultValue Responses
1617−instance AesonDefaultValue ParamAnySchema
1618instance AesonDefaultValue SecuritySchemeType
1612instance AesonDefaultValue SecuritySchemeType
1619−instance AesonDefaultValue (SwaggerType a)
1613+instance AesonDefaultValue OpenApiType
1620instance AesonDefaultValue MimeList where defaultValue = Just mempty
1614instance AesonDefaultValue MimeList where defaultValue = Just mempty
1621instance AesonDefaultValue Info
1615instance AesonDefaultValue Info
1622instance AesonDefaultValue ParamLocation
1616instance AesonDefaultValue ParamLocation
1623−instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty
1617+instance AesonDefaultValue Link
1618+instance AesonDefaultValue SecurityDefinitions where
1619+ defaultValue = Just mempty