@@ -1,139 +1,71 @@
1−{-# LANGUAGE CPP #-}
21{-# OPTIONS_GHC -Wno-orphans #-}
32
4−-- | __Example:__
5−--
6−-- >>> :set -XDerivingStrategies -XDerivingVia -XDeriveGeneric
7−--
8−-- >>> :{
9−-- data User = User
10−-- { userFirstName :: String,
11−-- userAge :: Maybe Integer
12−-- }
13−-- deriving stock (Generic)
14−-- deriving (FromJSON, ToJSON, ToSchema)
15−-- via CustomJSON
16−-- '[FieldLabelModifier '[StripPrefix "user", CamelToSnake], RejectUnknownFields]
17−-- User
18−-- showYaml = Data.ByteString.Char8.putStr . Data.Yaml.encode
19−-- :}
20−--
21−-- >>> showYaml $ toSchema (Proxy :: Proxy User)
22−-- type: object
23−-- properties:
24−-- first_name:
25−-- type: string
26−-- age:
27−-- type: integer
28−-- required:
29−-- - first_name
30−-- additionalProperties: false
313module Deriving.OpenApi
324 ( CustomOpenApi,
335 DatatypeNameModifier,
34− ToSchema,
356 module Deriving.Aeson,
367 )
378where
389
39−import Control.Lens
4010import qualified Data.Aeson.Types as A
11+import Data.Kind
4112import Data.OpenApi
42−import Data.OpenApi.Internal.ParamSchema
4313import Data.OpenApi.Internal.Schema
4414import Data.Proxy
45−import Data.Text (Text)
46−import qualified Data.Text as T
47−import Data.Typeable
4815import Deriving.Aeson
4916import GHC.Generics
5017import GHC.TypeLits
5118
52−data Description (desc :: Symbol) = Description
53−
54−instance (AesonOptions xs) => AesonOptions (Description f ': xs) where
55− aesonOptions = aesonOptions @xs
56−
57−instance KnownSymbol t => OpenApiOptionModifier (Description t) where
58− openApiSchemaModifier = schema . description <>~ Just (toTextLine @t)
59−
60−toTextLine :: forall s. KnownSymbol s => Text
61−toTextLine = "\n\n" <> T.pack (symbolVal (Proxy @s))
62−
63−-- $setup
64−-- >>> import qualified Data.Yaml
65−-- >>> import qualified Data.ByteString.Char8
66−
6719type CustomOpenApi = CustomJSON
6820
69−instance
70− (OpenApiOptionModifier xs, GToSchema (Rep x), Generic x, Typeable x, Typeable xs, Typeable k) =>
71− ToSchema (CustomJSON (xs :: k) x)
72− where
73− declareNamedSchema Proxy =
74− openApiSchemaModifier @xs
75− <$> genericDeclareNamedSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
76−
77−instance
78− (OpenApiOptionModifier xs, GToParamSchema (Rep x), Generic x) =>
79− ToParamSchema (CustomJSON (xs :: k) x)
80− where
81− toParamSchema Proxy =
82− genericToParamSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
83−
84−class OpenApiOptionModifier x where
85− openApiOptionsModifier :: SchemaOptions -> SchemaOptions
86− openApiOptionsModifier = id
87− openApiSchemaModifier :: NamedSchema -> NamedSchema
88− openApiSchemaModifier = id
21+instance (OpenApiOptions xs, GToSchema (Rep x), Generic x) => ToSchema (CustomJSON xs x) where
22+ declareNamedSchema Proxy = genericDeclareNamedSchema (openApiOptions @xs) (Proxy @x)
8923
9024data DatatypeNameModifier t
9125
92−instance (StringModifier f) => OpenApiOptionModifier (DatatypeNameModifier f) where
93− openApiOptionsModifier o = o {datatypeNameModifier = getStringModifier @f}
94−
95−instance (AesonOptions xs) => AesonOptions (DatatypeNameModifier f ': xs) where
96− aesonOptions = aesonOptions @xs
26+instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (DatatypeNameModifier f ': xs) where
27+ openApiOptions = (openApiOptions @xs) {datatypeNameModifier = getStringModifier @f}
9728
9829-- deriving-aeson-based instances
9930
100−instance OpenApiOptionModifier UnwrapUnaryRecords where
101− openApiOptionsModifier o = o {unwrapUnaryRecords = True}
31+class OpenApiOptions (xs :: [Type]) where
32+ openApiOptions :: SchemaOptions
10233
103−instance OpenApiOptionModifier OmitNothingFields
34+instance OpenApiOptions '[] where
35+ openApiOptions = defaultSchemaOptions
10436
105−#if MIN_VERSION_deriving_aeson(0,2,4)
106−instance OpenApiOptionModifier RejectUnknownFields where
107− openApiSchemaModifier = schema . additionalProperties .~ Just (AdditionalPropertiesAllowed False)
108−#endif
37+instance OpenApiOptions xs => OpenApiOptions (UnwrapUnaryRecords ': xs) where
38+ openApiOptions = (openApiOptions @xs) {unwrapUnaryRecords = True}
10939
110−instance StringModifier f => OpenApiOptionModifier (FieldLabelModifier f) where
111− openApiOptionsModifier o = o {fieldLabelModifier = getStringModifier @f}
40+instance OpenApiOptions xs => OpenApiOptions (OmitNothingFields ': xs) where
41+ openApiOptions = openApiOptions @xs
11242
113−instance StringModifier f => OpenApiOptionModifier (ConstructorTagModifier f) where
114− openApiOptionsModifier o = o {constructorTagModifier = getStringModifier @f}
43+instance OpenApiOptions xs => OpenApiOptions (RejectUnknownFields ': xs) where
44+ openApiOptions = openApiOptions @xs
11545
116−instance
117− TypeError ('Text "deriving-openapi3 does not currently the `TagSingleConstructors` modifier.") =>
118− OpenApiOptionModifier TagSingleConstructors
46+instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (FieldLabelModifier f ': xs) where
47+ openApiOptions = (openApiOptions @xs) {fieldLabelModifier = getStringModifier @f}
11948
120−instance OpenApiOptionModifier NoAllNullaryToStringTag where
121− openApiOptionsModifier o = o {allNullaryToStringTag = False}
49+instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (ConstructorTagModifier f ': xs) where
50+ openApiOptions = (openApiOptions @xs) {constructorTagModifier = getStringModifier @f}
12251
123−instance (KnownSymbol t, KnownSymbol c) => OpenApiOptionModifier (SumTaggedObject t c) where
124− openApiOptionsModifier o = o {sumEncoding = A.TaggedObject (symbolVal (Proxy @t)) (symbolVal (Proxy @c))}
52+instance
53+ (OpenApiOptions xs, TypeError ( 'Text "openapi3-deriving does not currently the `TagSingleConstructors` modifier.")) =>
54+ OpenApiOptions (TagSingleConstructors ': xs)
55+ where
56+ openApiOptions = undefined
12557
126−instance OpenApiOptionModifier SumUntaggedValue where
127− openApiOptionsModifier o = o {sumEncoding = A.UntaggedValue}
58+instance OpenApiOptions xs => OpenApiOptions (NoAllNullaryToStringTag ': xs) where
59+ openApiOptions = (openApiOptions @xs) {allNullaryToStringTag = False}
12860
129−instance OpenApiOptionModifier SumObjectWithSingleField where
130− openApiOptionsModifier o = o {sumEncoding = A.ObjectWithSingleField}
61+instance (KnownSymbol t, KnownSymbol c, OpenApiOptions xs) => OpenApiOptions (SumTaggedObject t c ': xs) where
62+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.TaggedObject (symbolVal (Proxy @t)) (symbolVal (Proxy @c))}
13163
132−instance OpenApiOptionModifier SumTwoElemArray where
133− openApiOptionsModifier o = o {sumEncoding = A.TwoElemArray}
64+instance (OpenApiOptions xs) => OpenApiOptions (SumUntaggedValue ': xs) where
65+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.UntaggedValue}
13466
135−instance OpenApiOptionModifier '[]
67+instance (OpenApiOptions xs) => OpenApiOptions (SumObjectWithSingleField ': xs) where
68+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.ObjectWithSingleField}
13669
137−instance (OpenApiOptionModifier x, OpenApiOptionModifier xs) => OpenApiOptionModifier (x ': xs) where
138− openApiOptionsModifier = openApiOptionsModifier @xs . openApiOptionsModifier @x
139− openApiSchemaModifier = openApiSchemaModifier @xs . openApiSchemaModifier @x
70+instance (OpenApiOptions xs) => OpenApiOptions (SumTwoElemArray ': xs) where
71+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.TwoElemArray}