Skip to main content

Module types

Module types 

Source
Expand description

IR type definitions for OpenAPI code generation.

These types form the version-agnostic intermediate representation that all OpenAPI spec versions (3.0, 3.1, 3.2) lower into. Generators consume these types exclusively — they never see raw spec types.

Structs§

IrContact
Contact information.
IrEnum
IrEnumValue
IrHeader
A resolved response header.
IrInfo
API metadata.
IrIntersection
IrLicense
License information.
IrOAuth2Flow
IrOAuth2Flows
IrObject
IrOperation
A fully resolved API operation (one HTTP method + path).
IrParameter
A fully resolved parameter.
IrProperty
IrRequestBody
A fully resolved request body.
IrResponse
A fully resolved response.
IrSchema
A named schema in the IR. Every schema has a name (its key in IrSpec.schemas), optional metadata, and a classified kind.
IrSecurityRequirement
Security requirement (operation-level or spec-level).
IrServer
Server definition.
IrSpec
The top-level intermediate representation of an OpenAPI specification. Version-agnostic — OAS 3.0, 3.1, and 3.2 all lower into this same type.
IrTaggedUnion
IrTaggedVariant
IrUnion
IrValidation
Validation constraints carried through from the spec.

Enums§

ApiKeyLocation
IrEnumValueType
IrPrimitive
Primitive types with optional format hints.
IrSchemaKind
Pre-classified schema kind. The lowering pass determines this once; generators match on it directly instead of re-interpreting raw spec fields.
IrSecurityScheme
Security scheme definition.
IrTypeExpr
A type expression that replaces ObjectOrReference<ObjectSchema> everywhere. Fully resolved — no $ref wrappers, no spec-version-specific types.
ParameterLocation
Where a parameter is located.
TaggingStyle