feat: add reference requestbodies rule

Author: robert-hebel-sb

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

@@ -1071,6 +1071,7 @@ enum ApilintCodes {
   OPENAPI3_0_REFERENCE = 5260000,
   OPENAPI3_0_REFERENCE_FIELD_$REF_FORMAT_URI = 5260100,
   OPENAPI3_0_REFERENCE_FIELD_$REF_NO_SIBLINGS,
+  OPENAPI3_0_REFERENCE_FIELD_$REF_REQUEST_BODIES = 5260200,
 
   OPENAPI3_0_LINK = 5270000,
   OPENAPI3_0_LINK_FIELD_OPERATION_REF_FORMAT_URI = 5270100,

packages/apidom-ls/src/config/openapi/reference/lint/$ref-3-0--request-bodies.ts

@@ -0,0 +1,21 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes.ts';
+import { LinterMeta } from '../../../../apidom-language-types.ts';
+import { OpenAPI3 } from '../../target-specs.ts';
+
+const $ref3RequestBodiesLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_REFERENCE_FIELD_$REF_REQUEST_BODIES,
+  source: 'apilint',
+  message:
+    'requestBody schema $refs must point to a position where a Schema Object can be legally placed',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'parentExistFields',
+  linterParams: [['requestBody']],
+  marker: 'value',
+  target: '$ref',
+  data: {},
+  targetSpecs: OpenAPI3,
+};
+
+export default $ref3RequestBodiesLint;

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

@@ -3,11 +3,13 @@ import $ref2_0__3_0NoSiblingsLint from './$ref-2-0--3-0--no-siblings.ts';
 import $ref3_1AllowedSiblingsLint from './$ref-3-1--allowed-siblings.ts';
 import description3_1TypeLint from './description-3-1--type.ts';
 import summary3_1TypeLint from './summary-3-1--type.ts';
+import $ref3RequestBodiesLint from './$ref-3-0--request-bodies.ts';
 
 const lints = [
   $refFormatURILint,
   $ref2_0__3_0NoSiblingsLint,
   $ref3_1AllowedSiblingsLint,
+  $ref3RequestBodiesLint,
   description3_1TypeLint,
   summary3_1TypeLint,
 ];

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

@@ -176,6 +176,20 @@ export const standardLinterfunctions: FunctionItem[] = [
       return true;
     },
   },
+  {
+    functionName: 'parentExistFields',
+    function: (element: Element, keys: string[]): boolean => {
+      const parent = element?.parent?.parent?.parent?.parent;
+      if (parent && isObject(parent)) {
+        for (const key of keys) {
+          if (!parent.hasKey(key)) {
+            return false;
+          }
+        }
+      }
+      return true;
+    },
+  },
   {
     functionName: 'existAnyOfFields',
     function: (element: Element, keys: string[], allowEmpty: boolean): boolean => {
@@ -421,6 +435,24 @@ export const standardLinterfunctions: FunctionItem[] = [
       return true;
     },
   },
+  {
+    functionName: 'apilintParentHasKey',
+    function: (element: Element, elementsOrClasses: string[]): boolean => {
+      if (element && !isObject(element)) {
+        return false;
+      }
+      if (element && isObject(element)) {
+        if (
+          element.findElements((e) => !apilintElementOrClass(e, elementsOrClasses), {
+            recursive: false,
+          }).length > 0
+        ) {
+          return false;
+        }
+      }
+      return true;
+    },
+  },
   {
     functionName: 'apilintArray',
     function: (element: Element): boolean => {

packages/apidom-ls/test/fixtures/validation/oas/ref-request-bodies.yaml

@@ -0,0 +1,23 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: 'test'
+paths:
+  /:
+    post:
+      responses:
+        default:
+          description: 'test'
+      operationId: myId
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/requestBodies/MyBody/content/application~1json/schema'
+components:
+  requestBodies:
+    MyBody:
+      content:
+        application/json:
+          schema:
+            type: string

packages/apidom-ls/test/validate.ts

@@ -3032,6 +3032,45 @@ describe('apidom-ls-validate', function () {
     languageService.terminate();
   });
 
+  it('oas 3.0 / yaml - requestBody $refs must point to a position where can be legally placed', async function () {
+    const validationContext: ValidationContext = {
+      comments: DiagnosticSeverity.Error,
+      maxNumberOfProblems: 100,
+      relatedInformation: false,
+    };
+
+    const spec = fs
+      .readFileSync(
+        path.join(__dirname, 'fixtures', 'validation', 'oas', 'ref-request-bodies.yaml'),
+      )
+      .toString();
+    const doc: TextDocument = TextDocument.create(
+      'foo://bar/ref-request-bodies.yaml',
+      'yaml',
+      0,
+      spec,
+    );
+
+    const languageService: LanguageService = getLanguageService(contextNoSchema);
+
+    const result = await languageService.doValidation(doc, validationContext);
+    result[0].code = 'test';
+    const expected: Diagnostic[] = [
+      {
+        range: { start: { line: 15, character: 20 }, end: { line: 15, character: 88 } },
+        message:
+          'requestBody schema $refs must point to a position where a Schema Object can be legally placed',
+        severity: 1,
+        code: 'test',
+        source: 'apilint',
+        data: {},
+      },
+    ];
+    assert.deepEqual(result, expected as Diagnostic[]);
+
+    languageService.terminate();
+  });
+
   it('oas / yaml - test editor issue 3626 / inidrect ref', async function () {
     const validationContext: ValidationContext = {
       comments: DiagnosticSeverity.Error,