Azure / Azure/azure-rest-api-specs
[openapi-diff-runner] Compare API versions as a whole, not file-by-file
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 3d 37m
- Merged PRs (30d)
- 446
Description
The Cross Version Breaking Changes checks for azure-rest-api-specs-pr [PR 11624](https://github.com/Azure/azure-rest-api-specs-pr/pull/11624) failed to compare against the prior stable version (2020-08-20) and thus missed breaking changes in the new stable version:
This is likely because the files in the prior stable version had slightly different names -- "CommunicationService.json" rather than "CommunicationServices.json".
Contributor guide
Research direction
Use the failure from azure-rest-api-specs-pr PR 11624 as the reproduction case, comparing the 2020-08-20 prior stable version with the new stable version. Inspect the openapi-diff-runner entry point and its version comparison logic; done means renamed files such as CommunicationService.json and CommunicationServices.json are compared as part of the whole API version and breaking changes are detected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100