feat(ls): add rules for OpenAPI 2.0 Parameters Definitions Object (#3660

)

Refs #3616

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

@@ -766,6 +766,9 @@ enum ApilintCodes {
   OPENAPI2_DEFINITIONS = 3140000,
   OPENAPI2_DEFINITIONS_VALUES_TYPE = 3140100,
 
+  OPENAPI2_PARAMETERS_DEFINITIONS = 3150000,
+  OPENAPI2_PARAMETERS_DEFINITIONS_VALUES_TYPE = 3150100,
+
   OPENAPI3_0 = 5000000,
 
   OPENAPI3_0_OPENAPI_VALUE_PATTERN_3_0_0 = 5000100,

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

@@ -23,6 +23,7 @@ import oauthFlowMeta from './oauth-flow/meta';
 import oauthFlowsMeta from './oauth-flows/meta';
 import operationMeta from './operation/meta';
 import parameterMeta from './parameter/meta';
+import parametersDefinitionsMeta from './parameters-definitions/meta';
 import pathItemMeta from './path-item/meta';
 import pathsMeta from './paths/meta';
 import requestBodyMeta from './request-body/meta';
@@ -76,6 +77,7 @@ export default {
   oAuthFlows: oauthFlowsMeta,
   operation: operationMeta,
   parameter: parameterMeta,
+  parametersDefinitions: parametersDefinitionsMeta,
   pathItem: pathItemMeta,
   paths: pathsMeta,
   requestBody: requestBodyMeta,

packages/apidom-ls/src/config/openapi/parameters-definitions/documentation.ts

@@ -0,0 +1,10 @@
+import { OpenAPI2 } from '../target-specs';
+
+const documentation = [
+  {
+    docs: '#### [Parameters Definitions Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#parameters-definitions-object)\n\nAn object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here.\n\nThis does *not* define global operation parameters.\n\n##### Patterned Fields\n\nField Pattern | Type | Description\n---|:---:|---\n{name} | [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#parameterObject) | A single parameter definition, mapping a "name" to the parameter it defines.\n\n##### Parameters Definition Object Example\n\n```js\n{\n  "skipParam": {\n    "name": "skip",\n    "in": "query",\n    "description": "number of items to skip",\n    "required": true,\n    "type": "integer",\n    "format": "int32"\n  },\n  "limitParam": {\n    "name": "limit",\n    "in": "query",\n    "description": "max records to return",\n    "required": true,\n    "type": "integer",\n    "format": "int32"\n  }\n}\n```\n\n\n\\\nYAML\n```yaml\nskipParam:\n  name: skip\n  in: query\n  description: number of items to skip\n  required: true\n  type: integer\n  format: int32\nlimitParam:\n  name: limit\n  in: query\n  description: max records to return\n  required: true\n  type: integer\n  format: int32\n```',
+    targetSpecs: OpenAPI2,
+  },
+];
+
+export default documentation;

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

@@ -0,0 +1,5 @@
+import valuesTypeLint from './values--type';
+
+const lints = [valuesTypeLint];
+
+export default lints;

packages/apidom-ls/src/config/openapi/parameters-definitions/lint/values--type.ts

@@ -0,0 +1,19 @@
+import { DiagnosticSeverity } from 'vscode-languageserver-types';
+
+import ApilintCodes from '../../../codes';
+import { LinterMeta } from '../../../../apidom-language-types';
+import { OpenAPI2 } from '../../target-specs';
+
+const valuesTypeLint: LinterMeta = {
+  code: ApilintCodes.OPENAPI2_PARAMETERS_DEFINITIONS_VALUES_TYPE,
+  source: 'apilint',
+  message: 'Parameter Definitions Object values must be of Parameter Object shape',
+  severity: DiagnosticSeverity.Error,
+  linterFunction: 'apilintChildrenOfElementsOrClasses',
+  linterParams: [['parameter']],
+  marker: 'key',
+  data: {},
+  targetSpecs: OpenAPI2,
+};
+
+export default valuesTypeLint;

packages/apidom-ls/src/config/openapi/parameters-definitions/meta.ts

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