feat(ls): add validation rules for formData (#4998)

Author: robert-hebel-sb

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

@@ -710,6 +710,8 @@ enum ApilintCodes {
   OPENAPI2_OPERATION_FIELD_CONSUMES_TYPE = 3080600,
   OPENAPI2_OPERATION_FIELD_PRODUCES_TYPE = 3080700,
   OPENAPI2_OPERATION_FIELD_PARAMETERS_TYPE = 3080800,
+  OPENAPI2_OPERATION_FIELD_PARAMETERS_TYPE_CONSUMES_REQUIRED,
+  OPENAPI2_OPERATION_FIELD_PARAMETERS_IN_CONSUMES_REQUIRED,
   OPENAPI2_OPERATION_FIELD_PARAMETERS_ITEMS_TYPE = 3080900,
   OPENAPI2_OPERATION_FIELD_RESPONSES_TYPE = 3081000,
   OPENAPI2_OPERATION_FIELD_RESPONSES_REQUIRED,
@@ -730,6 +732,7 @@ enum ApilintCodes {
   OPENAPI2_PARAMETER_FIELD_IN_REQUIRED,
   OPENAPI2_PARAMETER_FIELD_IN_VALID,
   OPENAPI2_PARAMETER_FIELD_IN_MULTIPLE_BODY,
+  OPENAPI2_PARAMETER_FIELD_IN_OVERLAPS,
   OPENAPI2_PARAMETER_FIELD_DESCRIPTION_TYPE = 3100300,
   OPENAPI2_PARAMETER_FIELD_REQUIRED_TYPE = 3100400,
   OPENAPI2_PARAMETER_FIELD_REQUIRED_REQUIRED,

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

@@ -10,6 +10,9 @@ import consumesTypeLint from './consumes--type.ts';
 import producesTypeLint from './produces--type.ts';
 import parametersTypeLint from './parameters--type.ts';
 import parametersItemsTypeLint from './parameters--items-type.ts';
+import parametersTypeConsumesRequiredLint from './parameters-type-consumes--required.ts';
+import parametersInConsumesRequiredLint from './parameters-in-consumes--required.ts';
+import parametersInOverlapsLint from './parameters-in--overlaps.ts';
 import requestBodyTypeLint from './request-body--type.ts';
 import responsesTypeLint from './responses--type.ts';
 import responsesRequired2_0__3_0Lint from './responses-2-0--3-0--required.ts';
@@ -34,6 +37,9 @@ const lints = [
   producesTypeLint,
   parametersTypeLint,
   parametersItemsTypeLint,
+  parametersTypeConsumesRequiredLint,
+  parametersInConsumesRequiredLint,
+  parametersInOverlapsLint,
   requestBodyTypeLint,
   responsesTypeLint,
   responsesRequired2_0__3_0Lint,

packages/apidom-ls/src/config/openapi/operation/lint/parameters-in--overlaps.ts

@@ -0,0 +1,21 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2 } from '../../target-specs.ts';
+
+const inOverlapsLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_PARAMETER_FIELD_IN_OVERLAPS,
+  source: 'apilint',
+  message:
+    'Parameters cannot have both a "in: body" and "in: formData", as "formData" _will_ be the body',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintParametersInOverlaps',
+  marker: 'key',
+  markerTarget: 'parameters',
+  target: 'parameters',
+  data: {},
+  targetSpecs: OpenAPI2,
+};
+
+export default inOverlapsLint;

packages/apidom-ls/src/config/openapi/operation/lint/parameters-in-consumes--required.ts

@@ -0,0 +1,27 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2 } from '../../target-specs.ts';
+
+const parametersInConsumesRequiredLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_OPERATION_FIELD_PARAMETERS_IN_CONSUMES_REQUIRED,
+  source: 'apilint',
+  message:
+    'Operations with Parameter of "in: formData" must include "application/x-www-form-urlencoded" or "multipart/form-data" in their "consumes" property',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintFieldValueOrArray',
+  linterParams: ['consumes', ['multipart/form-data', 'application/x-www-form-urlencoded']],
+  marker: 'key',
+  conditions: [
+    {
+      targets: [{ path: 'parameters' }],
+      function: 'apilintHasParameterKeyValue',
+      params: ['in', 'formData'],
+    },
+  ],
+  data: {},
+  targetSpecs: OpenAPI2,
+};
+
+export default parametersInConsumesRequiredLint;

packages/apidom-ls/src/config/openapi/operation/lint/parameters-type-consumes--required.ts

@@ -0,0 +1,27 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI2 } from '../../target-specs.ts';
+
+const parametersTypeConsumesRequiredLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_OPERATION_FIELD_PARAMETERS_TYPE_CONSUMES_REQUIRED,
+  source: 'apilint',
+  message:
+    'Operations with Parameter of "type: file" must include "application/x-www-form-urlencoded" or "multipart/form-data" in their "consumes" property',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintFieldValueOrArray',
+  linterParams: ['consumes', ['multipart/form-data', 'application/x-www-form-urlencoded']],
+  marker: 'key',
+  conditions: [
+    {
+      targets: [{ path: 'parameters' }],
+      function: 'apilintHasParameterKeyValue',
+      params: ['type', 'file'],
+    },
+  ],
+  data: {},
+  targetSpecs: OpenAPI2,
+};
+
+export default parametersTypeConsumesRequiredLint;

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

@@ -406,17 +406,61 @@ export const standardLinterfunctions: FunctionItem[] = [
   {
     functionName: 'apilintFieldValueOrArray',
     function: (element: Element, key: string, values: string[]): boolean => {
+      const api = root(element) as ObjectElement;
+
       if (element && isObject(element)) {
-        if (element.get(key)) {
-          const elValue = toValue(element.get(key));
-          const isArrayVal = Array.isArray(elValue);
-          if (!isArrayVal && !values.includes(elValue)) {
+        if (!element.get(key) && !api.get(key)) {
+          return false;
+        }
+        const keyToCheck = element.get(key) ?? api.get(key);
+        const elValue = toValue(keyToCheck);
+        const isArrayVal = Array.isArray(elValue);
+        if (!isArrayVal && !values.includes(elValue)) {
+          return false;
+        }
+        if (isArrayVal && !elValue.every((v) => values.includes(v))) {
+          return false;
+        }
+      }
+      return true;
+    },
+  },
+  {
+    functionName: 'apilintHasParameterKeyValue',
+    function: (element: Element, key: string, value: string): boolean => {
+      if (element && isArrayElement(element)) {
+        return (
+          element.findElements((el: Element) => {
+            if (isObject(el)) {
+              return toValue(el.get(key)) === value;
+            }
             return false;
-          }
-          if (isArrayVal && !elValue.every((v) => values.includes(v))) {
+          }, {}).length > 0
+        );
+      }
+      return false;
+    },
+  },
+  {
+    functionName: 'apilintParametersInOverlaps',
+    function: (element: Element): boolean => {
+      if (element && isArrayElement(element)) {
+        const hasBodyValue =
+          element.findElements((el: Element) => {
+            if (isObject(el)) {
+              return toValue(el.get('in')) === 'body';
+            }
             return false;
-          }
-        }
+          }, {}).length > 0;
+        const hasFormDataValue =
+          element.findElements((el: Element) => {
+            if (isObject(el)) {
+              return toValue(el.get('in')) === 'formData';
+            }
+            return false;
+          }, {}).length > 0;
+
+        return !(hasBodyValue && hasFormDataValue);
       }
       return true;
     },

packages/apidom-ls/test/fixtures/validation/oas/operation-in-consumes-required.yaml

@@ -0,0 +1,15 @@
+swagger: "2.0"
+info:
+  version: 1.0.0
+  title: 'test'
+paths:
+  /pets:
+    get:
+      responses:
+        default:
+          description: string
+      parameters:
+        - name: pathLevel
+          type: string
+          in: formData
+          description: tags to filter by

packages/apidom-ls/test/fixtures/validation/oas/operation-in-consumes-value.yaml

@@ -0,0 +1,17 @@
+swagger: "2.0"
+info:
+  version: 1.0.0
+  title: 'test'
+paths:
+  /pets:
+    get:
+      consumes:
+        - application/file
+      responses:
+        default:
+          description: string
+      parameters:
+        - name: pathLevel
+          type: string
+          in: formData
+          description: tags to filter by

packages/apidom-ls/test/fixtures/validation/oas/operation-type-consumes-global-value.yaml

@@ -0,0 +1,17 @@
+swagger: "2.0"
+info:
+  version: 1.0.0
+  title: 'test'
+consumes:
+  - application/x-www-form-urlencoded
+paths:
+  /pets:
+    get:
+      responses:
+        default:
+          description: string
+      parameters:
+        - name: pathLevel
+          type: file
+          in: formData
+          description: tags to filter by

packages/apidom-ls/test/fixtures/validation/oas/operation-type-consumes-override-value.yaml

@@ -0,0 +1,19 @@
+swagger: "2.0"
+info:
+  version: 1.0.0
+  title: 'test'
+consumes:
+  - application/json
+paths:
+  /pets:
+    get:
+      consumes:
+        - application/x-www-form-urlencoded
+      responses:
+        default:
+          description: string
+      parameters:
+        - name: pathLevel
+          type: file
+          in: formData
+          description: tags to filter by