AutoBeOpenApi.IJsonSchemaDescriptive is a type schema info of the OpenAPI
Generative, but it has a description property which is required.
AutoBeOpenApi.IJsonSchemaDescriptive basically follows the JSON schema
specification of OpenAPI v3.1, but a little bit shrunk to remove ambiguous
and duplicated expressions of OpenAPI v3.1 for the convenience, clarity,
and AI generation.
CRITICAL INSTRUCTIONS FOR OPTIMAL AI GENERATION:
When creating descriptions for components, types, and properties:
ALWAYS refer to and incorporate the description comments from the
corresponding Prisma DB schema tables and columns. The descriptions
should match the style, level of detail, and terminology used in the
Prisma schema.
ALL descriptions MUST be organized into MULTIPLE PARAGRAPHS separated by
line breaks. Single-paragraph descriptions should be avoided.
Descriptions should comprehensively cover:
The purpose and business meaning of the type or property
Relationships to other entities
Validation rules, constraints, and edge cases
Usage context and examples when helpful
For each property of an object type, ensure its description reflects the
corresponding column description in the Prisma DB schema, maintaining
the same level of detail and terminology
Descriptions should be so detailed and clear that anyone reading them can
fully understand the type or property without needing to reference any
other documentation
Descriptive type schema info.
AutoBeOpenApi.IJsonSchemaDescriptiveis a type schema info of the OpenAPI Generative, but it has adescriptionproperty which is required.AutoBeOpenApi.IJsonSchemaDescriptivebasically follows the JSON schema specification of OpenAPI v3.1, but a little bit shrunk to remove ambiguous and duplicated expressions of OpenAPI v3.1 for the convenience, clarity, and AI generation.CRITICAL INSTRUCTIONS FOR OPTIMAL AI GENERATION:
When creating descriptions for components, types, and properties:
ALWAYS refer to and incorporate the description comments from the corresponding Prisma DB schema tables and columns. The descriptions should match the style, level of detail, and terminology used in the Prisma schema.
ALL descriptions MUST be organized into MULTIPLE PARAGRAPHS separated by line breaks. Single-paragraph descriptions should be avoided.
Descriptions should comprehensively cover:
For each property of an object type, ensure its description reflects the corresponding column description in the Prisma DB schema, maintaining the same level of detail and terminology
Descriptions should be so detailed and clear that anyone reading them can fully understand the type or property without needing to reference any other documentation