Interface: DescriptionLike

Defined in: src/batteries/llm/chat_common/types.ts:37

Structural shape of a validator/Joi describe() output, as consumed by the JSON-Schema renderer. A loose superset — only the fields the renderer reads are typed; the index signature carries everything else through untouched.

Indexable

[key: string]: unknown

Pass-through for any other validator metadata the renderer does not read.

Properties

Property	Type	Description	Defined in
default?	unknown	Default value supplied when the field is absent.	src/batteries/llm/chat_common/types.ts:45
description?	string	Human-readable description of the field.	src/batteries/llm/chat_common/types.ts:41
enum?	unknown[]	Permitted values declared via an enum/valid set.	src/batteries/llm/chat_common/types.ts:47
examples?	unknown[]	Example values for the field.	src/batteries/llm/chat_common/types.ts:51
flags?	{ default?: unknown; description?: string; presence?: string; }	Validator flags bag carrying presence, description, and default.	src/batteries/llm/chat_common/types.ts:59
flags.default?	unknown	-	src/batteries/llm/chat_common/types.ts:59
flags.description?	string	-	src/batteries/llm/chat_common/types.ts:59
flags.presence?	string	-	src/batteries/llm/chat_common/types.ts:59
items?	DescriptionLike | DescriptionLike[]	Element description(s) for array types.	src/batteries/llm/chat_common/types.ts:55
presence?	string	Presence flag ('optional', 'required', or 'forbidden') at the top level.	src/batteries/llm/chat_common/types.ts:43
properties?	Record<string, DescriptionLike>	Nested property descriptions, keyed by property name (for object types).	src/batteries/llm/chat_common/types.ts:53
required?	string[]	Names of required properties (for object types).	src/batteries/llm/chat_common/types.ts:57
type?	string	Validator type name (e.g. 'string', 'object', 'array').	src/batteries/llm/chat_common/types.ts:39
valids?	unknown[]	Permitted values declared via the validator's valid() rule.	src/batteries/llm/chat_common/types.ts:49