fix: ignore non-method keys in api-diff path iteration#395
Merged
Conversation
path-level keys like x-internal, parameters, summary, etc. were being treated as http methods, producing spurious entries like [X-INTERNAL] in release notes. filter to known http methods. also fix a self-comparison typo in checkSimilarity's description check (was comparing endpoint1.description to itself instead of endpoint2.description). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
eshaan-mehta
approved these changes
May 8, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
x-internal,parameters,summary, etc. don't get reported as endpoint changes (was producing spurious[X-INTERNAL] /api/v2/{coin}/wallet/{walletId}/webhooks/notificationsentries in release notes).checkSimilarity()— the description-similarity check was comparingendpoint1.details.descriptionto itself instead ofendpoint2.details.description.path-level-extensionstest fixture covering path-levelx-internal,summary, andparameters.Test plan
node --test tests/generate-release.test.js— 14/14 pass (13 existing + 1 new fixture)🤖 Generated with Claude Code