Skip to content

add info segment about json schema validation of default values #1224

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
janglad wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −15
Open

add info segment about json schema validation of default values #1224

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
36 changes: 21 additions & 15 deletions content/src/content/docs/docs/schema/json-schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ sidebar:
order: 16
---

import { Aside } from "@astrojs/starlight/components"

The `JSONSchema.make` function allows you to generate a JSON Schema from a schema.

**Example** (Creating a JSON Schema for a Struct)
Expand Down Expand Up @@ -628,33 +630,37 @@ By using identifier annotations, schemas can be reused and referenced more easil
Standard JSON Schema annotations such as `title`, `description`, `default`, and `examples` are supported.
These annotations allow you to enrich your schemas with metadata that can enhance readability and provide additional information about the data structure.

<Aside type="note" title="Default values must be valid">
Default values are filtered by removing values that do not conform to
the schema.
</Aside>

**Example** (Using Annotations for Metadata)

```ts twoslash
import { JSONSchema, Schema } from "effect"

const schema = Schema.String.annotations({
description: "my custom description",
title: "my custom title",
default: "",
examples: ["a", "b"]
})
const schema = Schema.Trim.pipe(
Schema.annotations({
description: "my custom description",
title: "my custom title",
default: "",
examples: ["a", " b", "c"]
})
)

const jsonSchema = JSONSchema.make(schema)

console.log(JSON.stringify(jsonSchema, null, 2))
/*
Output:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "string",
"description": "my custom description",
"title": "my custom title",
"examples": [
"a",
"b"
],
"default": ""
'$schema': 'http://json-schema.org/draft-07/schema#',
type: 'string',
description: 'my custom description',
title: 'my custom title',
default: '',
examples: [ 'a', 'c' ]
}
*/
```
Expand Down