feat: allow linting OpenAPI path templates (#3532)

Refs #3517
swagger-api · Dec 13, 2023 · b0b03a2 · b0b03a2
1 parent ab11beb
commit b0b03a2
Show file tree

Hide file tree

Showing 22 changed files with 1,011 additions and 28 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/apidom-ls/package.json b/packages/apidom-ls/package.json
@@ -116,6 +116,7 @@
     "@swagger-api/apidom-parser-adapter-yaml-1-2": "^0.87.0",
     "@swagger-api/apidom-reference": "^0.87.0",
     "@types/ramda": "~0.29.6",
+    "openapi-path-templating": "^1.2.0",
     "ramda": "~0.29.1",
     "ramda-adjunct": "^4.1.1",
     "vscode-languageserver-protocol": "^3.17.2",

diff --git a/packages/apidom-ls/src/config/codes.ts b/packages/apidom-ls/src/config/codes.ts
@@ -650,6 +650,10 @@ enum ApilintCodes {
 
   OPENAPI2_INFO = 3030000,
 
+  OPENAPI2_PATH_TEMPLATE = 3040000,
+  OPENAPI2_PATH_TEMPLATE_VALUE_WELL_FORMED = 3040100,
+  OPENAPI2_PATH_TEMPLATE_VALUE_VALID,
+
   OPENAPI3_0 = 5000000,
 
   OPENAPI3_0_OPENAPI_VALUE_PATTERN_3_0_0 = 5000100,
@@ -723,8 +727,7 @@ enum ApilintCodes {
   OPENAPI3_O_SERVER_VARIABLE_FIELD_DESCRIPTION_TYPE = 5080300,
 
   OPENAPI3_0_PATHS = 5090000,
-  OPENAPI3_0_PATHS_KEYS_PATTERN,
-  OPENAPI3_0_PATHS_VALUES_PATTERN,
+  OPENAPI3_0_PATHS_VALUES_TYPE,
 
   OPENAPI_3_0_SECURITY_REQUIREMENT = 5100000,
   OPENAPI_3_0_SECURITY_REQUIREMENT_KEYS_DEFINED,

diff --git a/packages/apidom-ls/src/config/openapi/config.ts b/packages/apidom-ls/src/config/openapi/config.ts
@@ -33,6 +33,7 @@ import serverVariableMeta from './server-variable/meta';
 import swaggerMeta from './swagger/meta';
 import tagMeta from './tag/meta';
 import xmlMeta from './xml/meta';
+import pathTemplateMeta from './path-template/meta';
 import schemaMeta from '../common/schema/meta';
 import ApilintCodes from '../codes';
 
@@ -83,4 +84,5 @@ export default {
   tag: tagMeta,
   xml: xmlMeta,
   schema: schemaMeta,
+  'path-template': pathTemplateMeta,
 };
diff --git a/packages/apidom-ls/src/config/openapi/path-template/lint/index.ts b/packages/apidom-ls/src/config/openapi/path-template/lint/index.ts
@@ -0,0 +1,6 @@
+import valueWellFormedLint from './value--well-formed';
+import valueValidLint from './value--valid';
+
+const lints = [valueWellFormedLint, valueValidLint];
+
+export default lints;
diff --git a/packages/apidom-ls/src/config/openapi/path-template/lint/value--valid.ts b/packages/apidom-ls/src/config/openapi/path-template/lint/value--valid.ts
@@ -0,0 +1,23 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+import { OpenAPI } from '../../target-specs';
+
+const valueValidLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_PATH_TEMPLATE_VALUE_VALID,
+  source: 'apilint',
+  message: 'path template expressions is not matched with Parameter Object(s)',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintOpenAPIPathTemplateValid',
+  marker: 'value',
+  targetSpecs: OpenAPI,
+  conditions: [
+    {
+      function: 'apilintOpenAPIPathTemplateWellFormed',
+      params: [true],
+    },
+  ],
+};
+
+export default valueValidLint;
diff --git a/packages/apidom-ls/src/config/openapi/path-template/lint/value--well-formed.ts b/packages/apidom-ls/src/config/openapi/path-template/lint/value--well-formed.ts
@@ -0,0 +1,18 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+import { OpenAPI } from '../../target-specs';
+
+const valueWellFormedLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_PATH_TEMPLATE_VALUE_WELL_FORMED,
+  source: 'apilint',
+  message: "'path' must begin with '/' and be relative to an individual endpoint",
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintOpenAPIPathTemplateWellFormed',
+  linterParams: [false],
+  marker: 'value',
+  targetSpecs: OpenAPI,
+};
+
+export default valueWellFormedLint;
diff --git a/packages/apidom-ls/src/config/openapi/path-template/meta.ts b/packages/apidom-ls/src/config/openapi/path-template/meta.ts
@@ -0,0 +1,8 @@
+import lint from './lint';
+import { FormatMeta } from '../../../apidom-language-types';
+
+const meta: FormatMeta = {
+  lint,
+};
+
+export default meta;
diff --git a/packages/apidom-ls/src/config/openapi/paths/lint/index.ts b/packages/apidom-ls/src/config/openapi/paths/lint/index.ts
@@ -1,6 +1,5 @@
-import keysPatternLint from './keys--pattern';
 import valuesTypeLint from './values--type';
 
-const lints = [valuesTypeLint, keysPatternLint];
+const lints = [valuesTypeLint];
 
 export default lints;
diff --git a/packages/apidom-ls/src/config/openapi/paths/lint/keys--pattern.ts b/packages/apidom-ls/src/config/openapi/paths/lint/keys--pattern.ts
diff --git a/packages/apidom-ls/src/config/openapi/paths/lint/values--type.ts b/packages/apidom-ls/src/config/openapi/paths/lint/values--type.ts
@@ -5,7 +5,7 @@ import { LinterMeta } from '../../../../apidom-language-types';
 import { OpenAPI3 } from '../../target-specs';
 
 const valuesTypeLint: LinterMeta = {
-  code: ApilintCodes.OPENAPI3_0_PATHS_VALUES_PATTERN,
+  code: ApilintCodes.OPENAPI3_0_PATHS_VALUES_TYPE,
   source: 'apilint',
   message: 'Paths Object values must be of Path Item Object shape',
   severity: DiagnosticSeverity.Error,

diff --git a/packages/apidom-ls/src/services/validation/linter-functions.ts b/packages/apidom-ls/src/services/validation/linter-functions.ts
@@ -3,12 +3,14 @@ import {
   Element,
   ArrayElement,
   MemberElement,
+  isStringElement,
   filter,
   toValue,
   ArraySlice,
   ObjectElement,
 } from '@swagger-api/apidom-core';
 import { CompletionItem } from 'vscode-languageserver-types';
+import { test } from 'openapi-path-templating';
 
 // eslint-disable-next-line import/no-cycle
 import {
@@ -993,4 +995,23 @@ export const standardLinterfunctions: FunctionItem[] = [
       return true;
     },
   },
+  {
+    functionName: 'apilintOpenAPIPathTemplateWellFormed',
+    function: (element: Element, strict = false) => {
+      if (isStringElement(element)) {
+        const pathTemplate = toValue(element);
+        return test(pathTemplate, { strict });
+      }
+      return true;
+    },
+  },
+  {
+    functionName: 'apilintOpenAPIPathTemplateValid',
+    function: (element: Element) => {
+      if (isStringElement(element)) {
+        return true;
+      }
+      return true;
+    },
+  },
 ];
diff --git a/...ms/test/refractor/plugins/openapi-3-1/__snapshots__/standard-identifier-selectors.ts.snap b/...ms/test/refractor/plugins/openapi-3-1/__snapshots__/standard-identifier-selectors.ts.snap
@@ -91,13 +91,43 @@ exports[`given OpenAPI 3.1 definition should decorate with API Design Systems St
               "content": {
                 "key": {
                   "element": "string",
+                  "meta": {
+                    "classes": {
+                      "element": "array",
+                      "content": [
+                        {
+                          "element": "string",
+                          "content": "openapi-path-template"
+                        },
+                        {
+                          "element": "string",
+                          "content": "path-template"
+                        }
+                      ]
+                    }
+                  },
                   "content": "/path1"
                 },
                 "value": {
                   "element": "pathItem",
                   "meta": {
                     "path": {
                       "element": "string",
+                      "meta": {
+                        "classes": {
+                          "element": "array",
+                          "content": [
+                            {
+                              "element": "string",
+                              "content": "openapi-path-template"
+                            },
+                            {
+                              "element": "string",
+                              "content": "path-template"
+                            }
+                          ]
+                        }
+                      },
                       "content": "/path1"
                     }
                   },

diff --git a/packages/apidom-ns-openapi-2/src/refractor/visitors/open-api-2/paths/index.ts b/packages/apidom-ns-openapi-2/src/refractor/visitors/open-api-2/paths/index.ts
@@ -1,5 +1,5 @@
 import stampit from 'stampit';
-import { test, always } from 'ramda';
+import { T as stubTrue, always } from 'ramda';
 import { ObjectElement, StringElement, cloneDeep } from '@swagger-api/apidom-core';
 
 import PathsElement from '../../../../elements/Paths';
@@ -10,7 +10,7 @@ import { isPathItemElement } from '../../../../predicates';
 
 const PathsVisitor = stampit(PatternedFieldsVisitor, FallbackVisitor, {
   props: {
-    fieldPatternPredicate: test(/^\/(?<path>.*)$/),
+    fieldPatternPredicate: stubTrue,
     specPath: always(['document', 'objects', 'PathItem']),
     canSupportSpecificationExtensions: true,
   },
@@ -26,6 +26,8 @@ const PathsVisitor = stampit(PatternedFieldsVisitor, FallbackVisitor, {
       this.element
         .filter(isPathItemElement)
         .forEach((pathItemElement: PathItemElement, key: StringElement) => {
+          key.classes.push('openapi-path-template');
+          key.classes.push('path-template');
           pathItemElement.setMetaProperty('path', cloneDeep(key));
         });