Interface IReference

Reference to the named schema.

The ref is a reference to the named schema. Format of the $ref is following the JSON Pointer specification. In the OpenAPI, the $ref starts with #/components/schemas/ which means the type is stored in the AutoBeOpenApi.IComponents.schemas object.

• #/components/schemas/SomeObject
• #/components/schemas/AnotherObject

API documentation for the type.

This is the standard OpenAPI description field that will be displayed in Swagger UI, SDK documentation, and other API documentation tools. Focus on explaining the type from an API consumer's perspective.

The description SHOULD be organized into MULTIPLE PARAGRAPHS (separated by line breaks) covering:

• WHAT: The purpose and business meaning of the type
• WHY: When and why this type is used
• Relationships: Connections to other entities in the system
• Constraints: Validation rules visible to API consumers

Important Notes

• Reference the corresponding database schema table's documentation to maintain consistency
• Do NOT include implementation details here (use x-autobe-specification for object types)
• Keep the language accessible to API consumers who may not know the internal implementation

MUST be written in English. Never use other languages.

Implementation specification for this type.

This is an AutoBE-internal field (not exposed in standard OpenAPI output) that provides detailed implementation guidance for downstream agents (Realize Agent, Test Agent, etc.).

Include HOW this type should be implemented:

• Source database tables (primary table and joined tables)
• Overall query strategy (joins, filters, grouping)
• Aggregation formulas if applicable (SUM, COUNT, AVG, etc.)
• Business rules and transformation logic
• Edge cases (nulls, empty sets, defaults)

This field is especially critical when x-autobe-database-schema is null (for composite, computed, or request parameter types), as it provides the only guidance for implementing data retrieval or computation logic.

MUST be written in English. Never use other languages.