Skip to content

docs: add practical examples for oneOf, anyOf, and allOf #2018

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

docs: add practical examples for oneOf, anyOf, and allOf #2018

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
38 changes: 38 additions & 0 deletions pages/learn/json-schema-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,44 @@ In this page, you will find examples illustrating different use cases to help yo
- [Movie](#movie)
- [User profile](#user-profile)

- [Choosing between oneOf, anyOf, and allOf](#choosing-between-oneof-anyof-and-allof)
## Choosing between oneOf, anyOf, and allOf

When combining schemas, `oneOf`, `anyOf`, and `allOf` behave differently.
The examples below show common real-world scenarios and pitfalls.

### anyOf — at least one schema must match

```json
{
"anyOf": [
{ "type": "string" },
{ "type": "number" }
]
}
```

### oneOf — exactly one schema must match

```json
{
"oneOf": [
{ "type": "number", "minimum": 0 },
{ "type": "number", "maximum": 100 }
]
}
```

### allOf — all schemas must match

```json
{
"allOf": [
{ "type": "string" },
{ "minLength": 5 }
]
}
```

## Address

Expand Down
Loading