fix: parse openApi path level parameters

sunlei · sunlei · commit 4953e7b09cda · 2023-03-07T12:24:23.000+08:00
diff --git a/server/node-service/src/plugins/openApi/parse.ts b/server/node-service/src/plugins/openApi/parse.ts
@@ -254,10 +254,16 @@ export async function parseOpenApi(
       let params: ActionParamConfig[] = [];
 
       if (main === 2) {
-        params = parseSwagger2Operation(operation as OpenAPIV2.OperationObject);
+        params = parseSwagger2Operation(
+          operation as OpenAPIV2.OperationObject,
+          pathSpec as OpenAPIV2.PathItemObject
+        );
       }
       if (main === 3) {
-        params = parseOas3Operation(operation as OpenAPIV3.OperationObject);
+        params = parseOas3Operation(
+          operation as OpenAPIV3.OperationObject,
+          pathSpec as OpenAPIV3.PathItemObject
+        );
       }
       const action: ActionConfig = {
         category: operation.tags || "",
diff --git a/server/node-service/src/plugins/openApi/parse/oas3.ts b/server/node-service/src/plugins/openApi/parse/oas3.ts
@@ -61,14 +61,18 @@ const schemaToActionParamConfig = (
   return param;
 };
 
-export function parseOperation(operation?: OpenAPIV3.OperationObject): ActionParamConfig[] {
+export function parseOperation(
+  operation?: OpenAPIV3.OperationObject,
+  pathSpec?: OpenAPIV3.PathItemObject
+): ActionParamConfig[] {
   const params: ActionParamConfig[] = [];
-  if (!operation) {
+  if (!operation || !pathSpec) {
     return [];
   }
-  const { parameters, requestBody } = operation;
+  const { parameters: pathParameters = [] } = pathSpec;
+  const { parameters = [], requestBody } = operation;
 
-  parameters?.forEach((i) => {
+  pathParameters.concat(parameters).forEach((i) => {
     if (isRefObject(i)) {
       console.warn("unexpected ref parameters:", i);
       return;
diff --git a/server/node-service/src/plugins/openApi/parse/swagger2.ts b/server/node-service/src/plugins/openApi/parse/swagger2.ts
@@ -33,10 +33,14 @@ const openApiV2TypeMap: Record<string, ActionParamType> = {
   file: "file",
 };
 
-export function parseOperation(operation: OpenAPIV2.OperationObject): ActionParamConfig[] {
+export function parseOperation(
+  operation: OpenAPIV2.OperationObject,
+  pathSpec: OpenAPIV2.PathItemObject
+): ActionParamConfig[] {
   const params: ActionParamConfig[] = [];
-
-  operation.parameters?.forEach((paramSpec) => {
+  const pathParametersSpec = pathSpec.parameters || [];
+  const operationParametersSpec = operation.parameters || [];
+  pathParametersSpec.concat(operationParametersSpec).forEach((paramSpec) => {
     if (isRefObject(paramSpec)) {
       console.warn("unexpected ref parameters:", paramSpec);
       return;
