Type Alias IJsonSchema

Type schema info.

AutoBeOpenApi.IJsonSchema is a type schema info of the OpenAPI Generative.

AutoBeOpenApi.IJsonSchema 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: Union Type Expression

In this type system, union types (including nullable types) MUST be expressed using the IOneOf structure. NEVER use array notation in the type field.

❌ FORBIDDEN - Array notation in type field:

{
  "type": ["string", "null"] // NEVER DO THIS!
}
Copy

✅ CORRECT - Using IOneOf for unions:

// For nullable string:
{
  oneOf: [{ type: "string" }, { type: "null" }];
}

// For string | number union:
{
  oneOf: [{ type: "string" }, { type: "number" }];
}
Copy

The type field in any schema object is a discriminator that identifies the schema type and MUST contain exactly one string value.