Skip to content

fix(ls): provide OpenAPI 3.1 Request Body allowed fields lint rule #2216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2022
Merged

fix(ls): provide OpenAPI 3.1 Request Body allowed fields lint rule #2216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42a1177
fix(ls): provide OpenAPI 3.1 Request Body allowed fields lint rule
char0n Oct 28, 2022
752f9a8
Merge branch 'main' into char0n/openapi-ls-request-body-allowed-fields
char0n Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions packages/apidom-ls/src/config/openapi/request-body/lint/allowed-fields-3-1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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: [['description', 'content', 'required'], 'x-'],
marker: 'key',
conditions: [
{
function: 'missingField',
params: ['$ref'],
},
],
targetSpecs: [{ namespace: 'openapi', version: '3.1.0' }],
};

export default allowedFields3_0Lint;
2 changes: 2 additions & 0 deletions packages/apidom-ls/src/config/openapi/request-body/lint/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import allowedFields3_0Lint from './allowed-fields-3-0';
import allowedFields3_1Lint from './allowed-fields-3-1';
import descriptionTypeLint from './description--type';
import contentValuesTypeLint from './content--values-type';
import contentRequiredLint from './content--required';
Expand All @@ -10,6 +11,7 @@ const lints = [
contentValuesTypeLint,
requiredTypeLint,
allowedFields3_0Lint,
allowedFields3_1Lint,
];

export default lints;