effect-io-ai

Package: effect
Module: JsonSchema

JsonSchema.MultiDocument

Like Document, but carries multiple root schemas that share a single definitions pool.

When to use

Use when generating several schemas, such as a request body and a response body, that reference the same set of definitions.

Details

The schemas tuple is non-empty and contains at least one element.

See

• Document
• toMultiDocumentOpenApi3_1

Signature

export interface MultiDocument<D extends Dialect> {
  readonly dialect: D
  readonly schemas: readonly [JsonSchema, ...Array<JsonSchema>]
  readonly definitions: Definitions
}

Source

Since v4.0.0