Skip to content
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

Jump to bottom

feat(apidom-ls): path template match parameter object lint #3538

Merged
merged 13 commits into from
Dec 18, 2023
Merged

feat(apidom-ls): path template match parameter object lint #3538

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b681a8b
feat(apidom-ls): path template match parameter object lint
kowalczyk-krzysztof Dec 14, 2023
c272193
feat(apidom-ls): remove unnecessary check
kowalczyk-krzysztof Dec 14, 2023
171fe97
feat(apidom-ls): more semantic implementation
kowalczyk-krzysztof Dec 15, 2023
5dcdf03
feat(apidom-ls): add reference test case
kowalczyk-krzysztof Dec 15, 2023
9d61642
feat(apidom-ls): change implementation and add more fixtures
kowalczyk-krzysztof Dec 15, 2023
169f0d6
feat(apidom-ls): make variable names explicit
kowalczyk-krzysztof Dec 15, 2023
a449218
Merge branch 'main' into path-template-validate
kowalczyk-krzysztof Dec 15, 2023
c65449e
feat(apidom-ls): put pathItemParameterElements outside loop
kowalczyk-krzysztof Dec 15, 2023
88b0455
feat(apidom-ls): bump openapi-path-templating to 1.3.0
kowalczyk-krzysztof Dec 18, 2023
d0d3b11
feat(apidom-ls): reference object handling
kowalczyk-krzysztof Dec 18, 2023
22ae82a
feat(apidom-ls): fix wrong return
kowalczyk-krzysztof Dec 18, 2023
0bac9e2
Merge branch 'main' into path-template-validate
kowalczyk-krzysztof Dec 18, 2023
ee6020a
Update linter-functions.ts
char0n Dec 18, 2023
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
12 changes: 6 additions & 6 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/apidom-ls/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
"@swagger-api/apidom-parser-adapter-yaml-1-2": "^0.88.0",
"@swagger-api/apidom-reference": "^0.88.0",
"@types/ramda": "~0.29.6",
"openapi-path-templating": "^1.2.0",
"openapi-path-templating": "^1.3.0",
"ramda": "~0.29.1",
"ramda-adjunct": "^4.1.1",
"vscode-languageserver-protocol": "^3.17.2",
Expand Down
65 changes: 62 additions & 3 deletions packages/apidom-ls/src/services/validation/linter-functions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ import {
toValue,
ArraySlice,
ObjectElement,
isArrayElement,
} from '@swagger-api/apidom-core';
import { CompletionItem } from 'vscode-languageserver-types';
import { test } from 'openapi-path-templating';
import { test, resolve } from 'openapi-path-templating';

// eslint-disable-next-line import/no-cycle
import {
Expand Down Expand Up @@ -1009,9 +1010,67 @@ export const standardLinterfunctions: FunctionItem[] = [
functionName: 'apilintOpenAPIPathTemplateValid',
function: (element: Element) => {
if (isStringElement(element)) {
return true;
const pathItemElement = (element.parent as MemberElement).value as ObjectElement;

if (pathItemElement.length === 0) {
return true;
}

let oneOfParametersIsReferenceObject = false;
const parameterElements: Element[] = [];
const isParameterElement = (el: Element): boolean => el.element === 'parameter';
const isReferenceElement = (el: Element): boolean => el.element === 'reference';

char0n marked this conversation as resolved.
Show resolved Hide resolved
const pathItemParameterElements = pathItemElement.get('parameters');
if (isArrayElement(pathItemParameterElements)) {
pathItemParameterElements.forEach((parameter) => {
if (isReferenceElement(parameter) && !oneOfParametersIsReferenceObject) {
oneOfParametersIsReferenceObject = true;
}
if (isParameterElement(parameter)) {
parameterElements.push(parameter);
}
});
}

pathItemElement.forEach((el) => {
if (el.element === 'operation') {
const operationParameterElements = (el as ObjectElement).get('parameters');
if (isArrayElement(operationParameterElements)) {
operationParameterElements.forEach((parameter) => {
if (isReferenceElement(parameter) && !oneOfParametersIsReferenceObject) {
oneOfParametersIsReferenceObject = true;
}
if (isParameterElement(parameter)) {
parameterElements.push(parameter);
}
});
}
}
});

const allowedLocation = ['path', 'query'];
const pathTemplateResolveParams: { [key: string]: 'placeholder' } = {};

parameterElements.forEach((parameter) => {
char0n marked this conversation as resolved.
Show resolved Hide resolved
if (allowedLocation.includes(toValue((parameter as ObjectElement).get('in')))) {
pathTemplateResolveParams[toValue((parameter as ObjectElement).get('name'))] =
'placeholder';
}
});

char0n marked this conversation as resolved.
Show resolved Hide resolved
const pathTemplate = toValue(element);
const resolvedPathTemplate = resolve(pathTemplate, pathTemplateResolveParams);

const resolveResult = !test(resolvedPathTemplate, { strict: true });

if (!resolveResult && oneOfParametersIsReferenceObject) {
return true;
}
return resolveResult;
}
return true;

return false;
kowalczyk-krzysztof marked this conversation as resolved.
Show resolved Hide resolved
},
},
];
104 changes: 104 additions & 0 deletions packages/apidom-ls/test/fixtures/validation/oas/path-template-all-defined-2-0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
swagger: '2.0'
info:
title: Foo
version: 0.1.0
parameters:
test_id:
name: test_id
in: path
required: true
schema:
type: string
format: uuid
title: Test Id
paths:
/foo/bar/{baz}/test/{foo_id}/baz/{bar_id}:
delete:
summary: Delete foo bar test baz
operationId: deleteFooBarTestBaz
parameters:
- name: foo_id
in: path
required: true
schema:
type: string
format: uuid
title: Foo Id
- name: bar_id
in: path
required: true
schema:
type: string
format: uuid
title: Bar Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/test/{foo_id}/{bar_id}:
get:
summary: Get test foo bar
operationId: getTestFooBar
parameters:
- name: foo_id
in: path
required: true
schema:
type: string
format: uuid
title: Foo Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/reference/{test_id}/{baz_id}:
get:
summary: Get test baz
operationId: getReferenceTestBaz
parameters:
- $ref: '#/parameters/test_id'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/just_parameters_object/{x_id}/{y_id}:
parameters:
- name: x_id
in: path
required: true
schema:
type: string
format: uuid
title: X Id
/both_parameters_and_operations_object/{a_id}/{b_id}/{c_id}:
get:
summary: Get both parameters and operations object a b c
operationId: getBothParametersAndOperationsObjectABC
parameters:
- name: b_id
in: path
required: true
schema:
type: string
format: uuid
title: B Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
parameters:
- name: a_id
in: path
required: true
schema:
type: string
format: uuid
title: A Id
105 changes: 105 additions & 0 deletions packages/apidom-ls/test/fixtures/validation/oas/path-template-all-defined-3-0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
openapi: 3.0.0
info:
title: Foo
version: 0.1.0
components:
parameters:
test_id:
name: test_id
in: path
required: true
schema:
type: string
format: uuid
title: Test Id
paths:
/foo/bar/{baz}/test/{foo_id}/baz/{bar_id}:
delete:
summary: Delete foo bar test baz
operationId: deleteFooBarTestBaz
parameters:
- name: foo_id
in: path
required: true
schema:
type: string
format: uuid
title: Foo Id
- name: bar_id
in: path
required: true
schema:
type: string
format: uuid
title: Bar Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/test/{foo_id}/{bar_id}:
get:
summary: Get test foo bar
operationId: getTestFooBar
parameters:
- name: foo_id
in: path
required: true
schema:
type: string
format: uuid
title: Foo Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/reference/{test_id}/{baz_id}:
get:
summary: Get test baz
operationId: getReferenceTestBaz
parameters:
- $ref: '#/components/parameters/test_id'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/just_parameters_object/{x_id}/{y_id}:
parameters:
- name: x_id
in: path
required: true
schema:
type: string
format: uuid
title: X Id
/both_parameters_and_operations_object/{a_id}/{b_id}/{c_id}:
get:
summary: Get both parameters and operations object a b c
operationId: getBothParametersAndOperationsObjectABC
parameters:
- name: b_id
in: path
required: true
schema:
type: string
format: uuid
title: B Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
parameters:
- name: a_id
in: path
required: true
schema:
type: string
format: uuid
title: A Id
Loading