Namespace OpenApi

Emended OpenAPI v3.1 definition used by typia and nestia.

OpenApi is a namespace containing functions and interfaces for emended OpenAPI v3.1 specification. The keyword "emended" means that OpenApi is not a direct OpenAPI v3.1 specification (OpenApiV3_1), but a little bit shrunk to remove ambiguous and duplicated expressions of OpenAPI v3.1 for the convenience of typia and nestia.

For example, when representing nullable type, OpenAPI v3.1 supports three ways. In that case, OpenApi remains only the third way, so that makes typia and nestia (especially @nestia/editor) to be simple and easy to implement.

1. { type: ["string", "null"] }
2. { type: "string", nullable: true }
3. { oneOf: [{ type: "string" }, { type: "null" }] }

Here is the entire list of differences between OpenAPI v3.1 and emended OpenApi.

• Operation

  • Merge OpenApiV3_1.IPath.parameters to OpenApi.IOperation.parameters
  • Resolve references of OpenApiV3_1.IOperation members
  • Escape references of OpenApiV3_1.IComponents.examples

• JSON Schema

  • Decompose mixed type: OpenApiV3_1.IJsonSchema.IMixed
  • Resolve nullable property: OpenApiV3_1.IJsonSchema.__ISignificant.nullable
  • Array type utilizes only single OpenApi.IJsonSchema.IArray.items
  • Tuple type utilizes only OpenApi.IJsonSchema.ITuple.prefixItems
  • Merge OpenApiV3_1.IJsonSchema.IAllOf to OpenApi.IJsonSchema.IObject
  • Merge OpenApiV3_1.IJsonSchema.IAnyOf to OpenApi.IJsonSchema.IOneOf
  • Merge OpenApiV3_1.IJsonSchema.IRecursiveReference to OpenApi.IJsonSchema.IReference