Skip to content

Document JSON parsing for enum fields in Scala #5237

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
akreit wants to merge 1 commit into
base: master
Choose a base branch
from
+16 −0
Open

Document JSON parsing for enum fields in Scala #5237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions doc/endpoint/enumerations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,22 @@ enum ColorEnum:
given Schema.derivedEnumeration.defaultStringBased
```

To parse json bodies containing enum fields using `jsoniter-scala`, an additional configuration flag is required:

```scala
enum ColorEnum:
case Green extends ColorEnum
case Pink extends ColorEnum

given JsonValueCodec[ColorEnum] = JsonCodecMaker.make(
CodecMakerConfig.withDiscriminatorFieldName(None)
)

given Schema.derivedEnumeration.defaultStringBased
```

This ensures that enum fields are parsed as plain strings instead of objects with a "type" discriminator field, e.g. `{"type": "Green"}`

### Scala 3 string-based constant union types to enum

If a union type is a string-based constant union type, it can be auto-derived as field type or manually derived by using the `Schema.derivedStringBasedUnionEnumeration[T]` method.
Expand Down
Loading