effect-io-ai

Package: @effect/platform
Module: OpenApiJsonSchema

OpenApiJsonSchema.makeWithDefs

Creates a schema with additional options and definitions.

Options

• defs: A record of definitions that are included in the schema.
• defsPath: The path to the definitions within the schema (defaults to “#/$defs/”).
• topLevelReferenceStrategy: Controls the handling of the top-level reference. Possible values are:
  • "keep": Keep the top-level reference (default behavior).
  • "skip": Skip the top-level reference.
• additionalPropertiesStrategy: Controls the handling of additional properties. Possible values are:
  • "strict": Disallow additional properties (default behavior).
  • "allow": Allow additional properties.

Signature

declare const makeWithDefs: <A, I, R>(schema: Schema.Schema<A, I, R>, options: { readonly defs: Record<string, any>; readonly defsPath?: string | undefined; readonly topLevelReferenceStrategy?: TopLevelReferenceStrategy | undefined; readonly additionalPropertiesStrategy?: AdditionalPropertiesStrategy | undefined; }) => JsonSchema

Source

Since v1.0.0