search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.68k stars 5.11k forks source link

PR to remove retired REST API specs is marked BreakingChangeReviewRequired #31445

Open mikekistler opened 1 week ago

mikekistler commented 1 week ago

REST API specs PR 19679 is removing retired versions of REST API definitions from the repo and has been flagged as "BreakingChangeReviewRequired".

We created a label "Versioning-Approved-Retired" (Issue #30652) to use on PRs that remove retired API definitions from the repo, on the assumption that these would be flagged as "VersioningReviewRequired".

So either the above PR should have been flagged as "VersioningReviewRequired" or we need to add support for a "BreakingChange-Approved-Retired" label.

cc: @JeffreyRichter

JeffreyRichter commented 1 week ago

Yes, I agree. I think it would be better if the tool added the VersioningReviewRequired label since deleting swaggers is NOT creating a new version of anything but changing existing version(s). If, for some reason, this is too difficult to fix we could live with BreakingChangeReviewRequired and then apply a new BreakingChange-Approved-Retired label but this is not preferred.

mikeharder commented 1 week ago

After the BreakingChanges check is migrated to our new platform, this type of change should be very easy to make. I will need to investigate the cost of changing this in the existing platform.