feat(apidom-ls): after comment changes

swagger-api · Jan 2, 2024 · ccf0fcf · ccf0fcf
1 parent 8946e5f
commit ccf0fcf
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 30 deletions.
diff --git a/packages/apidom-ls/src/services/validation/linter-functions.ts b/packages/apidom-ls/src/services/validation/linter-functions.ts
@@ -11,7 +11,7 @@ import {
   isArrayElement,
 } from '@swagger-api/apidom-core';
 import { CompletionItem } from 'vscode-languageserver-types';
-import { test, resolve } from 'openapi-path-templating';
+import { test, resolve, parse } from 'openapi-path-templating';
 
 // eslint-disable-next-line import/no-cycle
 import {
@@ -1072,26 +1072,29 @@ export const standardLinterfunctions: FunctionItem[] = [
     functionName: 'apilintOpenAPIParameterFieldIsDefinedWithinPathTemplate',
     function: (element: Element) => {
       if (element.element === 'parameter') {
-        const allowedLocations = ['path', 'query'];
-        const parameterToValue: ObjectElement = toValue(element);
-        const parameterName = parameterToValue.get('name');
-        const parameterLocation = parameterToValue.get('in');
+        const parameterName = toValue((element as ObjectElement).get('name'));
+        const parameterLocation = toValue((element as ObjectElement).get('in'));
+
+        if (parameterLocation !== 'path') {
+          return true;
+        }
 
         const isChildOfOperationElement = (el: Element): boolean =>
           el.parent.parent.parent.element === 'operation';
 
-        if (isChildOfOperationElement(element)) {
-          const pathTemplate: string = toValue(
-            (element.parent.parent.parent.parent.parent.parent as MemberElement).key,
-          );
+        const pathTemplateASTIncludesParameter = (ast: [string, string][]) =>
+          ast.findIndex(
+            ([name, value]) => name === 'template-expression-param-name' && value === parameterName,
+          ) > -1;
 
-          if (!allowedLocations.includes(parameterLocation)) {
-            return true;
-          }
+        if (isChildOfOperationElement(element)) {
+          const pathTemplate = toValue(element.parent.parent.parent.parent.parent.meta.get('path'));
+          const parseResult = parse(pathTemplate);
+          const parts: [string, string][] = [];
 
-          return pathTemplate.includes(parameterName);
+          parseResult.ast.translate(parts);
 
-          // TODO: handle case when parameter is not child of operation element
+          return pathTemplateASTIncludesParameter(parts);
         }
       }
       return true;

diff --git a/...es/apidom-ls/test/fixtures/validation/oas/parameter-defined-within-path-template-2-0.yaml b/...es/apidom-ls/test/fixtures/validation/oas/parameter-defined-within-path-template-2-0.yaml
@@ -7,10 +7,7 @@ parameters:
       name: test_id
       in: path
       required: true
-      schema:
-        type: string
-        format: uuid
-        title: Test Id
+      type: string
 paths:
   /foo/{bar_id}:
     delete:
@@ -20,17 +17,11 @@ paths:
         - name: foo_id
           in: path
           required: true
-          schema:
-            type: string
-            format: uuid
-            title: Foo Id
+          type: string
         - name: bar_id
           in: path
           required: true
-          schema:
-            type: string
-            format: uuid
-            title: Bar Id
+          type: string
       responses:
         '200':
           description: Successful Response

diff --git a/packages/apidom-ls/test/validate.ts b/packages/apidom-ls/test/validate.ts
@@ -3580,10 +3580,10 @@ describe('apidom-ls-validate', function () {
     const result = await languageService.doValidation(doc, validationContext);
     const expected: Diagnostic[] = [
       {
-        range: { start: { line: 19, character: 10 }, end: { line: 25, character: 25 } },
+        range: { start: { line: 16, character: 10 }, end: { line: 19, character: 22 } },
         message: 'parameter is not defined within path template',
         severity: 1,
-        code: 3090100,
+        code: 3102000,
         source: 'apilint',
       },
     ];
@@ -3625,7 +3625,7 @@ describe('apidom-ls-validate', function () {
         range: { start: { line: 20, character: 10 }, end: { line: 26, character: 25 } },
         message: 'parameter is not defined within path template',
         severity: 1,
-        code: 3090100,
+        code: 3102000,
         source: 'apilint',
       },
     ];
@@ -3667,7 +3667,7 @@ describe('apidom-ls-validate', function () {
         range: { start: { line: 20, character: 10 }, end: { line: 26, character: 25 } },
         message: 'parameter is not defined within path template',
         severity: 1,
-        code: 3090100,
+        code: 3102000,
         source: 'apilint',
       },
     ];