feat(ls): provide OpenAPI 3.0.x Link lint rules

Refs #2033

Author: char0n

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

@@ -787,6 +787,12 @@ enum ApilintCodes {
   OPENAPI3_0_REFERENCE_FIELD_$REF_FORMAT_URI = 5260100,
   OPENAPI3_0_REFERENCE_FIELD_$REF_NO_SIBLINGS,
 
+  OPENAPI3_0_LINK = 5270000,
+  OPENAPI3_0_LINK_FIELD_OPERATION_REF_FORMAT_URI = 5270100,
+  OPENAPI3_0_LINK_FIELD_OPERATION_ID_TYPE = 5270200,
+  OPENAPI3_0_LINK_FIELD_DESCRIPTION_TYPE = 5270300,
+  OPENAPI3_0_LINK_FIELD_SERVER_TYPE = 5270400,
+
   OPENAPI3_1 = 7000000,
 
   OPENAPI3_1_OPENAPI_VALUE_PATTERN_3_1_0 = 7000100,

packages/apidom-ls/src/config/openapi/link/lint/allowed-fields-3-0.ts

@@ -0,0 +1,23 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const allowedFields3_0Lint: LinterMeta = {
+  code: ApilintCodes.NOT_ALLOWED_FIELDS,
+  source: 'apilint',
+  message: 'Object includes not allowed fields',
+  severity: 1,
+  linterFunction: 'allowedFields',
+  linterParams: [
+    ['operationRef', 'operationId', 'parameters', 'requestBody', 'description', 'server', '$ref'],
+    'x-',
+  ],
+  marker: 'key',
+  targetSpecs: [
+    { namespace: 'openapi', version: '3.0.0' },
+    { namespace: 'openapi', version: '3.0.1' },
+    { namespace: 'openapi', version: '3.0.2' },
+    { namespace: 'openapi', version: '3.0.3' },
+  ],
+};
+export default allowedFields3_0Lint;

packages/apidom-ls/src/config/openapi/link/lint/description--type.ts

@@ -0,0 +1,16 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const descriptionTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_LINK_FIELD_DESCRIPTION_TYPE,
+  source: 'apilint',
+  message: 'description must be a string',
+  severity: 1,
+  linterFunction: 'apilintType',
+  linterParams: ['string'],
+  marker: 'value',
+  target: 'description',
+  data: {},
+};
+
+export default descriptionTypeLint;

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

@@ -0,0 +1,15 @@
+import allowedFields3_0Lint from './allowed-fields-3-0';
+import operationRefFormatUriLink from './operation-ref--format-uri';
+import operationIdTypeLint from './operation-id--type';
+import descriptionTypeLint from './description--type';
+import serverTypeLint from './server--type';
+
+const links = [
+  operationRefFormatUriLink,
+  operationIdTypeLint,
+  descriptionTypeLint,
+  serverTypeLint,
+  allowedFields3_0Lint,
+];
+
+export default links;

packages/apidom-ls/src/config/openapi/link/lint/operation-id--type.ts

@@ -0,0 +1,16 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const operationIdTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_LINK_FIELD_OPERATION_ID_TYPE,
+  source: 'apilint',
+  message: "operationId' value must be a string",
+  severity: 1,
+  linterFunction: 'apilintType',
+  linterParams: ['string'],
+  marker: 'value',
+  target: 'operationId',
+  data: {},
+};
+
+export default operationIdTypeLint;

packages/apidom-ls/src/config/openapi/link/lint/operation-ref--format-uri.ts

@@ -0,0 +1,15 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const operationRefFormatURILint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_LINK_FIELD_OPERATION_REF_FORMAT_URI,
+  source: 'apilint',
+  message: "'operationRef' value must be a valid URI-reference",
+  severity: 1,
+  linterFunction: 'apilintValidURI',
+  marker: 'value',
+  target: 'operationRef',
+  data: {},
+};
+
+export default operationRefFormatURILint;

packages/apidom-ls/src/config/openapi/link/lint/server--type.ts

@@ -0,0 +1,16 @@
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+
+const serverTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI3_0_LINK_FIELD_SERVER_TYPE,
+  source: 'apilint',
+  message: 'server must be an object',
+  severity: 1,
+  linterFunction: 'apilintElementOrClass',
+  linterParams: ['server'],
+  marker: 'value',
+  target: 'server',
+  data: {},
+};
+
+export default serverTypeLint;

packages/apidom-ls/src/config/openapi/link/meta.ts

@@ -1,8 +1,10 @@
+import lint from './lint';
 import completion from './completion';
 import documentation from './documentation';
 import { FormatMeta } from '../../../apidom-language-types';
 
 const meta: FormatMeta = {
+  lint,
   completion,
   documentation,
 };

packages/apidom-ls/src/config/openapi/security-scheme/lint/scheme--required.ts

@@ -2,7 +2,7 @@ import ApilintCodes from '../../../codes';
 import { LinterMeta } from '../../../../apidom-language-types';
 
 const schemeRequiredLint: LinterMeta = {
-  code: ApilintCodes.OPENAPI3_SECURITY_SCHEME_FIELD_SCHEME_REQUIRED,
+  code: ApilintCodes.OPENAPI3_0_SECURITY_SCHEME_FIELD_SCHEME_REQUIRED,
   source: 'apilint',
   message: "should always have a 'scheme'",
   severity: 1,