AutoBE
    Preparing search index...

    Interface IReference

    Reference property.

    Used when a property references another named schema. The $ref points to the related entity type (e.g., IUser.ISummary).

    interface IReference {
        $ref: string;
        description: string;
        "x-autobe-specification": string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $ref description x-autobe-specification

    Properties

    $ref: string

    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: string

    API documentation for the property.

    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 property from an API consumer's perspective.

    Content Guidelines

    • WHAT: What this property represents in the business domain
    • WHY: Why this property exists and when it's used
    • Constraints: Validation rules, value ranges, or format requirements visible to API consumers
    • Relationships: If referencing another entity, explain the semantic relationship

    When the database column is non-null but the DTO property is nullable or optional, briefly explain why:

    • "Optional - defaults to 'user' if not provided."
    • "Optional - server generates UUID if not provided."
    • "Optional for update operations."
    • MUST be written in English
    • Should be organized into multiple paragraphs for complex properties
    • Use clear, precise language accessible to API consumers
    • Do NOT include implementation details (use x-autobe-specification)
    "x-autobe-specification": string

    Implementation specification for this property.

    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 property value should be retrieved or computed:

    • Source database column or related table
    • Any transformation logic between DB and DTO (e.g., type casting, formatting)
    • Computation formula for derived values (e.g., price * quantity)
    • Join conditions if data comes from related tables
    • Validation rules enforced at the service layer
    • Edge cases (nulls, defaults, empty values)

    The specification must be precise enough for Realize Agent to implement the data retrieval or computation logic without ambiguity.

    MUST be written in English. Never use other languages.

    Settings

    Member Visibility

    On This Page

    Properties