Skip to content

Commit 12303d9

Browse files
authored
feat(ls): add rules for OpenAPI 2.0 Parameters Definitions Object (#3660)
Refs #3616
1 parent c53a9bc commit 12303d9

File tree

6 files changed

+49
-0
lines changed

6 files changed

+49
-0
lines changed

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

+3
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,9 @@ enum ApilintCodes {
766766
OPENAPI2_DEFINITIONS = 3140000,
767767
OPENAPI2_DEFINITIONS_VALUES_TYPE = 3140100,
768768

769+
OPENAPI2_PARAMETERS_DEFINITIONS = 3150000,
770+
OPENAPI2_PARAMETERS_DEFINITIONS_VALUES_TYPE = 3150100,
771+
769772
OPENAPI3_0 = 5000000,
770773

771774
OPENAPI3_0_OPENAPI_VALUE_PATTERN_3_0_0 = 5000100,

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

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import oauthFlowMeta from './oauth-flow/meta';
2323
import oauthFlowsMeta from './oauth-flows/meta';
2424
import operationMeta from './operation/meta';
2525
import parameterMeta from './parameter/meta';
26+
import parametersDefinitionsMeta from './parameters-definitions/meta';
2627
import pathItemMeta from './path-item/meta';
2728
import pathsMeta from './paths/meta';
2829
import requestBodyMeta from './request-body/meta';
@@ -76,6 +77,7 @@ export default {
7677
oAuthFlows: oauthFlowsMeta,
7778
operation: operationMeta,
7879
parameter: parameterMeta,
80+
parametersDefinitions: parametersDefinitionsMeta,
7981
pathItem: pathItemMeta,
8082
paths: pathsMeta,
8183
requestBody: requestBodyMeta,
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import { OpenAPI2 } from '../target-specs';
2+
3+
const documentation = [
4+
{
5+
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```',
6+
targetSpecs: OpenAPI2,
7+
},
8+
];
9+
10+
export default documentation;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import valuesTypeLint from './values--type';
2+
3+
const lints = [valuesTypeLint];
4+
5+
export default lints;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { DiagnosticSeverity } from 'vscode-languageserver-types';
2+
3+
import ApilintCodes from '../../../codes';
4+
import { LinterMeta } from '../../../../apidom-language-types';
5+
import { OpenAPI2 } from '../../target-specs';
6+
7+
const valuesTypeLint: LinterMeta = {
8+
code: ApilintCodes.OPENAPI2_PARAMETERS_DEFINITIONS_VALUES_TYPE,
9+
source: 'apilint',
10+
message: 'Parameter Definitions Object values must be of Parameter Object shape',
11+
severity: DiagnosticSeverity.Error,
12+
linterFunction: 'apilintChildrenOfElementsOrClasses',
13+
linterParams: [['parameter']],
14+
marker: 'key',
15+
data: {},
16+
targetSpecs: OpenAPI2,
17+
};
18+
19+
export default valuesTypeLint;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import lint from './lint';
2+
import documentation from './documentation';
3+
import { FormatMeta } from '../../../apidom-language-types';
4+
5+
const meta: FormatMeta = {
6+
lint,
7+
documentation,
8+
};
9+
10+
export default meta;

0 commit comments

Comments
 (0)