Sourced from effect's releases.

effect@3.17.10

Patch Changes

• #5368 3b26094 Thanks @​gcanti! - ## Annotation Behavior

  When you call .annotations on a schema, any identifier annotations that were previously set will now be removed. Identifiers are now always tied to the schema's ast reference (this was the intended behavior).

  Example

  import { JSONSchema, Schema } from "effect"
  const schema = Schema.URL
  console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
  
  /*
  
  {
  
  "$schema": "http://json-schema.org/draft-07/schema#",
  
  "$defs": {
  
  "URL": {
  
  "type": "string",
  
  "description": "a string to be decoded into a URL"
  
  }
  
  },
  
  "$ref": "#/$defs/URL"
  
  }
  
  */
  const annotated = Schema.URL.annotations({ description: "description" })
  console.log(JSON.stringify(JSONSchema.make(annotated), null, 2))
  
  /*
  
  {
  
  "$schema": "http://json-schema.org/draft-07/schema#",
  
  "type": "string",
  
  "description": "description"
  
  }
  
  */
  
  

  OpenAPI 3.1 Compatibility

  OpenAPI 3.1 does not allow nullable: true. Instead, the schema will now correctly use { "type": "null" } inside a union.

  Example

  import { JSONSchema, Schema } from "effect"
  

... (truncated)

Sourced from effect's changelog.

3.17.10

Patch Changes

• #5368 3b26094 Thanks @​gcanti! - ## Annotation Behavior

  When you call .annotations on a schema, any identifier annotations that were previously set will now be removed. Identifiers are now always tied to the schema's ast reference (this was the intended behavior).

  Example

  import { JSONSchema, Schema } from "effect"
  const schema = Schema.URL
  console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
  
  /*
  
  {
  
  "$schema": "http://json-schema.org/draft-07/schema#",
  
  "$defs": {
  
  "URL": {
  
  "type": "string",
  
  "description": "a string to be decoded into a URL"
  
  }
  
  },
  
  "$ref": "#/$defs/URL"
  
  }
  
  */
  const annotated = Schema.URL.annotations({ description: "description" })
  console.log(JSON.stringify(JSONSchema.make(annotated), null, 2))
  
  /*
  
  {
  
  "$schema": "http://json-schema.org/draft-07/schema#",
  
  "type": "string",
  
  "description": "description"
  
  }
  
  */
  
  

  OpenAPI 3.1 Compatibility

  OpenAPI 3.1 does not allow nullable: true. Instead, the schema will now correctly use { "type": "null" } inside a union.

  Example

  import { JSONSchema, Schema } from "effect"
  

... (truncated)

• b3cd3b9 Version Packages (#5428)
• ccd655d Align Either type parameter naming with Effect (#5445)
• a33e491 ensure Effect.promise captures span on defect (#5437)
• 5f796d9 add type level test for PR #5360 (#5435)
• 3b26094 Refactor JSONSchema generator
• See full diff in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)