feat(ls): add OpenAPI 3.x validation for Paramter.style fixed field (#4955)

Closes #2355

Author: lukaszzazulak

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

@@ -982,7 +982,7 @@ enum ApilintCodes {
   OPENAPI3_0_PARAMETER_FIELD_REQUIRED_EQUALS,
   OPENAPI3_0_PARAMETER_FIELD_DEPRECATED_TYPE = 5150600,
   OPENAPI3_0_PARAMETER_FIELD_ALLOW_EMPTY_VALUE_TYPE = 5150700,
-  OPENAPI3_0_PARAMETER_FIELD_STYLE_TYPE = 5150800,
+  OPENAPI3_0_PARAMETER_FIELD_STYLE_EQUALS = 5150800,
   OPENAPI3_0_PARAMETER_FIELD_EXPLODE_TYPE = 5150900,
   OPENAPI3_0_PARAMETER_FIELD_ALLOW_RESERVED_TYPE = 5151000,
   OPENAPI3_0_PARAMETER_FIELD_SCHEMA_TYPE = 5151100,

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

@@ -14,7 +14,7 @@ import requiredRequiredLint from './required--required.ts';
 import requiredEqualsLint from './required--equals.ts';
 import deprecatedTypeLint from './deprecated--type.ts';
 import allowEmptyValueTypeLint from './allow-empty-value--type.ts';
-import styleTypeLint from './style--type.ts';
+import styleEqualsLint from './style--equals.ts';
 import explodeTypeLint from './explode--type.ts';
 import allowReservedTypeLint from './allow-reserved--type.ts';
 import schemaTypeLint from './schema--type.ts';
@@ -56,7 +56,7 @@ const lints = [
   requiredEqualsLint,
   deprecatedTypeLint,
   allowEmptyValueTypeLint,
-  styleTypeLint,
+  styleEqualsLint,
   explodeTypeLint,
   allowReservedTypeLint,
   schemaTypeLint,

packages/apidom-ls/src/config/openapi/parameter/lint/style--type.ts renamed to packages/apidom-ls/src/config/openapi/parameter/lint/style--equals.ts

@@ -4,17 +4,17 @@ import ApilintCodes from '../../../codes.ts';
 import { LinterMeta } from '../../../../apidom-language-types.ts';
 import { OpenAPI3 } from '../../target-specs.ts';
 
-const styleTypeLint: LinterMeta = {
-  code: ApilintCodes.OPENAPI3_0_PARAMETER_FIELD_STYLE_TYPE,
+const styleEqualsLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_PARAMETER_FIELD_STYLE_EQUALS,
   source: 'apilint',
-  message: 'style must be a string',
+  message: 'style must be one of allowed values: form, simple',
   severity: DiagnosticSeverity.Error,
-  linterFunction: 'apilintType',
-  linterParams: ['string'],
+  linterFunction: 'apilintValueOrArray',
+  linterParams: [['form', 'simple']],
   marker: 'value',
   target: 'style',
   data: {},
   targetSpecs: OpenAPI3,
 };
 
-export default styleTypeLint;
+export default styleEqualsLint;

packages/apidom-ls/test/fixtures/validation/sample-api-validation-parameters.yaml

@@ -0,0 +1,23 @@
+openapi: 3.1.0
+info:
+  title: Foo
+  version: 0.1.0
+paths:
+  /foo/find:
+    get:
+      parameters:
+        - name: fooId
+          in: query
+          schema:
+            type: string
+          style: label
+        - name: name
+          in: query
+          schema:
+            type: string
+          style: simple
+        - name: status
+          in: query
+          schema:
+            type: string
+          style: form

packages/apidom-ls/test/validate.ts

@@ -3757,4 +3757,35 @@ describe('apidom-ls-validate', function () {
 
     languageService.terminate();
   });
+
+  it('oas - parameters style should allow only "simple" and "form" values', async function () {
+    const spec = fs
+      .readFileSync(
+        path.join(__dirname, 'fixtures', 'validation', 'sample-api-validation-parameters.yaml'),
+      )
+      .toString();
+    const doc: TextDocument = TextDocument.create(
+      'foo://bar/sample-api-validation-parameters.yaml',
+      'yaml',
+      0,
+      spec,
+    );
+
+    const languageService: LanguageService = getLanguageService(contextNoSchema);
+
+    const result = await languageService.doValidation(doc);
+    const expected: Diagnostic[] = [
+      {
+        message: 'style must be one of allowed values: form, simple',
+        severity: 1,
+        code: 5150800,
+        source: 'apilint',
+        data: {},
+        range: { start: { line: 12, character: 17 }, end: { line: 12, character: 22 } },
+      },
+    ];
+    assert.deepEqual(result, expected);
+
+    languageService.terminate();
+  });
 });