Interface IString

Content media type restriction.

If you want to accept multiple contentMediaType values simultaneously (e.g., text/plain and text/html), you MUST NOT violate the type by using an array. Instead, use oneOf to define multiple string schemas with different contentMediaType values.

Example for accepting both text/plain and text/html:

{
  "oneOf": [
    { "type": "string", "contentMediaType": "text/plain" },
    { "type": "string", "contentMediaType": "text/html" }
  ]
}
Copy

This is the CORRECT approach. Never use array notation or modify the single string type to accept arrays.

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.

Format restriction.

Maximum length restriction.

Minimum length restriction.

Pattern restriction.

Discriminator value of the type.

CRITICAL: This MUST be a SINGLE string value, NOT an array. The type field identifies the JSON Schema type and must be exactly one of: "boolean", "integer", "number", "string", "array", "object", or "null".

❌ INCORRECT: type: ["string", "null"] // This is WRONG! ✅ CORRECT: type: "string" // For nullable string, use oneOf instead

If you need to express a nullable type (e.g., string | null), you MUST use the IOneOf structure:

{
  "oneOf": [{ "type": "string" }, { "type": "null" }]
}
Copy

NEVER use array notation in the type field. The type field is a discriminator that accepts only a single string value.

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.