feat(ls): migrate disallowing equivalent paths in OAS2 #4987
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR migrates a linting rule to detect and disallow equivalent paths in OpenAPI 2.0 specifications. The rule identifies when paths with different parameter names but the same structure (e.g., /items/{id} and /items/{itemId}) are defined, which violates OpenAPI 2.0 specification requirements.
- Added a new linter function
apilintNoEquivalentPathsthat normalizes path templates to detect equivalency - Created a new lint rule configuration for OpenAPI 2.0 path templates
- Added comprehensive test coverage with a test fixture demonstrating the violation
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
packages/apidom-ls/src/services/validation/linter-functions.ts |
Implements the core logic for detecting equivalent paths by normalizing path templates |
packages/apidom-ls/src/config/openapi/path-template/lint/equivalent-paths-not-allowed.ts |
Defines the lint rule configuration with error code, message, and target specifications |
packages/apidom-ls/src/config/openapi/path-template/lint/index.ts |
Registers the new lint rule in the path template linting system |
packages/apidom-ls/src/config/codes.ts |
Adds the new error code for equivalent paths validation |
packages/apidom-ls/test/validate.ts |
Adds test case verifying the linting rule works correctly |
packages/apidom-ls/test/fixtures/validation/oas/equivalent-paths-not-allowed.yaml |
Test fixture with equivalent paths to trigger the validation error |
lukaszzazulak
changed the title
lukaszzazulak
force-pushed
the
feat/SWG-15851-Port-validation-rules-for-Path-element
branch
from
74529ca to
66e4118
Compare
packages/apidom-ls/src/config/openapi/path-template/lint/value--equivalent-not-allowed.ts
Outdated
Show resolved
Hide resolved
packages/apidom-ls/src/config/openapi/path-template/lint/value--equivalent-not-allowed.ts
Outdated
Show resolved
Hide resolved
lukaszzazulak
force-pushed
the
feat/SWG-15851-Port-validation-rules-for-Path-element
branch
from
81e0693 to
2d74ad3
Compare
Co-authored-by: robert-hebel-sb <[email protected]>
lukaszzazulak
force-pushed
the
feat/SWG-15851-Port-validation-rules-for-Path-element
branch
from
2d74ad3 to
e7b9a6d
Compare
robert-hebel-sb
approved these changes
Aug 12, 2025
robert-hebel-sb
approved these changes
Aug 14, 2025
glowcloud
approved these changes
Aug 19, 2025
…h-element # Conflicts: # packages/apidom-ls/test/validate.ts
cka121
approved these changes
Aug 26, 2025
glowcloud
reviewed
Aug 26, 2025
glowcloud
reviewed
Aug 28, 2025
glowcloud
approved these changes
Aug 28, 2025
glowcloud
approved these changes
Aug 28, 2025
…h-element # Conflicts: # packages/apidom-ls/src/services/validation/linter-functions.ts # packages/apidom-ls/test/validate.ts
lukaszzazulak
deleted the
feat/SWG-15851-Port-validation-rules-for-Path-element
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Migrate linting rule for disallowing equivalent paths in OAS2