feat: migrate parameter named "content-type" is ignored rule

Author: robert-hebel-sb

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

@@ -978,6 +978,7 @@ enum ApilintCodes {
   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--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 inAuthorizationLint = {
+  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 inAuthorizationLint;

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

@@ -44,6 +44,7 @@ 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';
 
 const lints = [
   nameTypeLint,
@@ -92,6 +93,7 @@ const lints = [
   allowedFields3_0Lint,
   allowedFields3_1Lint,
   inPathTemplateLint,
+  inContentTypeLint,
 ];
 
 export default lints;

packages/apidom-ls/test/fixtures/validation/oas/parameter-in-content-type-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: content-type
+          content:
+            application/xml: {}

packages/apidom-ls/test/validate.ts

@@ -3767,6 +3767,53 @@ describe('apidom-ls-validate', function () {
     languageService.terminate();
   });
 
+  it('oas 3.0 / yaml - parameter content-type is ignored', async function () {
+    const validationContext: ValidationContext = {
+      comments: DiagnosticSeverity.Error,
+      maxNumberOfProblems: 100,
+      relatedInformation: false,
+    };
+
+    const spec = fs
+      .readFileSync(
+        path.join(__dirname, 'fixtures', 'validation', 'oas', 'parameter-in-content-type-3-0.yaml'),
+      )
+      .toString();
+    const doc: TextDocument = TextDocument.create(
+      'foo://bar/parameter-in-authorization-3-0.yaml',
+      'yaml',
+      0,
+      spec,
+    );
+
+    const languageService: LanguageService = getLanguageService(contextNoSchema);
+
+    const result = await languageService.doValidation(doc, validationContext);
+    const expected: Diagnostic[] = [
+      {
+        code: 5150304,
+        data: {},
+        message:
+          'Header Parameter named "Content-Type" is ignored. The values for the "Content-Type" header are defined by `requestBody.content.<media-type>`',
+        range: {
+          end: {
+            character: 28,
+            line: 12,
+          },
+          start: {
+            character: 16,
+            line: 12,
+          },
+        },
+        severity: 2,
+        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,