fix: improve rules to pass test cases

robert-hebel-sb · robert-hebel-sb · commit 2742a4fe25e6 · 2025-08-11T15:20:35.000+02:00
diff --git a/packages/apidom-ls/src/config/common/schema/lint/$ref-3-0--request-bodies.ts b/packages/apidom-ls/src/config/common/schema/lint/$ref-3-0--request-bodies.ts
@@ -2,7 +2,7 @@ import { DiagnosticSeverity } from 'vscode-languageserver-types';
 
 import ApilintCodes from '../../../codes.ts';
 import { LinterMeta } from '../../../../apidom-language-types.ts';
-import { OpenAPI3 } from '../../target-specs.ts';
+import { OpenAPI3 } from '../../../openapi/target-specs.ts';
 
 const $ref3RequestBodiesLint: LinterMeta = {
   code: ApilintCodes.OPENAPI3_0_REFERENCE_FIELD_$REF_REQUEST_BODIES,
@@ -12,6 +12,13 @@ const $ref3RequestBodiesLint: LinterMeta = {
   severity: DiagnosticSeverity.Error,
   linterFunction: 'parentExistFields',
   linterParams: [['requestBody']],
+  conditions: [
+    {
+      targets: [{ path: '$ref' }],
+      function: 'apilintValueRegex',
+      params: ['^(?!.*#/components/schemas).*$'],
+    },
+  ],
   marker: 'value',
   target: '$ref',
   data: {},
diff --git a/packages/apidom-ls/src/config/common/schema/lint/index.ts b/packages/apidom-ls/src/config/common/schema/lint/index.ts
@@ -3,6 +3,7 @@ import allowedFieldsOpenAPI3_0Lint from './allowed-fields-openapi-3-0.ts';
 import $idFormatURILint from './$id--format-uri.ts';
 import $refValidLint from './$ref--valid.ts';
 import $refNoSiblingsLint from './$ref--no-siblings.ts';
+import $ref3RequestBodiesLint from './$ref-3-0--request-bodies.ts';
 import additionalItemsNonArrayLint from './additional-items--non-array.ts';
 import additionalItemsTypeLint from './additional-items--type.ts';
 import additionalItemsTypeOpenAPI3_1__AsyncAPI2Lint from './additional-items--type-openapi-3-1--asyncapi-2.ts';
@@ -90,6 +91,7 @@ const schemaLints = [
   $refValidLint,
   $refNoSiblingsLint,
   $refNotUsedLint,
+  $ref3RequestBodiesLint,
   additionalItemsNonArrayLint,
   additionalItemsTypeLint,
   additionalItemsTypeOpenAPI3_1__AsyncAPI2Lint,
diff --git a/packages/apidom-ls/src/config/openapi/reference/lint/index.ts b/packages/apidom-ls/src/config/openapi/reference/lint/index.ts
@@ -3,17 +3,11 @@ import $ref2_0__3_0NoSiblingsLint from './$ref-2-0--3-0--no-siblings.ts';
 import $ref3_1AllowedSiblingsLint from './$ref-3-1--allowed-siblings.ts';
 import description3_1TypeLint from './description-3-1--type.ts';
 import summary3_1TypeLint from './summary-3-1--type.ts';
-import $ref3RequestBodiesLint from './$ref-3-0--request-bodies.ts';
-import $ref3RequestBodiesNamingLint from './$ref-3-0--request-bodies-naming.ts';
-import $ref3RequestBodiesNamingSchemaLint from './$ref-3-0--request-bodies-naming-schema.ts';
 
 const lints = [
   $refFormatURILint,
   $ref2_0__3_0NoSiblingsLint,
   $ref3_1AllowedSiblingsLint,
-  $ref3RequestBodiesLint,
-  $ref3RequestBodiesNamingLint,
-  $ref3RequestBodiesNamingSchemaLint,
   description3_1TypeLint,
   summary3_1TypeLint,
 ];
diff --git a/packages/apidom-ls/src/config/openapi/request-body/lint/$ref-3-0--request-bodies-naming-schema.ts b/packages/apidom-ls/src/config/openapi/request-body/lint/$ref-3-0--request-bodies-naming-schema.ts
diff --git a/packages/apidom-ls/src/config/openapi/request-body/lint/$ref-3-0--request-bodies-naming.ts b/packages/apidom-ls/src/config/openapi/request-body/lint/$ref-3-0--request-bodies-naming.ts
diff --git a/packages/apidom-ls/src/config/openapi/request-body/lint/index.ts b/packages/apidom-ls/src/config/openapi/request-body/lint/index.ts
@@ -4,8 +4,12 @@ import descriptionTypeLint from './description--type.ts';
 import contentValuesTypeLint from './content--values-type.ts';
 import contentRequiredLint from './content--required.ts';
 import requiredTypeLint from './required--type.ts';
+import $ref3RequestBodiesNamingLint from './$ref-3-0--request-bodies-naming.ts';
+import $ref3RequestBodiesNamingSchemaLint from './$ref-3-0--request-bodies-naming-schema.ts';
 
 const lints = [
+  $ref3RequestBodiesNamingLint,
+  $ref3RequestBodiesNamingSchemaLint,
   descriptionTypeLint,
   contentRequiredLint,
   contentValuesTypeLint,
diff --git a/packages/apidom-ls/src/config/openapi/schema/lint.ts b/packages/apidom-ls/src/config/openapi/schema/lint.ts
@@ -76,6 +76,7 @@ import uniqueItemsTypeLint from '../../common/schema/lint/unique-items--type.ts'
 import writeOnlyTypeLint from '../../common/schema/lint/write-only--type.ts';
 import exampleDeprecatedLint from '../../common/schema/lint/example--deprecated.ts';
 import $refNotUsedLint from '../../common/schema/lint/$ref--not-used.ts';
+import $ref3RequestBodiesLint from '../../common/schema/lint/$ref-3-0--request-bodies.ts';
 import { OpenAPI31 } from '../target-specs.ts';
 
 const schemaLints = [
@@ -156,6 +157,7 @@ const schemaLints = [
   writeOnlyTypeLint,
   exampleDeprecatedLint,
   $refNotUsedLint,
+  $ref3RequestBodiesLint,
 ];
 
 export default schemaLints;
diff --git a/packages/apidom-ls/src/services/validation/linter-functions.ts b/packages/apidom-ls/src/services/validation/linter-functions.ts
@@ -1147,20 +1147,21 @@ export const standardLinterfunctions: FunctionItem[] = [
   },
   {
     functionName: 'apilintReferenceNotUsed',
-    function: (element) => {
-      const elParent = element.parent?.parent?.parent?.parent;
-      if (!elParent.hasKey || !elParent.hasKey('schemas')) {
+    function: (element: Element & { content?: { key?: string } }) => {
+      const elParent: Element = element.parent?.parent?.parent?.parent;
+      if (typeof elParent.hasKey !== 'function' || !elParent.hasKey('schemas')) {
         return true;
       }
 
       const api = root(element);
-      const isReferenceElement = (el: Element) => el.element === 'reference';
+      const isReferenceElement = (el: Element & { content?: { key?: string } }) =>
+        toValue(el.content.key) === '$ref';
       const referenceElements = filter((el) => {
         return isReferenceElement(el);
       }, api);
       const referenceNames = referenceElements.map((refElement: Element) =>
         // @ts-expect-error
-        toValue(refElement.get('$ref')).split('/').at(-1),
+        toValue(refElement.content.value).split('/').at(-1),
       );
       // @ts-expect-error
       return referenceNames.includes(toValue(element.parent.key));
diff --git a/packages/apidom-ls/test/custom-rules.ts b/packages/apidom-ls/test/custom-rules.ts
@@ -87,8 +87,8 @@ describe('apidom-ls-validate-custom-rules', function () {
       },
       {
         range: {
-          start: { line: 13, character: 8 },
-          end: { line: 13, character: 17 },
+          start: { line: 15, character: 8 },
+          end: { line: 15, character: 17 },
         },
         message: 'properties MUST follow camelCase',
         severity: 1,
@@ -98,8 +98,8 @@ describe('apidom-ls-validate-custom-rules', function () {
       },
       {
         range: {
-          start: { line: 18, character: 4 },
-          end: { line: 18, character: 7 },
+          start: { line: 20, character: 4 },
+          end: { line: 20, character: 7 },
         },
         message: 'Parameter Object must contain one of the following fields: content, schema',
         severity: 1,
@@ -118,8 +118,8 @@ describe('apidom-ls-validate-custom-rules', function () {
       },
       {
         range: {
-          start: { line: 20, character: 6 },
-          end: { line: 20, character: 10 },
+          start: { line: 22, character: 6 },
+          end: { line: 22, character: 10 },
         },
         message: 'parameter names MUST follow camelCase',
         severity: 1,
@@ -129,8 +129,8 @@ describe('apidom-ls-validate-custom-rules', function () {
       },
       {
         range: {
-          start: { line: 21, character: 4 },
-          end: { line: 21, character: 8 },
+          start: { line: 23, character: 4 },
+          end: { line: 23, character: 8 },
         },
         message: 'Parameter Object must contain one of the following fields: content, schema',
         severity: 1,
@@ -149,8 +149,8 @@ describe('apidom-ls-validate-custom-rules', function () {
       },
       {
         range: {
-          start: { line: 24, character: 4 },
-          end: { line: 24, character: 7 },
+          start: { line: 26, character: 4 },
+          end: { line: 26, character: 7 },
         },
         message: 'Parameter Object must contain one of the following fields: content, schema',
         severity: 1,
@@ -200,31 +200,31 @@ describe('apidom-ls-validate-custom-rules', function () {
     const result = await languageService.doValidation(docOpenapi, validationContext);
     const expected: Diagnostic[] = [
       {
-        range: { start: { line: 23, character: 6 }, end: { line: 23, character: 10 } },
+        range: { start: { line: 25, character: 6 }, end: { line: 25, character: 10 } },
         message: 'parameter names MUST follow camelCase',
         severity: 1,
         code: 20002,
         source: 'apilint',
         data: {},
       },
       {
-        range: { start: { line: 32, character: 6 }, end: { line: 32, character: 10 } },
+        range: { start: { line: 34, character: 6 }, end: { line: 34, character: 10 } },
         message: 'parameter names MUST follow camelCase',
         severity: 1,
         code: 20002,
         source: 'apilint',
         data: {},
       },
       {
-        range: { start: { line: 16, character: 8 }, end: { line: 16, character: 17 } },
+        range: { start: { line: 18, character: 8 }, end: { line: 18, character: 17 } },
         message: 'keys MUST follow camelCase',
         severity: 1,
         code: 20001,
         source: 'apilint',
         data: {},
       },
       {
-        range: { start: { line: 31, character: 4 }, end: { line: 31, character: 7 } },
+        range: { start: { line: 33, character: 4 }, end: { line: 33, character: 7 } },
         message: 'keys MUST follow camelCase',
         severity: 1,
         code: 20001,
diff --git a/packages/apidom-ls/test/fixtures/custom-rules-jsonpath.yaml b/packages/apidom-ls/test/fixtures/custom-rules-jsonpath.yaml
@@ -9,6 +9,8 @@ paths:
   /keb-ab:
     get:
       operationId: kebab      
+  /endpoint:
+    $ref: '#/components/schemas/User'
 components:
   schemas:
     User:
diff --git a/packages/apidom-ls/test/fixtures/custom-rules-simple.yaml b/packages/apidom-ls/test/fixtures/custom-rules-simple.yaml
@@ -6,6 +6,8 @@ paths:
   /keb-ab:
     get:
       operationId: kebab      
+  /endpoint:
+    $ref: '#/components/schemas/User'
 components:
   schemas:
     User:
diff --git a/packages/apidom-ls/test/fixtures/deref/invalid.json b/packages/apidom-ls/test/fixtures/deref/invalid.json
@@ -48,6 +48,11 @@
                 "schema": {
                   "$ref": "#/components/schemas/exampleRef"
                 }
+              },
+              "text/html": {
+                "schema": {
+                  "$ref": "#/components/schemas/petRef"
+                }
               }
             }
           }
diff --git a/packages/apidom-ls/test/fixtures/deref/valid-same-ref.json b/packages/apidom-ls/test/fixtures/deref/valid-same-ref.json
@@ -4,6 +4,14 @@
     "title": "test",
     "version": "1.0"
   },
+  "paths": {
+    "/a": {
+      "$ref": "#/components/schemas/a"
+    },
+    "/b": {
+      "$ref": "#/components/schemas/b"
+    }
+  },
   "components": {
     "schemas": {
       "a": {
diff --git a/packages/apidom-ls/test/fixtures/validation/oas/valid/oas-3.0-petstore.yaml b/packages/apidom-ls/test/fixtures/validation/oas/valid/oas-3.0-petstore.yaml
@@ -706,6 +706,8 @@ components:
           description: User Status
           format: int32
           example: 1
+        items:
+          $ref: '#/components/schemas/Customer'
       xml:
         name: user
     Tag:
diff --git a/packages/apidom-ls/test/fixtures/validation/oas/valid/oas-3.1-basic.yaml b/packages/apidom-ls/test/fixtures/validation/oas/valid/oas-3.1-basic.yaml
@@ -25,6 +25,13 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/foo'
+    patch:
+      operationId: bpatch
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bar'
 components:
   schemas:
     foo:
diff --git a/packages/apidom-ls/test/openapi-json.ts b/packages/apidom-ls/test/openapi-json.ts
@@ -512,6 +512,23 @@ describe('apidom-ls', function () {
         code: 7030101,
         source: 'apilint',
       },
+      {
+        code: 3240300,
+        data: {},
+        message: 'Definition was declared but never used in document',
+        range: {
+          end: {
+            character: 15,
+            line: 27,
+          },
+          start: {
+            character: 6,
+            line: 27,
+          },
+        },
+        severity: 2,
+        source: 'apilint',
+      },
       {
         range: { start: { line: 30, character: 10 }, end: { line: 30, character: 14 } },
         message: 'Schema does not include any Schema Object keywords',
diff --git a/packages/apidom-ls/test/openapi-yaml.ts b/packages/apidom-ls/test/openapi-yaml.ts
@@ -520,6 +520,23 @@ describe('apidom-ls-yaml', function () {
         code: 7030101,
         source: 'apilint',
       },
+      {
+        code: 3240300,
+        data: {},
+        message: 'Definition was declared but never used in document',
+        range: {
+          end: {
+            character: 11,
+            line: 25,
+          },
+          start: {
+            character: 4,
+            line: 25,
+          },
+        },
+        severity: 2,
+        source: 'apilint',
+      },
       {
         range: { start: { line: 28, character: 8 }, end: { line: 28, character: 10 } },
         message: 'Schema does not include any Schema Object keywords',
diff --git a/packages/apidom-ls/test/validate-references.ts b/packages/apidom-ls/test/validate-references.ts
@@ -114,7 +114,7 @@ describe('reference validation', function () {
           },
         },
         {
-          range: { start: { line: 63, character: 16 }, end: { line: 63, character: 99 } },
+          range: { start: { line: 68, character: 16 }, end: { line: 68, character: 99 } },
           message:
             'Reference Error - JSONPointerKeyError: Invalid object key "PetInvalid" at position 2 in "/components/schemas/PetInvalid": key not found in object',
           severity: 1,
@@ -214,7 +214,7 @@ describe('reference validation', function () {
             },
           },
           {
-            range: { start: { line: 63, character: 16 }, end: { line: 63, character: 99 } },
+            range: { start: { line: 68, character: 16 }, end: { line: 68, character: 99 } },
             message:
               'Reference Error - JSONPointerKeyError: Invalid object key "PetInvalid" at position 2 in "/components/schemas/PetInvalid": key not found in object',
             severity: 1,
diff --git a/packages/apidom-ls/test/validate.ts b/packages/apidom-ls/test/validate.ts
@@ -3210,7 +3210,25 @@ describe('apidom-ls-validate', function () {
 
     const result = await languageService.doValidation(doc, validationContext);
     result[0].code = 'test';
+    result[1].code = 'test';
     const expected: Diagnostic[] = [
+      {
+        code: 'test',
+        data: {},
+        message: 'Definition was declared but never used in document',
+        range: {
+          end: {
+            character: 7,
+            line: 31,
+          },
+          start: {
+            character: 4,
+            line: 31,
+          },
+        },
+        severity: 2,
+        source: 'apilint',
+      },
       {
         range: { start: { line: 39, character: 12 }, end: { line: 39, character: 50 } },
         message: 'local reference not found',
