@@ -1,6 +1,6 @@
2{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
3{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4{-# LANGUAGE DeriveGeneric #-}
4{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveTraversable #-}
5{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleContexts #-}
@@ -14,91 +14,87 @@
14{-# LANGUAGE TemplateHaskell #-}
14{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE UndecidableInstances #-}
16{-# LANGUAGE UndecidableInstances #-}
17−module Data.OpenApi.Internal where
17+module Data.Swagger.Internal where
19import Prelude ()
19import Prelude ()
20import Prelude.Compat
20import Prelude.Compat
22+import Control.Lens ((&), (.~), (?~))
22import Control.Applicative
23import 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
28−import qualified Data.Aeson.Types as JSON
25+import qualified Data.Aeson.Types as JSON
29−import Data.Data (Constr, Data (..), DataType, Fixity (..), Typeable,
26+import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
30− constrIndex, mkConstr, mkDataType)
31−import Data.Hashable (Hashable (..))
27+import Data.Hashable (Hashable)
32−import qualified Data.HashMap.Strict as HashMap
28+import qualified Data.HashMap.Strict as HashMap
33−import Data.HashSet.InsOrd (InsOrdHashSet)
29+import Data.HashSet.InsOrd (InsOrdHashSet)
34−import Data.Map (Map)
30+import Data.Map (Map)
35−import qualified Data.Map as Map
31+import qualified Data.Map as Map
36−import Data.Monoid (Monoid (..))
32+import Data.Monoid (Monoid (..))
37−import Data.Scientific (Scientific)
38−import Data.Semigroup.Compat (Semigroup (..))
33+import Data.Semigroup.Compat (Semigroup (..))
34+import Data.Scientific (Scientific)
39−import Data.String (IsString (..))
35+import Data.String (IsString(..))
40−import Data.Text (Text)
36+import Data.Text (Text)
41−import qualified Data.Text as Text
37+import qualified Data.Text as Text
42−import Data.Text.Encoding (encodeUtf8)
43−import GHC.Generics (Generic)
38+import GHC.Generics (Generic)
44−import Network.HTTP.Media (MediaType, mainType, parameters, parseAccept, subType, (//),
39+import Network.Socket (HostName, PortNumber)
45− (/:))
40+import Network.HTTP.Media (MediaType)
46−import Network.Socket (HostName, PortNumber)
47−import Text.Read (readMaybe)
41+import Text.Read (readMaybe)
49import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
43import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
50import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
44import 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
58import Generics.SOP.TH (deriveGeneric)
46import 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)
61-- >>> :seti -XDataKinds
59-- >>> :seti -XDataKinds
62-- >>> import Data.Aeson
60-- >>> import Data.Aeson
63−-- >>> import Data.ByteString.Lazy.Char8 as BSL
64−-- >>> import Data.OpenApi.Internal.Utils
66-- | A list of definitions that can be used in references.
62-- | A list of definitions that can be used in references.
67type Definitions = InsOrdHashMap Text
63type Definitions = InsOrdHashMap Text
69-- | This is the root document object for the API specification.
65-- | This is the root document object for the API specification.
70−data OpenApi = OpenApi
66+data Swagger = Swagger
71 { -- | Provides metadata about the API.
67 { -- | Provides metadata about the API.
72 -- The metadata can be used by the clients if needed.
68 -- The metadata can be used by the clients if needed.
73− _openApiInfo :: Info
69+ _swaggerInfo :: Info
75 -- | An array of Server Objects, which provide connectivity information
71 -- | An array of Server Objects, which provide connectivity information
76 -- to a target server. If the servers property is not provided, or is an empty array,
72 -- to a target server. If the servers property is not provided, or is an empty array,
77 -- the default value would be a 'Server' object with a url value of @/@.
73 -- the default value would be a 'Server' object with a url value of @/@.
78− , _openApiServers :: [Server]
74+ , _swaggerServers :: [Server]
80 -- | The available paths and operations for the API.
76 -- | The available paths and operations for the API.
81− , _openApiPaths :: InsOrdHashMap FilePath PathItem
77+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
83 -- | An element to hold various schemas for the specification.
79 -- | An element to hold various schemas for the specification.
84− , _openApiComponents :: Components
80+ , _swaggerComponents :: Components
86 -- | A declaration of which security mechanisms can be used across the API.
82 -- | A declaration of which security mechanisms can be used across the API.
87 -- The list of values includes alternative security requirement objects that can be used.
83 -- The list of values includes alternative security requirement objects that can be used.
88 -- Only one of the security requirement objects need to be satisfied to authorize a request.
84 -- Only one of the security requirement objects need to be satisfied to authorize a request.
89 -- Individual operations can override this definition.
85 -- Individual operations can override this definition.
90 -- To make security optional, an empty security requirement can be included in the array.
86 -- To make security optional, an empty security requirement can be included in the array.
91− , _openApiSecurity :: [SecurityRequirement]
87+ , _swaggerSecurity :: [SecurityRequirement]
93 -- | A list of tags used by the specification with additional metadata.
89 -- | A list of tags used by the specification with additional metadata.
94 -- The order of the tags can be used to reflect on their order by the parsing tools.
90 -- The order of the tags can be used to reflect on their order by the parsing tools.
95 -- Not all tags that are used by the 'Operation' Object must be declared.
91 -- Not all tags that are used by the 'Operation' Object must be declared.
96 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
92 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
97 -- Each tag name in the list MUST be unique.
93 -- Each tag name in the list MUST be unique.
98− , _openApiTags :: InsOrdHashSet Tag
94+ , _swaggerTags :: InsOrdHashSet Tag
100 -- | Additional external documentation.
96 -- | Additional external documentation.
101− , _openApiExternalDocs :: Maybe ExternalDocs
97+ , _swaggerExternalDocs :: Maybe ExternalDocs
102 } deriving (Eq, Show, Generic, Data, Typeable)
98 } deriving (Eq, Show, Generic, Data, Typeable)
104-- | The object provides metadata about the API.
100-- | The object provides metadata about the API.
@@ -195,10 +191,10 @@ data Components = Components
195 , _componentsParameters :: Definitions Param
191 , _componentsParameters :: Definitions Param
196 , _componentsExamples :: Definitions Example
192 , _componentsExamples :: Definitions Example
197 , _componentsRequestBodies :: Definitions RequestBody
193 , _componentsRequestBodies :: Definitions RequestBody
198− , _componentsHeaders :: Definitions Header
194+ , _componentsHeader :: Definitions Header
199− , _componentsSecuritySchemes :: SecurityDefinitions
195+ , _componentsSecuritySchemes :: Definitions SecurityScheme
200− , _componentsLinks :: Definitions Link
196+-- , _componentsLinks
201− , _componentsCallbacks :: Definitions Callback
197+-- , _componentsCallbacks
202 } deriving (Eq, Show, Generic, Data, Typeable)
198 } deriving (Eq, Show, Generic, Data, Typeable)
204-- | Describes the operations available on a single path.
200-- | Describes the operations available on a single path.
@@ -288,11 +284,7 @@ data Operation = Operation
288 -- | The list of possible responses as they are returned from executing this operation.
284 -- | The list of possible responses as they are returned from executing this operation.
289 , _operationResponses :: Responses
285 , _operationResponses :: Responses
291− -- | A map of possible out-of band callbacks related to the parent operation.
287+ -- TODO callbacks
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)
297 -- | Declares this operation to be deprecated.
289 -- | Declares this operation to be deprecated.
298 -- Usage of the declared operation should be refrained.
290 -- Usage of the declared operation should be refrained.
@@ -312,22 +304,6 @@ data Operation = Operation
312 , _operationServers :: [Server]
304 , _operationServers :: [Server]
313 } deriving (Eq, Show, Generic, Data, Typeable)
305 } 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
331-- | Describes a single request body.
307-- | Describes a single request body.
332data RequestBody = RequestBody
308data RequestBody = RequestBody
333 { -- | A brief description of the request body. This could contain examples of use.
309 { -- | A brief description of the request body. This could contain examples of use.
@@ -337,11 +313,9 @@ data RequestBody = RequestBody
337 -- | The content of the request body.
313 -- | The content of the request body.
338 -- The key is a media type or media type range and the value describes it.
314 -- The key is a media type or media type range and the value describes it.
339 -- For requests that match multiple keys, only the most specific key is applicable.
315 -- For requests that match multiple keys, only the most specific key is applicable.
340− -- e.g. @text/plain@ overrides @text/\*@
316+ -- e.g. @text/plain@ overrides @text/*@
341− , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
317+ , _requestBodyContent :: InsOrdHashMap {-MediaType-} Text MediaTypeObject -- FIXME Data MediaType
343− -- | Determines if the request body is required in the request.
344− -- Defaults to 'False'.
345 , _requestBodyRequired :: Maybe Bool
319 , _requestBodyRequired :: Maybe Bool
346 } deriving (Eq, Show, Generic, Data, Typeable)
320 } deriving (Eq, Show, Generic, Data, Typeable)
@@ -364,29 +338,6 @@ data MediaTypeObject = MediaTypeObject
364 , _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
338 , _mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
365 } deriving (Eq, Show, Generic, Data, Typeable)
339 } 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)
390data Encoding = Encoding
341data Encoding = Encoding
391 { -- | The Content-Type for encoding a specific property.
342 { -- | The Content-Type for encoding a specific property.
392 -- Default value depends on the property type: for @string@
343 -- Default value depends on the property type: for @string@
@@ -394,8 +345,8 @@ data Encoding = Encoding
394 -- for other primitive types – @text/plain@; for object - @application/json@;
345 -- for other primitive types – @text/plain@; for object - @application/json@;
395 -- for array – the default is defined based on the inner type.
346 -- for array – the default is defined based on the inner type.
396 -- The value can be a specific media type (e.g. @application/json@),
347 -- The value can be a specific media type (e.g. @application/json@),
397− -- a wildcard media type (e.g. @image/\*@), or a comma-separated list of the two types.
348+ -- a wildcard media type (e.g. @image/*@), or a comma-separated list of the two types.
398− _encodingContentType :: Maybe MediaType
349+ _encodingContentType :: Maybe Text
400 -- | A map allowing additional information to be provided as headers,
351 -- | A map allowing additional information to be provided as headers,
401 -- for example @Content-Disposition@. @Content-Type@ is described separately
352 -- for example @Content-Disposition@. @Content-Type@ is described separately
@@ -404,11 +355,11 @@ data Encoding = Encoding
404 , _encodingHeaders :: InsOrdHashMap Text (Referenced Header)
355 , _encodingHeaders :: InsOrdHashMap Text (Referenced Header)
406 -- | Describes how a specific property value will be serialized depending on its type.
357 -- | Describes how a specific property value will be serialized depending on its type.
407− -- See 'Param' Object for details on the style property.
358+ -- See Parameter Object for details on the style property.
408 -- The behavior follows the same values as query parameters, including default values.
359 -- The behavior follows the same values as query parameters, including default values.
409 -- This property SHALL be ignored if the request body media type
360 -- This property SHALL be ignored if the request body media type
410 -- is not @application/x-www-form-urlencoded@.
361 -- is not @application/x-www-form-urlencoded@.
411− , _encodingStyle :: Maybe Style
362+ , _encodingStyle :: Maybe Text -- TODO enum
413 -- | When this is true, property values of type @array@ or @object@ generate
364 -- | When this is true, property values of type @array@ or @object@ generate
414 -- separate parameters for each value of the array,
365 -- separate parameters for each value of the array,
@@ -434,15 +385,18 @@ mimeListConstr :: Constr
434mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
385mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
436mimeListDataType :: DataType
387mimeListDataType :: DataType
437−mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
388+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
439instance Data MimeList where
390instance Data MimeList where
440 gunfold k z c = case constrIndex c of
391 gunfold k z c = case constrIndex c of
441− 1 -> k (z (MimeList . map fromString))
392+ 1 -> k (z (\xs -> MimeList (map fromString xs)))
442 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
393 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
443 toConstr (MimeList _) = mimeListConstr
394 toConstr (MimeList _) = mimeListConstr
444 dataTypeOf _ = mimeListDataType
395 dataTypeOf _ = mimeListDataType
446-- | Describes a single operation parameter.
400-- | Describes a single operation parameter.
447-- A unique parameter is defined by a combination of a name and location.
401-- A unique parameter is defined by a combination of a name and location.
448data Param = Param
402data Param = Param
@@ -452,7 +406,7 @@ data Param = Param
453 -- | A brief description of the parameter.
407 -- | A brief description of the parameter.
454 -- This could contain examples of use.
408 -- This could contain examples of use.
455− -- CommonMark syntax MAY be used for rich text representation.
409+ -- GFM syntax can be used for rich text representation.
456 , _paramDescription :: Maybe Text
410 , _paramDescription :: Maybe Text
458 -- | Determines whether this parameter is mandatory.
412 -- | Determines whether this parameter is mandatory.
@@ -470,49 +424,10 @@ data Param = Param
470 -- | Sets the ability to pass empty-valued parameters.
424 -- | Sets the ability to pass empty-valued parameters.
471 -- This is valid only for 'ParamQuery' parameters and allows sending
425 -- This is valid only for 'ParamQuery' parameters and allows sending
472 -- a parameter with an empty value. Default value is @false@.
426 -- a parameter with an empty value. Default value is @false@.
473− , _paramAllowEmptyValue :: Maybe Bool
427+ , _paramOtherSchemaAllowEmptyValue :: 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
482 -- | Parameter schema.
429 -- | Parameter schema.
483 , _paramSchema :: Maybe (Referenced Schema)
430 , _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.
516 } deriving (Eq, Show, Generic, Data, Typeable)
431 } deriving (Eq, Show, Generic, Data, Typeable)
518data Example = Example
433data Example = Example
@@ -537,64 +452,138 @@ data Example = Example
537 , _exampleExternalValue :: Maybe URL
452 , _exampleExternalValue :: Maybe URL
538 } deriving (Eq, Show, Generic, Typeable, Data)
453 } 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)
576−-- | Items for @'OpenApiArray'@ schemas.
455+-- | Items for @'SwaggerArray'@ schemas.
578−-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
457+-- @'SwaggerItemsPrimitive'@ should be used only for query params, headers and path pieces.
579−-- it will incorporate Json Schema mostly verbatim.
458+-- The @'CollectionFormat' t@ parameter specifies how elements of an array should be displayed.
459+-- Note that @fmt@ in @'SwaggerItemsPrimitive' fmt schema@ specifies format for elements of type @schema@.
460+-- This is different from the original Swagger's <http://swagger.io/specification/#itemsObject Items Object>.
581−-- @'OpenApiItemsObject'@ should be used to specify homogenous array @'Schema'@s.
462+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
583−-- @'OpenApiItemsArray'@ should be used to specify tuple @'Schema'@s.
464+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
584−data OpenApiItems where
465+data SwaggerItems t where
585− OpenApiItemsObject :: Referenced Schema -> OpenApiItems
466+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
586− OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems
467+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
587− deriving (Eq, Show, Typeable, Data)
468+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
588−
469+ deriving (Typeable)
589−data OpenApiType where
470+
590− OpenApiString :: OpenApiType
471+deriving instance Eq (SwaggerItems t)
591− OpenApiNumber :: OpenApiType
472+deriving instance Show (SwaggerItems t)
592− OpenApiInteger :: OpenApiType
473+--deriving instance Typeable (SwaggerItems t)
593− OpenApiBoolean :: OpenApiType
474+
594− OpenApiArray :: OpenApiType
475+swaggerItemsPrimitiveConstr :: Constr
595− OpenApiNull :: OpenApiType
476+swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
596− OpenApiObject :: OpenApiType
477+
597− deriving (Eq, Show, Typeable, Generic, Data)
478+swaggerItemsObjectConstr :: Constr
479+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
481+swaggerItemsArrayConstr :: Constr
482+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
484+swaggerItemsDataType :: DataType
485+swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
487+-- Note: unfortunately we have to write these Data instances by hand,
488+-- to get better contexts / avoid duplicate name when using standalone deriving
490+instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
491+ -- TODO: define gfoldl
492+ gunfold k z c = case constrIndex c of
493+ 1 -> k (k (z SwaggerItemsPrimitive))
494+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
495+ toConstr _ = swaggerItemsPrimitiveConstr
496+ dataTypeOf _ = swaggerItemsDataType
498+-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
499+instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
500+ -- TODO: define gfoldl
501+ gunfold k z c = case constrIndex c of
502+ 1 -> k (k (z SwaggerItemsPrimitive))
503+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
504+ toConstr _ = swaggerItemsPrimitiveConstr
505+ dataTypeOf _ = swaggerItemsDataType
507+instance Data (SwaggerItems 'SwaggerKindSchema) where
508+ gfoldl _ _ (SwaggerItemsPrimitive _ _) = error " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
509+ gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
510+ gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
512+ gunfold k z c = case constrIndex c of
513+ 2 -> k (z SwaggerItemsObject)
514+ 3 -> k (z SwaggerItemsArray)
515+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
517+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
518+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
519+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
521+ dataTypeOf _ = swaggerItemsDataType
523+-- | Type used as a kind to avoid overlapping instances.
525+ = SwaggerKindNormal t
526+ | SwaggerKindParamOtherSchema
530+deriving instance Typeable 'SwaggerKindNormal
531+deriving instance Typeable 'SwaggerKindParamOtherSchema
532+deriving instance Typeable 'SwaggerKindSchema
535+type family SwaggerKindType (k :: SwaggerKind *) :: *
536+type instance SwaggerKindType ('SwaggerKindNormal t) = t
537+type instance SwaggerKindType 'SwaggerKindSchema = Schema
538+--type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
540+data SwaggerType t where
541+ SwaggerString :: SwaggerType t
542+ SwaggerNumber :: SwaggerType t
543+ SwaggerInteger :: SwaggerType t
544+ SwaggerBoolean :: SwaggerType t
545+ SwaggerArray :: SwaggerType t
546+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
547+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
548+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
551+deriving instance Eq (SwaggerType t)
552+deriving instance Show (SwaggerType t)
554+swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
555+swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
557+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
558+swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
560+swaggerCommonTypes :: [SwaggerType k]
561+swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
563+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
564+swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
566+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
567+swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
569+swaggerTypeConstrs :: [Constr]
570+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
571+ ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
573+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
574+ gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
575+ toConstr = swaggerTypeConstr
576+ dataTypeOf = swaggerTypeDataType
578+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
579+ gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
580+ toConstr = swaggerTypeConstr
581+ dataTypeOf = swaggerTypeDataType
583+instance Data (SwaggerType 'SwaggerKindSchema) where
584+ gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
585+ toConstr = swaggerTypeConstr
586+ dataTypeOf = swaggerTypeDataType
599data ParamLocation
588data ParamLocation
600 = -- | Parameters that are appended to the URL.
589 = -- | Parameters that are appended to the URL.
@@ -612,6 +601,42 @@ data ParamLocation
613type Format = Text
602type Format = Text
604+-- | Determines the format of the array.
605+data CollectionFormat t where
606+ -- Comma separated values: @foo,bar@.
607+ CollectionCSV :: CollectionFormat t
608+ -- Space separated values: @foo bar@.
609+ CollectionSSV :: CollectionFormat t
610+ -- Tab separated values: @foo\\tbar@.
611+ CollectionTSV :: CollectionFormat t
612+ -- Pipe separated values: @foo|bar@.
613+ CollectionPipes :: CollectionFormat t
614+ -- Corresponds to multiple parameter instances
615+ -- instead of multiple values for a single instance @foo=bar&foo=baz@.
616+ -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
617+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
620+deriving instance Eq (CollectionFormat t)
621+deriving instance Show (CollectionFormat t)
623+collectionFormatConstr :: CollectionFormat t -> Constr
624+collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
626+collectionFormatDataType :: DataType
627+collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
628+ map collectionFormatConstr collectionCommonFormats
630+collectionCommonFormats :: [CollectionFormat t]
631+collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
633+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
634+ gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
635+ toConstr = collectionFormatConstr
636+ dataTypeOf _ = collectionFormatDataType
638+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
615type ParamName = Text
640type ParamName = Text
617data Schema = Schema
642data Schema = Schema
@@ -638,33 +663,9 @@ data Schema = Schema
638 , _schemaMaxProperties :: Maybe Integer
663 , _schemaMaxProperties :: Maybe Integer
639 , _schemaMinProperties :: Maybe Integer
664 , _schemaMinProperties :: Maybe Integer
641− , -- | Declares the value of the parameter that the server will use if none is provided,
666+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
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
663 } deriving (Eq, Show, Generic, Data, Typeable)
667 } deriving (Eq, Show, Generic, Data, Typeable)
665−-- | Regex pattern for @string@ type.
668data Discriminator = Discriminator
669data Discriminator = Discriminator
669 { -- | The name of the property in the payload that will hold the discriminator value.
670 { -- | The name of the property in the payload that will hold the discriminator value.
670 _discriminatorPropertyName :: Text
671 _discriminatorPropertyName :: Text
@@ -680,9 +681,41 @@ data NamedSchema = NamedSchema
680 , _namedSchemaSchema :: Schema
681 , _namedSchemaSchema :: Schema
681 } deriving (Eq, Show, Generic, Data, Typeable)
682 } deriving (Eq, Show, Generic, Data, Typeable)
684+-- | Regex pattern for @string@ type.
687+-- TODO examples for params
689+data ParamSchema (t :: SwaggerKind *) = ParamSchema
690+ { -- | Declares the value of the parameter that the server will use if none is provided,
691+ -- for example a @"count"@ to control the number of results per page might default to @100@
692+ -- if not supplied by the client in the request.
693+ -- (Note: "default" has no meaning for required parameters.)
694+ -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
695+ _paramSchemaDefault :: Maybe Value
697+ , _paramSchemaType :: Maybe (SwaggerType t)
698+ , _paramSchemaFormat :: Maybe Format
699+ , _paramSchemaItems :: Maybe (SwaggerItems t)
700+ , _paramSchemaMaximum :: Maybe Scientific
701+ , _paramSchemaExclusiveMaximum :: Maybe Bool
702+ , _paramSchemaMinimum :: Maybe Scientific
703+ , _paramSchemaExclusiveMinimum :: Maybe Bool
704+ , _paramSchemaMaxLength :: Maybe Integer
705+ , _paramSchemaMinLength :: Maybe Integer
706+ , _paramSchemaPattern :: Maybe Pattern
707+ , _paramSchemaMaxItems :: Maybe Integer
708+ , _paramSchemaMinItems :: Maybe Integer
709+ , _paramSchemaUniqueItems :: Maybe Bool
710+ , _paramSchemaEnum :: Maybe [Value]
711+ , _paramSchemaMultipleOf :: Maybe Scientific
712+ } deriving (Eq, Show, Generic, Typeable)
714+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
683data Xml = Xml
716data Xml = Xml
684 { -- | Replaces the name of the element/attribute used for the described schema property.
717 { -- | Replaces the name of the element/attribute used for the described schema property.
685− -- When defined within the @'OpenApiItems'@ (items), it will affect the name of the individual XML elements within the list.
718+ -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
686 -- When defined alongside type being array (outside the items),
719 -- When defined alongside type being array (outside the items),
687 -- it will affect the wrapping element and only if wrapped is true.
720 -- it will affect the wrapping element and only if wrapped is true.
688 -- If wrapped is false, it will be ignored.
721 -- If wrapped is false, it will be ignored.
@@ -734,46 +767,25 @@ data Response = Response
734 -- | A map containing descriptions of potential response payloads.
767 -- | A map containing descriptions of potential response payloads.
735 -- The key is a media type or media type range and the value describes it.
768 -- The key is a media type or media type range and the value describes it.
736 -- For responses that match multiple keys, only the most specific key is applicable.
769 -- For responses that match multiple keys, only the most specific key is applicable.
737− -- e.g. @text/plain@ overrides @text/\*@.
770+ -- e.g. @text/plain@ overrides @text/*@.
738− , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
771+ , _responseContent :: InsOrdHashMap Text MediaTypeObject
740 -- | Maps a header name to its definition.
773 -- | Maps a header name to its definition.
741 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
774 , _responseHeaders :: InsOrdHashMap HeaderName (Referenced Header)
743− -- | A map of operations links that can be followed from the response.
776+ -- TODO links
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)
747 } deriving (Eq, Show, Generic, Data, Typeable)
777 } deriving (Eq, Show, Generic, Data, Typeable)
749instance IsString Response where
779instance IsString Response where
750− fromString s = Response (fromString s) mempty mempty mempty
780+ fromString s = Response (fromString s) 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)
760type HeaderName = Text
782type 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.
765data Header = Header
784data Header = Header
766 { -- | A short description of the header.
785 { -- | A short description of the header.
767− _headerDescription :: Maybe HeaderName
786+ _headerDescription :: Maybe Text
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)
776− , _headerSchema :: Maybe (Referenced Schema)
788+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
777 } deriving (Eq, Show, Generic, Data, Typeable)
789 } deriving (Eq, Show, Generic, Data, Typeable)
779-- | The location of the API key.
791-- | The location of the API key.
@@ -797,17 +809,17 @@ type AuthorizationURL = Text
797-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
809-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
798type TokenURL = Text
810type TokenURL = Text
800−newtype OAuth2ImplicitFlow
812+data OAuth2ImplicitFlow = OAuth2ImplicitFlow
801− = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
813+ { _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL
802− deriving (Eq, Show, Generic, Data, Typeable)
814+ } deriving (Eq, Show, Generic, Data, Typeable)
804−newtype OAuth2PasswordFlow
816+data OAuth2PasswordFlow = OAuth2PasswordFlow
805− = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
817+ { _oAuth2PasswordFlowTokenUrl :: TokenURL
806− deriving (Eq, Show, Generic, Data, Typeable)
818+ } deriving (Eq, Show, Generic, Data, Typeable)
808−newtype OAuth2ClientCredentialsFlow
820+data OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow
809− = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
821+ { _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL
810− deriving (Eq, Show, Generic, Data, Typeable)
822+ } deriving (Eq, Show, Generic, Data, Typeable)
812data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
824data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
813 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
825 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
@@ -840,50 +852,8 @@ data OAuth2Flows = OAuth2Flows
840 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
852 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
841 } deriving (Eq, Show, Generic, Data, Typeable)
853 } 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))
885data SecuritySchemeType
855data SecuritySchemeType
886− = SecuritySchemeHttp HttpSchemeType
856+ = SecuritySchemeHttp
887 | SecuritySchemeApiKey ApiKeyParams
857 | SecuritySchemeApiKey ApiKeyParams
888 | SecuritySchemeOAuth2 OAuth2Flows
858 | SecuritySchemeOAuth2 OAuth2Flows
889 | SecuritySchemeOpenIdConnect URL
859 | SecuritySchemeOpenIdConnect URL
@@ -897,10 +867,6 @@ data SecurityScheme = SecurityScheme
897 , _securitySchemeDescription :: Maybe Text
867 , _securitySchemeDescription :: Maybe Text
898 } deriving (Eq, Show, Generic, Data, Typeable)
868 } deriving (Eq, Show, Generic, Data, Typeable)
900−newtype SecurityDefinitions
901− = SecurityDefinitions (Definitions SecurityScheme)
902− deriving (Eq, Show, Generic, Data, Typeable)
904-- | Lists the required security schemes to execute this operation.
870-- | Lists the required security schemes to execute this operation.
905-- The object can have multiple security schemes declared in it which are all required
871-- The object can have multiple security schemes declared in it which are all required
906-- (that is, there is a logical AND between the schemes).
872-- (that is, there is a logical AND between the schemes).
@@ -918,7 +884,7 @@ data Tag = Tag
918 _tagName :: TagName
884 _tagName :: TagName
920 -- | A short description for the tag.
886 -- | A short description for the tag.
921− -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
887+ -- GFM syntax can be used for rich text representation.
922 , _tagDescription :: Maybe Text
888 , _tagDescription :: Maybe Text
924 -- | Additional external documentation for this tag.
890 -- | Additional external documentation for this tag.
@@ -933,7 +899,7 @@ instance IsString Tag where
933-- | Allows referencing an external resource for extended documentation.
899-- | Allows referencing an external resource for extended documentation.
934data ExternalDocs = ExternalDocs
900data ExternalDocs = ExternalDocs
935 { -- | A short description of the target documentation.
901 { -- | A short description of the target documentation.
936− -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
902+ -- GFM syntax can be used for rich text representation.
937 _externalDocsDescription :: Maybe Text
903 _externalDocsDescription :: Maybe Text
939 -- | The URL for the target documentation.
905 -- | The URL for the target documentation.
@@ -966,7 +932,6 @@ data AdditionalProperties
966-- Generic instances
932-- Generic instances
967-------------------------------------------------------------------------------
933-------------------------------------------------------------------------------
969−deriveGeneric ''Server
970deriveGeneric ''Components
935deriveGeneric ''Components
971deriveGeneric ''Header
936deriveGeneric ''Header
972deriveGeneric ''OAuth2Flow
937deriveGeneric ''OAuth2Flow
@@ -980,18 +945,18 @@ deriveGeneric ''MediaTypeObject
980deriveGeneric ''Responses
945deriveGeneric ''Responses
981deriveGeneric ''SecurityScheme
946deriveGeneric ''SecurityScheme
982deriveGeneric ''Schema
947deriveGeneric ''Schema
983−deriveGeneric ''OpenApi
948+deriveGeneric ''ParamSchema
949+deriveGeneric ''Swagger
984deriveGeneric ''Example
950deriveGeneric ''Example
985deriveGeneric ''Encoding
951deriveGeneric ''Encoding
988-- =======================================================================
953-- =======================================================================
989-- Monoid instances
954-- Monoid instances
990-- =======================================================================
955-- =======================================================================
992−instance Semigroup OpenApi where
957+instance Semigroup Swagger where
993 (<>) = genericMappend
958 (<>) = genericMappend
994−instance Monoid OpenApi where
959+instance Monoid Swagger where
995 mempty = genericMempty
960 mempty = genericMempty
996 mappend = (<>)
961 mappend = (<>)
@@ -1025,6 +990,12 @@ instance Monoid Schema where
1025 mempty = genericMempty
990 mempty = genericMempty
1026 mappend = (<>)
991 mappend = (<>)
993+instance Semigroup (ParamSchema t) where
994+ (<>) = genericMappend
995+instance Monoid (ParamSchema t) where
996+ mempty = genericMempty
1028instance Semigroup Param where
999instance Semigroup Param where
1029 (<>) = genericMappend
1000 (<>) = genericMappend
1030instance Monoid Param where
1001instance Monoid Param where
@@ -1073,38 +1044,12 @@ instance Monoid Operation where
1073 mempty = genericMempty
1044 mempty = genericMempty
1074 mappend = (<>)
1045 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.
1082instance Semigroup OAuth2Flows where
1047instance Semigroup OAuth2Flows where
1083− l <> r = OAuth2Flows
1048+ (<>) = genericMappend
1084− { _oAuth2FlowsImplicit = _oAuth2FlowsImplicit l <> _oAuth2FlowsImplicit r
1085− , _oAuth2FlowsPassword = _oAuth2FlowsPassword l <> _oAuth2FlowsPassword r
1086− , _oAuth2FlowsClientCredentials = _oAuth2FlowsClientCredentials l <> _oAuth2FlowsClientCredentials r
1087− , _oAuth2FlowsAuthorizationCode = _oAuth2FlowsAuthorizationCode l <> _oAuth2FlowsAuthorizationCode r
1090instance Monoid OAuth2Flows where
1049instance Monoid OAuth2Flows where
1091 mempty = genericMempty
1050 mempty = genericMempty
1092 mappend = (<>)
1051 mappend = (<>)
1094−instance Semigroup SecurityScheme where
1095− SecurityScheme (SecuritySchemeOAuth2 lFlows) lDesc
1096− <> SecurityScheme (SecuritySchemeOAuth2 rFlows) rDesc =
1097− SecurityScheme (SecuritySchemeOAuth2 $ lFlows <> rFlows) (swaggerMappend lDesc rDesc)
1100−instance Semigroup SecurityDefinitions where
1101− (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
1102− SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
1104−instance Monoid SecurityDefinitions where
1105− mempty = SecurityDefinitions InsOrdHashMap.empty
1108instance Semigroup RequestBody where
1053instance Semigroup RequestBody where
1109 (<>) = genericMappend
1054 (<>) = genericMappend
1110instance Monoid RequestBody where
1055instance Monoid RequestBody where
@@ -1119,19 +1064,19 @@ instance SwaggerMonoid Info
1119instance SwaggerMonoid Components
1064instance SwaggerMonoid Components
1120instance SwaggerMonoid PathItem
1065instance SwaggerMonoid PathItem
1121instance SwaggerMonoid Schema
1066instance SwaggerMonoid Schema
1067+instance SwaggerMonoid (ParamSchema t)
1122instance SwaggerMonoid Param
1068instance SwaggerMonoid Param
1123instance SwaggerMonoid Responses
1069instance SwaggerMonoid Responses
1124instance SwaggerMonoid Response
1070instance SwaggerMonoid Response
1125instance SwaggerMonoid ExternalDocs
1071instance SwaggerMonoid ExternalDocs
1126instance SwaggerMonoid Operation
1072instance SwaggerMonoid Operation
1127instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1073instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1128−instance SwaggerMonoid SecurityDefinitions
1130instance SwaggerMonoid MimeList
1075instance SwaggerMonoid MimeList
1131deriving instance SwaggerMonoid URL
1076deriving instance SwaggerMonoid URL
1133−instance SwaggerMonoid OpenApiType where
1078+instance SwaggerMonoid (SwaggerType t) where
1134− swaggerMempty = OpenApiString
1079+ swaggerMempty = SwaggerString
1135 swaggerMappend _ y = y
1080 swaggerMappend _ y = y
1137instance SwaggerMonoid ParamLocation where
1082instance SwaggerMonoid ParamLocation where
@@ -1151,12 +1096,6 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
1151-- Simple Generic-based ToJSON instances
1096-- Simple Generic-based ToJSON instances
1152-- =======================================================================
1097-- =======================================================================
1154−instance ToJSON Style where
1155− toJSON = genericToJSON (jsonPrefix "Style")
1157−instance ToJSON OpenApiType where
1158− toJSON = genericToJSON (jsonPrefix "Swagger")
1160instance ToJSON ParamLocation where
1099instance ToJSON ParamLocation where
1161 toJSON = genericToJSON (jsonPrefix "Param")
1100 toJSON = genericToJSON (jsonPrefix "Param")
@@ -1169,6 +1108,9 @@ instance ToJSON Contact where
1169instance ToJSON License where
1108instance ToJSON License where
1170 toJSON = genericToJSON (jsonPrefix "License")
1109 toJSON = genericToJSON (jsonPrefix "License")
1111+instance ToJSON Server where
1112+ toJSON = genericToJSON (jsonPrefix "Server")
1172instance ToJSON ServerVariable where
1114instance ToJSON ServerVariable where
1173 toJSON = genericToJSON (jsonPrefix "ServerVariable")
1115 toJSON = genericToJSON (jsonPrefix "ServerVariable")
@@ -1206,12 +1148,6 @@ instance ToJSON OAuth2AuthorizationCodeFlow where
1206-- Simple Generic-based FromJSON instances
1148-- Simple Generic-based FromJSON instances
1207-- =======================================================================
1149-- =======================================================================
1209−instance FromJSON Style where
1210− parseJSON = genericParseJSON (jsonPrefix "Style")
1212−instance FromJSON OpenApiType where
1213− parseJSON = genericParseJSON (jsonPrefix "Swagger")
1215instance FromJSON ParamLocation where
1151instance FromJSON ParamLocation where
1216 parseJSON = genericParseJSON (jsonPrefix "Param")
1152 parseJSON = genericParseJSON (jsonPrefix "Param")
@@ -1224,6 +1160,9 @@ instance FromJSON Contact where
1224instance FromJSON License where
1160instance FromJSON License where
1225 parseJSON = genericParseJSON (jsonPrefix "License")
1161 parseJSON = genericParseJSON (jsonPrefix "License")
1163+instance FromJSON Server where
1164+ parseJSON = genericParseJSON (jsonPrefix "Server")
1227instance FromJSON ServerVariable where
1166instance FromJSON ServerVariable where
1228 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
1167 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
@@ -1258,14 +1197,7 @@ instance FromJSON OAuth2AuthorizationCodeFlow where
1258-- Manual ToJSON instances
1197-- Manual ToJSON instances
1259-- =======================================================================
1198-- =======================================================================
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)
1268−instance (Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) where
1200+instance (Eq p, ToJSON p, AesonDefaultValue p) =>ToJSON (OAuth2Flow p) where
1269 toJSON = sopSwaggerGenericToJSON
1201 toJSON = sopSwaggerGenericToJSON
1270 toEncoding = sopSwaggerGenericToEncoding
1202 toEncoding = sopSwaggerGenericToEncoding
@@ -1274,49 +1206,33 @@ instance ToJSON OAuth2Flows where
1274 toEncoding = sopSwaggerGenericToEncoding
1206 toEncoding = sopSwaggerGenericToEncoding
1276instance ToJSON SecuritySchemeType where
1208instance ToJSON SecuritySchemeType where
1277− toJSON (SecuritySchemeHttp ty) = case ty of
1209+ toJSON SecuritySchemeHttp
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 ->
1287− object [ "type" .= ("http" :: Text)
1210+ = object [ "type" .= ("http" :: Text) ]
1290 toJSON (SecuritySchemeApiKey params)
1211 toJSON (SecuritySchemeApiKey params)
1291 = toJSON params
1212 = toJSON params
1292 <+> object [ "type" .= ("apiKey" :: Text) ]
1213 <+> object [ "type" .= ("apiKey" :: Text) ]
1293− toJSON (SecuritySchemeOAuth2 params) = object
1214+ toJSON (SecuritySchemeOAuth2 params)
1294− [ "type" .= ("oauth2" :: Text)
1216+ <+> object [ "type" .= ("oauth2" :: Text) ]
1295− , "flows" .= toJSON params
1297 toJSON (SecuritySchemeOpenIdConnect url) = object
1217 toJSON (SecuritySchemeOpenIdConnect url) = object
1298 [ "type" .= ("openIdConnect" :: Text)
1218 [ "type" .= ("openIdConnect" :: Text)
1299 , "openIdConnectUrl" .= url
1219 , "openIdConnectUrl" .= url
1302−instance ToJSON OpenApi where
1222+instance ToJSON Swagger where
1303 toJSON a = sopSwaggerGenericToJSON a &
1223 toJSON a = sopSwaggerGenericToJSON a &
1304− if InsOrdHashMap.null (_openApiPaths a)
1224+ if InsOrdHashMap.null (_swaggerPaths a)
1305 then (<+> object ["paths" .= object []])
1225 then (<+> object ["paths" .= object []])
1307 toEncoding = sopSwaggerGenericToEncoding
1227 toEncoding = sopSwaggerGenericToEncoding
1309−instance ToJSON Server where
1310− toJSON = sopSwaggerGenericToJSON
1311− toEncoding = sopSwaggerGenericToEncoding
1313instance ToJSON SecurityScheme where
1229instance ToJSON SecurityScheme where
1314 toJSON = sopSwaggerGenericToJSON
1230 toJSON = sopSwaggerGenericToJSON
1315 toEncoding = sopSwaggerGenericToEncoding
1231 toEncoding = sopSwaggerGenericToEncoding
1317instance ToJSON Schema where
1233instance ToJSON Schema where
1318− toJSON = sopSwaggerGenericToJSONWithOpts $
1234+ toJSON = sopSwaggerGenericToJSON
1319− mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1235+ toEncoding = sopSwaggerGenericToEncoding
1321instance ToJSON Header where
1237instance ToJSON Header where
1322 toJSON = sopSwaggerGenericToJSON
1238 toJSON = sopSwaggerGenericToJSON
@@ -1325,21 +1241,20 @@ instance ToJSON Header where
1325-- | As for nullary schema for 0-arity type constructors, see
1241-- | As for nullary schema for 0-arity type constructors, see
1326-- <https://github.com/GetShopTV/swagger2/issues/167>.
1242-- <https://github.com/GetShopTV/swagger2/issues/167>.
1328−-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1244+-- >>> encode (SwaggerItemsArray [])
1332−-- "maxItems": 0
1245+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1335−instance ToJSON OpenApiItems where
1247+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
1336− toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1248+ toJSON (SwaggerItemsPrimitive fmt schema) = object
1249+ [ "collectionFormat" .= fmt
1250+ , "items" .= schema ]
1251+ toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1337− toJSON (OpenApiItemsArray []) = object
1252+ toJSON (SwaggerItemsArray []) = object
1338 [ "items" .= object []
1253 [ "items" .= object []
1339 , "maxItems" .= (0 :: Int)
1254 , "maxItems" .= (0 :: Int)
1340 , "example" .= Array mempty
1255 , "example" .= Array mempty
1342− toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
1257+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1344instance ToJSON Components where
1259instance ToJSON Components where
1345 toJSON = sopSwaggerGenericToJSON
1260 toJSON = sopSwaggerGenericToJSON
@@ -1384,13 +1299,6 @@ instance ToJSON Encoding where
1384 toJSON = sopSwaggerGenericToJSON
1299 toJSON = sopSwaggerGenericToJSON
1385 toEncoding = sopSwaggerGenericToEncoding
1300 toEncoding = sopSwaggerGenericToEncoding
1387−instance ToJSON Link where
1388− toJSON = sopSwaggerGenericToJSON
1389− toEncoding = sopSwaggerGenericToEncoding
1391−instance ToJSON SecurityDefinitions where
1392− toJSON (SecurityDefinitions sd) = toJSON sd
1394instance ToJSON Reference where
1302instance ToJSON Reference where
1395 toJSON (Reference ref) = object [ "$ref" .= ref ]
1303 toJSON (Reference ref) = object [ "$ref" .= ref ]
@@ -1404,31 +1312,37 @@ instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/compone
1404instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1312instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
1405instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1313instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
1406instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1314instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
1407−instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1315+
1408−instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
1316+instance ToJSON (SwaggerType t) where
1317+ toJSON SwaggerArray = "array"
1318+ toJSON SwaggerString = "string"
1319+ toJSON SwaggerInteger = "integer"
1320+ toJSON SwaggerNumber = "number"
1321+ toJSON SwaggerBoolean = "boolean"
1322+ toJSON SwaggerFile = "file"
1323+ toJSON SwaggerNull = "null"
1324+ toJSON SwaggerObject = "object"
1326+instance ToJSON (CollectionFormat t) where
1327+ toJSON CollectionCSV = "csv"
1328+ toJSON CollectionSSV = "ssv"
1329+ toJSON CollectionTSV = "tsv"
1330+ toJSON CollectionPipes = "pipes"
1331+ toJSON CollectionMulti = "multi"
1333+instance ToJSON (ParamSchema k) where
1334+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1335+ toJSON = sopSwaggerGenericToJSONWithOpts $
1336+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1410instance ToJSON AdditionalProperties where
1338instance ToJSON AdditionalProperties where
1411 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1339 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1412 toJSON (AdditionalPropertiesSchema s) = toJSON s
1340 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
1421-- =======================================================================
1342-- =======================================================================
1422-- Manual FromJSON instances
1343-- Manual FromJSON instances
1423-- =======================================================================
1344-- =======================================================================
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)
1432instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1346instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
1433 parseJSON = sopSwaggerGenericParseJSON
1347 parseJSON = sopSwaggerGenericParseJSON
@@ -1439,22 +1353,14 @@ instance FromJSON SecuritySchemeType where
1439 parseJSON js@(Object o) = do
1353 parseJSON js@(Object o) = do
1440 (t :: Text) <- o .: "type"
1354 (t :: Text) <- o .: "type"
1441 case t of
1355 case t of
1443− scheme <- o .: "scheme"
1444− SecuritySchemeHttp <$> case scheme of
1356+ "http" -> pure SecuritySchemeHttp
1445− "bearer" -> HttpSchemeBearer <$> (o .:! "bearerFormat")
1446− "basic" -> pure HttpSchemeBasic
1447− t -> pure $ HttpSchemeCustom t
1448 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1357 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1449− "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1358+ "oauth2" -> SecuritySchemeOAuth2 <$> parseJSON js
1450 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1359 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1451 _ -> empty
1360 _ -> empty
1452 parseJSON _ = empty
1361 parseJSON _ = empty
1454−instance FromJSON OpenApi where
1363+instance FromJSON Swagger where
1455− parseJSON = sopSwaggerGenericParseJSON
1457−instance FromJSON Server where
1458 parseJSON = sopSwaggerGenericParseJSON
1364 parseJSON = sopSwaggerGenericParseJSON
1460instance FromJSON SecurityScheme where
1366instance FromJSON SecurityScheme where
@@ -1463,28 +1369,48 @@ instance FromJSON SecurityScheme where
1463instance FromJSON Schema where
1369instance FromJSON Schema where
1464 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1370 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1465 where nullaryCleanup :: Schema -> Schema
1371 where nullaryCleanup :: Schema -> Schema
1466− nullaryCleanup s =
1372+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1467− if _schemaItems s == Just (OpenApiItemsArray [])
1373+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1468 then s { _schemaExample = Nothing
1374 then s { _schemaExample = Nothing
1469− , _schemaMaxItems = Nothing
1375+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1473instance FromJSON Header where
1378instance FromJSON Header where
1474 parseJSON = sopSwaggerGenericParseJSON
1379 parseJSON = sopSwaggerGenericParseJSON
1476−instance FromJSON OpenApiItems where
1381+instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1382+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1383+ <$> o .:? "collectionFormat"
1384+ <*> (o .: "items" >>= parseJSON)
1386+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1387+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1388+ <$> o .:? "collectionFormat"
1389+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1393+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1394+-- Just (SwaggerItemsArray [])
1396+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1397+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1399+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1400+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1402+instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1477 parseJSON js@(Object obj)
1403 parseJSON js@(Object obj)
1478− | null obj = pure $ OpenApiItemsArray [] -- Nullary schema.
1404+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1479− | otherwise = OpenApiItemsObject <$> parseJSON js
1405+ | otherwise = SwaggerItemsObject <$> parseJSON js
1480− parseJSON js@(Array _) = OpenApiItemsArray <$> parseJSON js
1406+ parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1481 parseJSON _ = empty
1407 parseJSON _ = empty
1483instance FromJSON Components where
1409instance FromJSON Components where
1484 parseJSON = sopSwaggerGenericParseJSON
1410 parseJSON = sopSwaggerGenericParseJSON
1486instance FromJSON MimeList where
1412instance FromJSON MimeList where
1487− parseJSON js = MimeList . map fromString <$> parseJSON js
1413+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
1489instance FromJSON Param where
1415instance FromJSON Param where
1490 parseJSON = sopSwaggerGenericParseJSON
1416 parseJSON = sopSwaggerGenericParseJSON
@@ -1492,7 +1418,7 @@ instance FromJSON Param where
1492instance FromJSON Responses where
1418instance FromJSON Responses where
1493 parseJSON (Object o) = Responses
1419 parseJSON (Object o) = Responses
1494 <$> o .:? "default"
1420 <$> o .:? "default"
1495− <*> parseJSON (Object (deleteKey "default" o))
1421+ <*> (parseJSON (Object (HashMap.delete "default" o)))
1496 parseJSON _ = empty
1422 parseJSON _ = empty
1498instance FromJSON Example where
1424instance FromJSON Example where
@@ -1507,9 +1433,6 @@ instance FromJSON Operation where
1507instance FromJSON PathItem where
1433instance FromJSON PathItem where
1508 parseJSON = sopSwaggerGenericParseJSON
1434 parseJSON = sopSwaggerGenericParseJSON
1510−instance FromJSON SecurityDefinitions where
1511− parseJSON js = SecurityDefinitions <$> parseJSON js
1513instance FromJSON RequestBody where
1436instance FromJSON RequestBody where
1514 parseJSON = sopSwaggerGenericParseJSON
1437 parseJSON = sopSwaggerGenericParseJSON
@@ -1519,9 +1442,6 @@ instance FromJSON MediaTypeObject where
1519instance FromJSON Encoding where
1442instance FromJSON Encoding where
1520 parseJSON = sopSwaggerGenericParseJSON
1443 parseJSON = sopSwaggerGenericParseJSON
1522−instance FromJSON Link where
1523− parseJSON = sopSwaggerGenericParseJSON
1525instance FromJSON Reference where
1445instance FromJSON Reference where
1526 parseJSON (Object o) = Reference <$> o .: "$ref"
1446 parseJSON (Object o) = Reference <$> o .: "$ref"
1527 parseJSON _ = empty
1447 parseJSON _ = empty
@@ -1545,30 +1465,44 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
1545instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1465instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
1546instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1466instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
1547instance FromJSON (Referenced Header) where parseJSON = referencedParseJSON "#/components/headers/"
1467instance 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/"
1551instance FromJSON Xml where
1469instance FromJSON Xml where
1552 parseJSON = genericParseJSON (jsonPrefix "xml")
1470 parseJSON = genericParseJSON (jsonPrefix "xml")
1472+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1473+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1475+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1476+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1478+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1479+ parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1481+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1482+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1484+-- NOTE: There aren't collections of 'Schema'
1485+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1486+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1488+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1489+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1491+instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1492+ parseJSON = sopSwaggerGenericParseJSON
1493+instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1494+ parseJSON = sopSwaggerGenericParseJSON
1495+instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1496+ parseJSON = sopSwaggerGenericParseJSON
1554instance FromJSON AdditionalProperties where
1498instance FromJSON AdditionalProperties where
1555 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1499 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1556 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1500 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"
1568instance HasSwaggerAesonOptions Components where
1502instance HasSwaggerAesonOptions Components where
1569 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
1503 swaggerAesonOptions _ = mkSwaggerAesonOptions "components"
1570instance HasSwaggerAesonOptions Header where
1504instance HasSwaggerAesonOptions Header where
1571− swaggerAesonOptions _ = mkSwaggerAesonOptions "header"
1505+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1572instance AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) where
1506instance AesonDefaultValue p => HasSwaggerAesonOptions (OAuth2Flow p) where
1573 swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "params"
1507 swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "params"
1574instance HasSwaggerAesonOptions OAuth2Flows where
1508instance HasSwaggerAesonOptions OAuth2Flows where
@@ -1591,18 +1525,23 @@ instance HasSwaggerAesonOptions SecurityScheme where
1591 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1525 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1592instance HasSwaggerAesonOptions Schema where
1526instance HasSwaggerAesonOptions Schema where
1593 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1527 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1594−instance HasSwaggerAesonOptions OpenApi where
1528+instance HasSwaggerAesonOptions Swagger where
1595− swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1529+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.3")]
1596instance HasSwaggerAesonOptions Example where
1530instance HasSwaggerAesonOptions Example where
1597 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1531 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1598instance HasSwaggerAesonOptions Encoding where
1532instance HasSwaggerAesonOptions Encoding where
1599 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1533 swaggerAesonOptions _ = mkSwaggerAesonOptions "encoding"
1601−instance HasSwaggerAesonOptions Link where
1535+instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1536+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1537+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1602− swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
1538+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1539+-- NOTE: Schema doesn't have 'items' sub object!
1540+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1541+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1604−instance AesonDefaultValue Server
1605instance AesonDefaultValue Components
1543instance AesonDefaultValue Components
1544+instance AesonDefaultValue (ParamSchema s)
1606instance AesonDefaultValue OAuth2ImplicitFlow
1545instance AesonDefaultValue OAuth2ImplicitFlow
1607instance AesonDefaultValue OAuth2PasswordFlow
1546instance AesonDefaultValue OAuth2PasswordFlow
1608instance AesonDefaultValue OAuth2ClientCredentialsFlow
1547instance AesonDefaultValue OAuth2ClientCredentialsFlow
@@ -1610,10 +1549,7 @@ instance AesonDefaultValue OAuth2AuthorizationCodeFlow
1610instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1549instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1611instance AesonDefaultValue Responses
1550instance AesonDefaultValue Responses
1612instance AesonDefaultValue SecuritySchemeType
1551instance AesonDefaultValue SecuritySchemeType
1613−instance AesonDefaultValue OpenApiType
1552+instance AesonDefaultValue (SwaggerType a)
1614instance AesonDefaultValue MimeList where defaultValue = Just mempty
1553instance AesonDefaultValue MimeList where defaultValue = Just mempty
1615instance AesonDefaultValue Info
1554instance AesonDefaultValue Info
1616instance AesonDefaultValue ParamLocation
1555instance AesonDefaultValue ParamLocation
1617−instance AesonDefaultValue Link
1618−instance AesonDefaultValue SecurityDefinitions where
1619− defaultValue = Just mempty