effect-io-ai

Package: effect
Module: JsonSchema

JsonSchema.fromSchemaOpenApi3_0

Parses a raw OpenAPI 3.0 JSON Schema into a Document<"draft-2020-12">.

When to use

Use when you need to consume raw JSON Schema objects from an OpenAPI 3.0 specification.

Details

This handles OpenAPI 3.0 extensions, including nullable, singular example, and boolean exclusiveMinimum or exclusiveMaximum. It normalizes the schema to Draft-07 first, then converts to Draft-2020-12 via fromSchemaDraft07.

Example (Parsing an OpenAPI 3.0 nullable schema)

import { JsonSchema } from "effect"

const raw: JsonSchema.JsonSchema = {
  type: "string",
  nullable: true
}

const doc = JsonSchema.fromSchemaOpenApi3_0(raw)
// nullable is expanded into a type array
console.log(doc.schema.type) // ["string", "null"]

See

• fromSchemaOpenApi3_1
• fromSchemaDraft07

Signature

declare const fromSchemaOpenApi3_0: (schema: JsonSchema) => Document<"draft-2020-12">

Source

Since v4.0.0