Skip to content
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.

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

remove default json schema annotations from string, number and boolean #3667

Merged
merged 1 commit into from
Sep 24, 2024

Conversation

gcanti
Copy link
Contributor

@gcanti gcanti commented Sep 24, 2024

Before

import { JSONSchema, Schema } from "@effect/schema"

const schema = Schema.String.annotations({ examples: ["a", "b"] })

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "description": "a string",
  "title": "string",
  "examples": [
    "a",
    "b"
  ]
}
*/

After

import { JSONSchema, Schema } from "@effect/schema"

const schema = Schema.String.annotations({ examples: ["a", "b"] })

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "examples": [
    "a",
    "b"
  ]
}
*/

Copy link

changeset-bot bot commented Sep 24, 2024

🦋 Changeset detected

Latest commit: 198f6f5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 25 packages
Name Type
@effect/schema Patch
@effect/cli Patch
@effect/cluster-browser Patch
@effect/cluster-node Patch
@effect/cluster-workflow Patch
@effect/cluster Patch
@effect/experimental Patch
@effect/platform-browser Patch
@effect/platform-bun Patch
@effect/platform-node-shared Patch
@effect/platform-node Patch
@effect/platform Patch
@effect/rpc-http Patch
@effect/rpc Patch
@effect/sql Patch
@effect/sql-d1 Patch
@effect/sql-mssql Patch
@effect/sql-mysql2 Patch
@effect/sql-pg Patch
@effect/sql-sqlite-bun Patch
@effect/sql-sqlite-node Patch
@effect/sql-drizzle Patch
@effect/sql-kysely Patch
@effect/sql-sqlite-react-native Patch
@effect/sql-sqlite-wasm Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gcanti gcanti merged commit fd83d0e into main Sep 24, 2024
11 checks passed
@gcanti gcanti deleted the schema-remove-default-json-schema-annotations branch September 24, 2024 07:14
@github-actions github-actions bot mentioned this pull request Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant