LukeParke/prettier-plugin-openapi
1
0
Fork 0
mirror of https://github.com/LukeHagar/prettier-plugin-openapi.git synced 2025-12-09 12:47:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhance OpenAPI file validation to reject generic content in component directories and update related tests for improved accuracy

Browse Source
This commit is contained in:
Luke Hagar
2025-11-10 17:25:28 +00:00
parent d972391e31
commit 8979826501
4 changed files with 176 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
test/coverage.test.ts
View File

@@ -1265,6 +1265,40 @@ type: string`;
expect(result?.isOpenAPI).toBeFalse();
});
it('should reject generic content in component directories (security check)', () => {
const parser = parsers?.['openapi-parser'];
expect(parser).toBeDefined();
// Generic JSON/YAML that should NOT be accepted even in component directories
const genericContent = `firstName: John
lastName: Doe
email: john@example.com
age: 30`;
// Test various component directory paths
const componentPaths = [
'components/schemas/User.yaml',
'components/parameters/UserId.yaml',
'components/responses/UserResponse.yaml',
'components/requestBodies/UserCreate.yaml',
'components/headers/RateLimit.yaml',
'components/examples/UserExample.yaml',
'components/securitySchemes/BearerAuth.yaml',
'components/links/UserLink.yaml',
'components/callbacks/NewMessageCallback.yaml',
'webhooks/messageCreated.yaml',
'paths/users.yaml',
];
componentPaths.forEach((path) => {
// @ts-expect-error We are testing edge cases
const result = parser?.parse(genericContent, { filepath: path });
expect(result).toBeDefined();
// Should be rejected even though path matches component directory pattern
expect(result?.isOpenAPI).toBeFalse();
});
});
it('should handle response code sorting with mixed numeric and non-numeric codes', () => {
const printer = printers?.['openapi-ast'];
expect(printer).toBeDefined();