Skip to content

Update Scala3 recursive type schema definition doc #5442

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
jpthomasset wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Scala3 recursive type schema definition doc #5442

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
6 changes: 3 additions & 3 deletions doc/endpoint/schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,16 +85,16 @@ This method may be used both with automatic and semi-automatic derivation.

### Derivation for recursive types

In Scala3, any schemas for recursive types need to be provided as typed `implicit def` (not a `given`)!
In Scala3, any schemas for recursive types need to be provided using by-name givens (not a direct `given`)!
For example:

```scala mdoc:silent
case class RecursiveTest(data: List[RecursiveTest])
object RecursiveTest:
implicit def f1Schema: Schema[RecursiveTest] = Schema.derived[RecursiveTest]
given f1Schema: () => Schema[RecursiveTest] = Schema.derived[RecursiveTest]
```

The implicit doesn't have to be defined in the companion object, just anywhere in scope. This applies to cases where
The `given` doesn't have to be defined in the companion object, just anywhere in scope. This applies to cases where
the schema is looked up implicitly, e.g. for `jsonBody`.

### Derivation for union types
Expand Down
Loading