feat: add reference parameter rule

Author: robert-hebel-sb

packages/apidom-ls/src/config/codes.ts

@@ -1075,6 +1075,7 @@ enum ApilintCodes {
   OPENAPI3_0_REFERENCE_FIELD_$REF_REQUEST_BODIES_NAMING,
   OPENAPI3_0_REFERENCE_FIELD_$REF_REQUEST_BODIES_NAMING_SCHEMA,
   OPENAPI3_0_REFERENCE_FIELD_$REF_HEADER = 5260300,
+  OPENAPI3_0_REFERENCE_FIELD_$REF_PARAMETER = 5260400,
 
   OPENAPI3_0_LINK = 5270000,
   OPENAPI3_0_LINK_FIELD_OPERATION_REF_FORMAT_URI = 5270100,

packages/apidom-ls/src/config/openapi/parameter/lint/$ref-3-0--parameter.ts

@@ -0,0 +1,21 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI3 } from '../../target-specs.ts';
+
+const $ref3ParameterNamingLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_REFERENCE_FIELD_$REF_PARAMETER,
+  source: 'apilint',
+  message: 'OAS3 parameter $Ref should point to Parameter Object',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintValueRegex',
+  linterParams: ['^(.*#/components/parameters).*$'],
+  marker: 'value',
+  target: '$ref',
+  targetFields: true,
+  data: {},
+  targetSpecs: OpenAPI3,
+};
+
+export default $ref3ParameterNamingLint;

packages/apidom-ls/src/config/openapi/parameter/lint/index.ts

@@ -47,8 +47,10 @@ import inAuthorizationLint from './in--authorization.ts';
 import inContentTypeLint from './in--content-type.ts';
 import inAcceptLint from './in--accept.ts';
 import inMultipleBody from './in--multiple-body.ts';
+import $ref3ParameterNamingLint from './$ref-3-0--parameter.ts';
 
 const lints = [
+  $ref3ParameterNamingLint,
   nameTypeLint,
   nameRequiredLint,
   inEquals2_0Lint,

packages/apidom-ls/test/fixtures/validation/oas/ref-parameter.yaml

@@ -0,0 +1,16 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: 'test'
+paths:
+  /foo:
+    parameters:
+      - $ref: '#/components/headers/MyHeader'
+components:
+  headers:
+    MyHeader:
+      description: ID of the user
+      required: true
+      schema:
+        type: string
+

packages/apidom-ls/test/validate.ts

@@ -3255,6 +3255,66 @@ describe('apidom-ls-validate', function () {
     languageService.terminate();
   });
 
+  it('oas 3.0 / yaml - OAS3 parameter $Ref should point to Parameter Object', async function () {
+    const validationContext: ValidationContext = {
+      comments: DiagnosticSeverity.Error,
+      maxNumberOfProblems: 100,
+      relatedInformation: false,
+    };
+
+    const spec = fs
+      .readFileSync(path.join(__dirname, 'fixtures', 'validation', 'oas', 'ref-parameter.yaml'))
+      .toString();
+    const doc: TextDocument = TextDocument.create('foo://bar/ref-parameter.yaml', 'yaml', 0, spec);
+
+    const languageService: LanguageService = getLanguageService(contextNoSchema);
+    const result = await languageService.doValidation(doc, validationContext);
+
+    result[0].code = 'test';
+
+    const expected: Diagnostic[] = [
+      {
+        code: 'test',
+        data: {
+          quickFix: [],
+        },
+        message: 'local reference not found',
+        range: {
+          end: {
+            character: 45,
+            line: 7,
+          },
+          start: {
+            character: 14,
+            line: 7,
+          },
+        },
+        severity: 1,
+        source: 'apilint',
+      },
+      {
+        code: 5260400,
+        data: {},
+        message: 'OAS3 parameter $Ref should point to Parameter Object',
+        range: {
+          end: {
+            character: 45,
+            line: 7,
+          },
+          start: {
+            character: 14,
+            line: 7,
+          },
+        },
+        severity: 1,
+        source: 'apilint',
+      },
+    ];
+    assert.deepEqual(result, expected as Diagnostic[]);
+
+    languageService.terminate();
+  });
+
   it('oas / yaml - test editor issue 3626 / inidrect ref', async function () {
     const validationContext: ValidationContext = {
       comments: DiagnosticSeverity.Error,