OpenApiComponentKind enumeration

Represents the fixed component buckets defined by the OpenAPI 3.2 specification under the components object.

public enum OpenApiComponentKind

Values

name value description
Schemas 0 Reusable schema definitions for request and response payloads. Maps to components/schemas.
Responses 1 Reusable response definitions. Maps to components/responses.
Parameters 2 Reusable parameter definitions (query, header, path, cookie). Maps to components/parameters.
Examples 3 Reusable example definitions. Maps to components/examples.
RequestBodies 4 Reusable request body definitions. Maps to components/requestBodies.
Headers 5 Reusable header definitions. Maps to components/headers.
SecuritySchemes 6 Reusable security scheme definitions (OAuth2, API key, HTTP auth, etc.). Maps to components/securitySchemes.
Links 7 Reusable link definitions describing relationships between operations. Maps to components/links.
Callbacks 8 Reusable callback definitions for asynchronous or event-driven APIs. Maps to components/callbacks.
PathItems 9 Reusable path item definitions. Maps to components/pathItems.
MediaTypes 10 Reusable media type definitions (introduced in OpenAPI 3.2). Maps to components/mediaTypes.

Remarks

This enum mirrors the OpenAPI 3.2 Components Object exactly. It is intended for dispatch, existence checks, retrieval, and removal logic over OpenApiComponents.

See Also