Skip to content

Junaidr/fix tag single constructors/subx 1244 #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rasheedja wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Junaidr/fix tag single constructors/subx 1244 #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
949d324
Derive defaultSchemaOptions from Aeson.defaultOptions
stevladimir May 6, 2023
274d368
fix: try minimal
rasheedja Jun 20, 2025
568e57d
wip try fix
rasheedja Jun 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/Data/OpenApi/Internal/Schema.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -951,9 +951,11 @@ instance {-# OVERLAPPING #-} Constructor c => GToSchema (C1 c U1) where
gdeclareNamedSchema = gdeclareNamedSumSchema

-- | Single field constructor.
instance (Selector s, GToSchema f, GToSchema (S1 s f)) => GToSchema (C1 c (S1 s f)) where
instance (Selector s, GToSchema f, GToSchema (S1 s f), GSumToSchema (S1 s f)) => GToSchema (C1 c (S1 s f)) where
gdeclareNamedSchema opts _ s
| unwrapUnaryRecords opts = fieldSchema
| tagSingleConstructors opts = do
gdeclareNamedSumSchema opts (Proxy :: Proxy (S1 s f)) s
| otherwise =
case schema ^. items of
Just (OpenApiItemsArray [_]) -> fieldSchema
Expand Down Expand Up @@ -1116,7 +1118,7 @@ instance {-# OVERLAPPABLE #-} (Constructor c, GToSchema f) => GSumToSchema (C1 c
tell (All False)
lift $ gsumConToSchema opts proxy

instance (Constructor c, Selector s, GToSchema f) => GSumToSchema (C1 c (S1 s f)) where
instance (Constructor c, Selector s, GToSchema f, GSumToSchema (S1 s f)) => GSumToSchema (C1 c (S1 s f)) where
gsumToSchema opts proxy = do
tell (All False)
lift $ gsumConToSchema opts proxy
Expand Down
16 changes: 7 additions & 9 deletions src/Data/OpenApi/SchemaOptions.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ data SchemaOptions = SchemaOptions
, unwrapUnaryRecords :: Bool
-- | Specifies how to encode constructors of a sum datatype.
, sumEncoding :: Aeson.SumEncoding
, tagSingleConstructors :: Bool
}

-- | Default encoding @'SchemaOptions'@.
Expand All @@ -39,14 +40,7 @@ data SchemaOptions = SchemaOptions
-- }
-- @
defaultSchemaOptions :: SchemaOptions
defaultSchemaOptions = SchemaOptions
{ fieldLabelModifier = id
, constructorTagModifier = id
, datatypeNameModifier = id
, allNullaryToStringTag = True
, unwrapUnaryRecords = False
, sumEncoding = Aeson.defaultTaggedObject
}
defaultSchemaOptions = fromAesonOptions Aeson.defaultOptions

-- | Convert 'Aeson.Options' to 'SchemaOptions'.
--
Expand All @@ -56,21 +50,25 @@ defaultSchemaOptions = SchemaOptions
-- * 'constructorTagModifier'
-- * 'allNullaryToStringTag'
-- * 'unwrapUnaryRecords'
-- * 'sumEncoding'
--
-- Note that these fields have no effect on `SchemaOptions`:
--
-- * 'Aeson.omitNothingFields'
-- * 'Aeson.tagSingleConstructors'
-- * 'Aeson.rejectUnknownFields'
--
-- The rest is defined as in 'defaultSchemaOptions'.
--
-- @since 2.2.1
--
fromAesonOptions :: Aeson.Options -> SchemaOptions
fromAesonOptions opts = defaultSchemaOptions
fromAesonOptions opts = SchemaOptions
{ fieldLabelModifier = Aeson.fieldLabelModifier opts
, constructorTagModifier = Aeson.constructorTagModifier opts
, datatypeNameModifier = id
, allNullaryToStringTag = Aeson.allNullaryToStringTag opts
, unwrapUnaryRecords = Aeson.unwrapUnaryRecords opts
, sumEncoding = Aeson.sumEncoding opts
, tagSingleConstructors = Aeson.tagSingleConstructors opts
}