Merge pull request #4986 from swagger-api/feat/swg--15850--port-parameters-validation-rules

feat: add parameter validation rules

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,
@@ -740,6 +741,7 @@ enum ApilintCodes {
   OPENAPI2_PARAMETER_FIELD_ENUM_TYPE = 3101800,
   OPENAPI2_PARAMETER_FIELD_MULTIPLE_OF_TYPE = 3101900,
   OPENAPI2_PARAMETER_FIELD_IN_PATH_TEMPLATE = 3102000,
+  OPENAPI2_PARAMETER_FIELD_NAME_UNIQUE = 3103000,
 
   OPENAPI2_ITEMS = 3110000,
   OPENAPI2_ITEMS_FIELD_TYPE_EQUALS = 3110100,
@@ -976,6 +978,8 @@ enum ApilintCodes {
   OPENAPI3_0_PARAMETER_FIELD_IN_TYPE = 5150300,
   OPENAPI3_0_PARAMETER_FIELD_IN_REQUIRED,
   OPENAPI3_0_PARAMETER_FIELD_IN_EQUALS,
+  OPENAPI3_0_PARAMETER_FIELD_IN_AUTHORIZATION,
+  OPENAPI3_0_PARAMETER_FIELD_IN_CONTENT_TYPE,
   OPENAPI3_0_PARAMETER_FIELD_DESCRIPTION_TYPE = 5150400,
   OPENAPI3_0_PARAMETER_FIELD_REQUIRED_TYPE = 5150500,
   OPENAPI3_0_PARAMETER_FIELD_REQUIRED_REQUIRED,

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

@@ -0,0 +1,31 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import { OpenAPI3 } from '../../target-specs.ts';
+import ApilintCodes from '../../../codes.ts';
+
+const inAcceptLint = {
+  code: ApilintCodes.OPENAPI3_0_PARAMETER_FIELD_IN_CONTENT_TYPE,
+  source: 'apilint',
+  message:
+    'Header Parameter named "Accept" is ignored. The values for the "Accept" header are defined by `requestBody.content.<media-type>`',
+  severity: DiagnosticSeverity.Warning,
+  linterParams: ['^(?!\\b(A|a)ccept\\b).*$'],
+  linterFunction: 'apilintValueRegex',
+  marker: 'value',
+  target: 'name',
+  data: {},
+  conditions: [
+    {
+      targets: [
+        {
+          path: 'in',
+        },
+      ],
+      function: 'apilintContainsValue',
+      params: ['header'],
+    },
+  ],
+  targetSpecs: OpenAPI3,
+};
+
+export default inAcceptLint;

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

@@ -0,0 +1,31 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import { OpenAPI3 } from '../../target-specs.ts';
+import ApilintCodes from '../../../codes.ts';
+
+const inAuthorizationLint = {
+  code: ApilintCodes.OPENAPI3_0_PARAMETER_FIELD_IN_AUTHORIZATION,
+  source: 'apilint',
+  message:
+    'Header Parameter named "Authorization" is ignored. Use the "securitySchemes" and "security" sections instead to define authorization',
+  severity: DiagnosticSeverity.Warning,
+  linterParams: ['^(?!\\b(A|a)uthorization\\b).*$'],
+  linterFunction: 'apilintValueRegex',
+  marker: 'value',
+  target: 'name',
+  data: {},
+  conditions: [
+    {
+      targets: [
+        {
+          path: 'in',
+        },
+      ],
+      function: 'apilintContainsValue',
+      params: ['header'],
+    },
+  ],
+  targetSpecs: OpenAPI3,
+};
+
+export default inAuthorizationLint;

packages/apidom-ls/src/config/openapi/parameter/lint/in--content-type.ts

@@ -0,0 +1,31 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import { OpenAPI3 } from '../../target-specs.ts';
+import ApilintCodes from '../../../codes.ts';
+
+const inContentTypeLint = {
+  code: ApilintCodes.OPENAPI3_0_PARAMETER_FIELD_IN_CONTENT_TYPE,
+  source: 'apilint',
+  message:
+    'Header Parameter named "Content-Type" is ignored. The values for the "Content-Type" header are defined by `requestBody.content.<media-type>`',
+  severity: DiagnosticSeverity.Warning,
+  linterParams: ['^(?!\\b(C|c)ontent-(T|t)ype\\b).*$'],
+  linterFunction: 'apilintValueRegex',
+  marker: 'value',
+  target: 'name',
+  data: {},
+  conditions: [
+    {
+      targets: [
+        {
+          path: 'in',
+        },
+      ],
+      function: 'apilintContainsValue',
+      params: ['header'],
+    },
+  ],
+  targetSpecs: OpenAPI3,
+};
+
+export default inContentTypeLint;

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

@@ -42,12 +42,18 @@ import uniqueItemsTypeLint from './unique-items--type.ts';
 import enumTypeLint from './enum--type.ts';
 import multipleOfTypeLint from './multiple-of--type.ts';
 import inPathTemplateLint from './in-path-template.ts';
+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,
   nameRequiredLint,
   inEquals2_0Lint,
   inEquals3_0__3_1Lint,
+  inAuthorizationLint,
   inRequiredLint,
   inValidLint,
   descriptionTypeLint,
@@ -81,13 +87,17 @@ const lints = [
   maxLengthTypeLint,
   minLengthTypeLint,
   uniqueItemsTypeLint,
+  uniqueNameLint,
   enumTypeLint,
   multipleOfTypeLint,
   requiredFields3_0__3_1Lint,
   allowedFields2_0Lint,
   allowedFields3_0Lint,
   allowedFields3_1Lint,
   inPathTemplateLint,
+  inContentTypeLint,
+  inAcceptLint,
+  inMultipleBody,
 ];
 
 export default lints;

packages/apidom-ls/src/config/openapi/parameter/lint/unique-name.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, OpenAPI3 } from '../../target-specs.ts';
+
+const parametersTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_PARAMETER_FIELD_NAME_UNIQUE,
+  source: 'apilint',
+  message: 'Name must be unique among all parameters',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintPropertyUniqueSiblingValue',
+  linterParams: ['parameters', 'name'],
+  marker: 'key',
+  markerTarget: 'name',
+  target: 'name',
+  data: {},
+  targetSpecs: [...OpenAPI2, ...OpenAPI3],
+};
+
+export default parametersTypeLint;

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

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

packages/apidom-ls/test/fixtures/validation/oas/parameter-in-accept-3-0.yaml

@@ -0,0 +1,15 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: 'test'
+paths:
+  /:
+    get:
+      responses:
+        default:
+          description: 'test'
+      parameters:
+        - in: header
+          name: accept
+          content:
+            application/xml: {}

packages/apidom-ls/test/fixtures/validation/oas/parameter-in-authorization-3-0.yaml

@@ -0,0 +1,15 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: 'test'
+paths:
+  /:
+    get:
+      responses:
+        default:
+          description: 'test'
+      parameters:
+        - in: header
+          name: Authorization
+          content:
+            application/xml: {}