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:
x-autobe-specification for object types)MUST be written in English. Never use other languages.
OptionaldiscriminatorDiscriminator info of the union type.
List of the union types.
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:
SUM, COUNT, AVG, etc.)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.
Union type.
IOneOfrepresents an union type of the TypeScript (A | B | C).For reference, even though your Swagger (or OpenAPI) document has defined
anyOfinstead of theoneOf, AutoBeOpenApi forcibly converts it tooneOftype.