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

Description about the type.

CRITICAL: This description MUST be extensively detailed and MUST reference and align with the description comments from the corresponding Prisma DB schema tables and columns.

The description MUST be organized into MULTIPLE PARAGRAPHS (separated by line breaks) based on different aspects of the type:

• The purpose and business meaning of the type
• Relationships to other entities in the system
• Validation rules, constraints, and edge cases
• Usage context and examples when helpful

This structured approach improves readability and helps readers better understand the type's various characteristics and use cases. The description should be so comprehensive that anyone reading it can fully understand the type without needing to reference other documentation.

MUST be written in English. Never use other languages.