interface OpenApiParameter
Since 0.1.0

OpenAPI parameter definition.

Properties

readonly
name: string

Parameter name.

readonly
in: "path" | "query" | "header" | "cookie"

Parameter location.

readonly
required: boolean

Whether parameter is required.

Parameter schema.

readonly
optional
description: string

Parameter description.

Usage

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