Skip to content

fix(openapi): recursively merge openapi paramteres #3536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(openapi): recursively merge openapi paramteres #3536

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions src/runtime/internal/routes/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,11 @@ function getHandlersMeta(): {
let globals: OpenAPIGlobals = {};

for (const h of handlersMeta) {
const { route, parameters } = normalizeRoute(h.route || "");
const { $global, ...openAPI } = h.meta?.openAPI || {};
const { route, parameters: _parameters } = normalizeRoute(h.route || "", openAPI);
const parameters = defu(openAPI.parameters || [], _parameters);
const tags = defaultTags(h.route || "");
const method = (h.method || "get").toLowerCase() as Lowercase<HTTPMethod>;
const { $global, ...openAPI } = h.meta?.openAPI || {};

const item: PathItemObject = {
[method]: <OperationObject>{
Expand Down Expand Up @@ -99,8 +100,9 @@ function getHandlersMeta(): {
return { paths, globals };
}

function normalizeRoute(_route: string) {
function normalizeRoute(_route: string, openAPI: OperationObject) {
const parameters: ParameterObject[] = [];
const userDefinedParameters = (Array.isArray(openAPI.parameters) ? openAPI.parameters : []) as ParameterObject[];

let anonymousCtr = 0;
const route = _route
Expand All @@ -113,6 +115,12 @@ function normalizeRoute(_route: string) {
for (const match of paramMatches) {
const name = match[1];
if (!parameters.some((p) => p.name === name)) {
if (userDefinedParameters.some((p) => p.name === name)) {
/**
* If user has already defined the path variable, let that take precedence.
*/
continue;
}
parameters.push({
name,
in: "path",
Expand Down