@@ -1,71 +1,139 @@
1+{-# LANGUAGE CPP #-}
12{-# OPTIONS_GHC -Wno-orphans #-}
23
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
331module Deriving.OpenApi
432 ( CustomOpenApi,
533 DatatypeNameModifier,
34+ ToSchema,
635 module Deriving.Aeson,
736 )
837where
938
39+import Control.Lens
1040import qualified Data.Aeson.Types as A
11−import Data.Kind
1241import Data.OpenApi
42+import Data.OpenApi.Internal.ParamSchema
1343import Data.OpenApi.Internal.Schema
1444import Data.Proxy
45+import Data.Text (Text)
46+import qualified Data.Text as T
47+import Data.Typeable
1548import Deriving.Aeson
1649import GHC.Generics
1750import GHC.TypeLits
1851
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+
1967type CustomOpenApi = CustomJSON
2068
21−instance (OpenApiOptions xs, GToSchema (Rep x), Generic x) => ToSchema (CustomJSON xs x) where
22− declareNamedSchema Proxy = genericDeclareNamedSchema (openApiOptions @xs) (Proxy @x)
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
2389
2490data DatatypeNameModifier t
2591
26−instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (DatatypeNameModifier f ': xs) where
27− openApiOptions = (openApiOptions @xs) {datatypeNameModifier = getStringModifier @f}
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
2897
2998-- deriving-aeson-based instances
3099
31−class OpenApiOptions (xs :: [Type]) where
32− openApiOptions :: SchemaOptions
100+instance OpenApiOptionModifier UnwrapUnaryRecords where
101+ openApiOptionsModifier o = o {unwrapUnaryRecords = True}
33102
34−instance OpenApiOptions '[] where
35− openApiOptions = defaultSchemaOptions
103+instance OpenApiOptionModifier OmitNothingFields
36104
37−instance OpenApiOptions xs => OpenApiOptions (UnwrapUnaryRecords ': xs) where
38− openApiOptions = (openApiOptions @xs) {unwrapUnaryRecords = True}
105+#if MIN_VERSION_deriving_aeson(0,2,4)
106+instance OpenApiOptionModifier RejectUnknownFields where
107+ openApiSchemaModifier = schema . additionalProperties .~ Just (AdditionalPropertiesAllowed False)
108+#endif
39109
40−instance OpenApiOptions xs => OpenApiOptions (OmitNothingFields ': xs) where
41− openApiOptions = openApiOptions @xs
110+instance StringModifier f => OpenApiOptionModifier (FieldLabelModifier f) where
111+ openApiOptionsModifier o = o {fieldLabelModifier = getStringModifier @f}
42112
43−instance OpenApiOptions xs => OpenApiOptions (RejectUnknownFields ': xs) where
44− openApiOptions = openApiOptions @xs
113+instance StringModifier f => OpenApiOptionModifier (ConstructorTagModifier f) where
114+ openApiOptionsModifier o = o {constructorTagModifier = getStringModifier @f}
45115
46−instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (FieldLabelModifier f ': xs) where
47− openApiOptions = (openApiOptions @xs) {fieldLabelModifier = getStringModifier @f}
116+instance
117+ TypeError ('Text "deriving-openapi3 does not currently the `TagSingleConstructors` modifier.") =>
118+ OpenApiOptionModifier TagSingleConstructors
48119
49−instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (ConstructorTagModifier f ': xs) where
50− openApiOptions = (openApiOptions @xs) {constructorTagModifier = getStringModifier @f}
120+instance OpenApiOptionModifier NoAllNullaryToStringTag where
121+ openApiOptionsModifier o = o {allNullaryToStringTag = False}
51122
52−instance
53− (OpenApiOptions xs, TypeError ( 'Text "openapi3-deriving does not currently the `TagSingleConstructors` modifier.")) =>
54− OpenApiOptions (TagSingleConstructors ': xs)
55− where
56− openApiOptions = undefined
123+instance (KnownSymbol t, KnownSymbol c) => OpenApiOptionModifier (SumTaggedObject t c) where
124+ openApiOptionsModifier o = o {sumEncoding = A.TaggedObject (symbolVal (Proxy @t)) (symbolVal (Proxy @c))}
57125
58−instance OpenApiOptions xs => OpenApiOptions (NoAllNullaryToStringTag ': xs) where
59− openApiOptions = (openApiOptions @xs) {allNullaryToStringTag = False}
126+instance OpenApiOptionModifier SumUntaggedValue where
127+ openApiOptionsModifier o = o {sumEncoding = A.UntaggedValue}
60128
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))}
129+instance OpenApiOptionModifier SumObjectWithSingleField where
130+ openApiOptionsModifier o = o {sumEncoding = A.ObjectWithSingleField}
63131
64−instance (OpenApiOptions xs) => OpenApiOptions (SumUntaggedValue ': xs) where
65− openApiOptions = (openApiOptions @xs) {sumEncoding = A.UntaggedValue}
132+instance OpenApiOptionModifier SumTwoElemArray where
133+ openApiOptionsModifier o = o {sumEncoding = A.TwoElemArray}
66134
67−instance (OpenApiOptions xs) => OpenApiOptions (SumObjectWithSingleField ': xs) where
68− openApiOptions = (openApiOptions @xs) {sumEncoding = A.ObjectWithSingleField}
135+instance OpenApiOptionModifier '[]
69136
70−instance (OpenApiOptions xs) => OpenApiOptions (SumTwoElemArray ': xs) where
71− openApiOptions = (openApiOptions @xs) {sumEncoding = A.TwoElemArray}
137+instance (OpenApiOptionModifier x, OpenApiOptionModifier xs) => OpenApiOptionModifier (x ': xs) where
138+ openApiOptionsModifier = openApiOptionsModifier @xs . openApiOptionsModifier @x
139+ openApiSchemaModifier = openApiSchemaModifier @xs . openApiSchemaModifier @x