OutputMeta

Defined in: plan/output-builder.ts:14

Metadata annotations for output properties. Can be used for JSON schema generation and other derivations.

Indexable

[key: string]: unknown

Allow custom annotations

Properties

$defName?

readonly optional $defName: string

Defined in: plan/output-builder.ts:38

Name to use in $defs/definitions when this schema is extracted during deduplication

---

deprecated?

readonly optional deprecated: boolean

Defined in: plan/output-builder.ts:22

Whether this property is deprecated

---

description?

readonly optional description: string

Defined in: plan/output-builder.ts:16

Human-readable description of the property

---

enum?

readonly optional enum: readonly unknown[]

Defined in: plan/output-builder.ts:36

Enum of allowed values

---

examples?

readonly optional examples: readonly unknown[]

Defined in: plan/output-builder.ts:20

Example values for the property

---

format?

readonly optional format: string

Defined in: plan/output-builder.ts:24

Format hint (e.g., ‘uri’, ‘email’, ‘date-time’)

---

maximum?

readonly optional maximum: number

Defined in: plan/output-builder.ts:30

Maximum value for numbers

---

maxLength?

readonly optional maxLength: number

Defined in: plan/output-builder.ts:34

Maximum length for strings/arrays

---

minimum?

readonly optional minimum: number

Defined in: plan/output-builder.ts:28

Minimum value for numbers

---

minLength?

readonly optional minLength: number

Defined in: plan/output-builder.ts:32

Minimum length for strings/arrays

---

pattern?

readonly optional pattern: string

Defined in: plan/output-builder.ts:26

Regex pattern for string validation

---

title?

readonly optional title: string

Defined in: plan/output-builder.ts:18

Human-readable title for the property