interface OpenApiOperation
Since 0.1.0

OpenAPI operation definition.

Properties

readonly
operationId: string

Unique operation identifier.

readonly
optional
summary: string

Operation summary.

readonly
optional
tags: readonly string[]

Operation tags.

readonly
optional
parameters: readonly OpenApiParameter[]

Path/query parameters.

Request body.

readonly
responses: Record<string, OpenApiResponse>

Response codes.

Since 0.1.0-alpha.10
readonly
optional
x-setu-unrepresentable: readonly { readonly at: string; readonly reason: string; }[]

Machine-readable vendor extension naming the schema nodes on THIS operation the transformer could not represent (a zod z.date() field, for example). Each entry names the operation (at) and why (reason). The node itself still degrades to an empty schema — never a throw — so a single unrepresentable field cannot take down /openapi.json. Absent when empty.

readonly
optional
security: readonly SecurityRequirement[]

Security requirements for this operation — declared on the route's schema.security, or derived from its branded guards when OpenApiGeneratorOptions.deriveSecurity is configured (declared wins). Absent when neither applies, which leaves the operation inheriting the document-level requirement; an empty array marks it public, overriding that default.

Usage

import { type OpenApiOperation } from "openapi-plugin/src/index.ts";