feat: migrate multiple body rule

Author: robert-hebel-sb

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

@@ -717,6 +717,7 @@ enum ApilintCodes {
   OPENAPI2_PARAMETER_FIELD_IN_EQUALS = 3100200,
   OPENAPI2_PARAMETER_FIELD_IN_REQUIRED,
   OPENAPI2_PARAMETER_FIELD_IN_VALID,
+  OPENAPI2_PARAMETER_FIELD_IN_MULTIPLE_BODY,
   OPENAPI2_PARAMETER_FIELD_DESCRIPTION_TYPE = 3100300,
   OPENAPI2_PARAMETER_FIELD_REQUIRED_TYPE = 3100400,
   OPENAPI2_PARAMETER_FIELD_REQUIRED_REQUIRED,

packages/apidom-ls/src/config/openapi/parameter/lint/in--multiple-body.ts

@@ -0,0 +1,27 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import { OpenAPI2 } from '../../target-specs.ts';
+import ApilintCodes from '../../../codes.ts';
+
+const inMultipleBody = {
+  code: ApilintCodes.OPENAPI2_PARAMETER_FIELD_IN_MULTIPLE_BODY,
+  source: 'apilint',
+  message: 'Multiple body parameters are not allowed',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintPropertyUniqueSiblingValue',
+  linterParams: [['parameters'], 'in'],
+  marker: 'key',
+  markerTarget: 'in',
+  target: 'in',
+  conditions: [
+    {
+      targets: [{ path: 'in' }],
+      function: 'apilintContainsValue',
+      params: ['body'],
+    },
+  ],
+  data: {},
+  targetSpecs: OpenAPI2,
+};
+
+export default inMultipleBody;

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

@@ -46,6 +46,7 @@ import uniqueNameLint from './unique-name.ts';
 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';
 
 const lints = [
   nameTypeLint,
@@ -96,6 +97,7 @@ const lints = [
   inPathTemplateLint,
   inContentTypeLint,
   inAcceptLint,
+  inMultipleBody,
 ];
 
 export default lints;

packages/apidom-ls/src/services/validation/linter-functions.ts

@@ -799,15 +799,22 @@ export const standardLinterfunctions: FunctionItem[] = [
     functionName: 'apilintPropertyUniqueSiblingValue',
     function: (element, elementOrClasses, key) => {
       const value = toValue(element);
+
+      const filterSiblingsOAS2 = (el: Element) =>
+        isString(el) &&
+        (el.parent.key as { content?: string })?.content === key &&
+        el.content === value;
+
+      const filterSiblingsOAS3 = (el: Element) =>
+        isObject(el) && el.hasKey(key) && toValue(el.get(key)) === value;
+
       const elements = filter((el) => {
         const classes: string[] = toValue(el.getMetaProperty('classes', []));
 
         return (
           (elementOrClasses.includes(el.element) ||
             classes.every((v) => elementOrClasses.includes(v))) &&
-          isObject(el) &&
-          el.hasKey(key) &&
-          toValue(el.get(key)) === value
+          (filterSiblingsOAS2(el) || filterSiblingsOAS3(el))
         );
       }, element.parent?.parent?.parent);
       return elements.length <= 1;

packages/apidom-ls/test/fixtures/validation/oas/parameter-in-multiple-body.yaml

@@ -0,0 +1,19 @@
+swagger: '2.0'
+info:
+  title: 'test'
+  version: 1.0.0
+paths:
+  /:
+    get:
+      responses:
+        default:
+          description: 'test'
+      consumes:
+        - multipart/form-data
+      parameters:
+        - in: body
+          name: Else1
+          schema: {}
+        - in: body
+          name: Else2
+          schema: {}

packages/apidom-ls/test/validate.ts

@@ -3861,6 +3861,69 @@ describe('apidom-ls-validate', function () {
     languageService.terminate();
   });
 
+  it('oas 2.0 / yaml - Multiple body parameters are not allowed', async function () {
+    const validationContext: ValidationContext = {
+      comments: DiagnosticSeverity.Error,
+      maxNumberOfProblems: 100,
+      relatedInformation: false,
+    };
+
+    const spec = fs
+      .readFileSync(
+        path.join(__dirname, 'fixtures', 'validation', 'oas', 'parameter-in-multiple-body.yaml'),
+      )
+      .toString();
+    const doc: TextDocument = TextDocument.create(
+      'foo://bar/parameter-in-multiple-body.yaml',
+      'yaml',
+      0,
+      spec,
+    );
+
+    const languageService: LanguageService = getLanguageService(contextNoSchema);
+
+    const result = await languageService.doValidation(doc, validationContext);
+    const expected: Diagnostic[] = [
+      {
+        code: 3100203,
+        data: {},
+        message: 'Multiple body parameters are not allowed',
+        range: {
+          end: {
+            character: 12,
+            line: 13,
+          },
+          start: {
+            character: 10,
+            line: 13,
+          },
+        },
+        severity: 1,
+        source: 'apilint',
+      },
+      {
+        code: 3100203,
+        data: {},
+        message: 'Multiple body parameters are not allowed',
+        range: {
+          end: {
+            character: 12,
+            line: 16,
+          },
+          start: {
+            character: 10,
+            line: 16,
+          },
+        },
+        severity: 1,
+        source: 'apilint',
+      },
+    ];
+    assert.deepEqual(result, expected as Diagnostic[]);
+
+    languageService.terminate();
+  });
+
   it('oas 3.1 / yaml - parameter object should be defined within path template', async function () {
     const validationContext: ValidationContext = {
       comments: DiagnosticSeverity.Error,