Type Alias IJsonSchemaProperty

Type schema for object properties with implementation specifications.

IJsonSchemaProperty extends the base JSON Schema types with implementation specifications. Each property in an object schema uses this type.

Property Construction Order

When constructing properties, fields MUST be specified in this order:

1. x-autobe-specification → HOW to implement/compute this property
2. description → WHAT for API consumers
3. Type metadata (type, format, etc.) → WHAT technically

Two-Field Documentation Pattern

Each property includes:

• x-autobe-specification: Implementation guidance for agents
• description: API documentation for consumers (Swagger UI, SDK docs)

Key Difference from IJsonSchemaDescriptive

While IJsonSchemaDescriptive is used for top-level component schemas (types in components.schemas), IJsonSchemaProperty is used for properties within those schemas.

Type Exclusions

Note that IJsonSchemaProperty excludes IObject - object-typed properties must use IReference to reference named schemas in the components section. This prevents inline object definitions and ensures all complex types are properly named and reusable.