Azure / Azure/azure-rest-api-specs
Breaking Change PR checks should flag changes in tags
Open
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 424
Description
Some consumers of the REST API definitions in this repo use tags on operations for grouping or other purposes, and changes in tag names can cause disruption / breaking changes in the artifacts they produce. An example is the Terraform generators that produce the Terraform plugin for Azure based on the REST API definition.
To avoid breaking changes in these down-stream consumers, we should avoid changes to tag names except where necessary, and we should enhance the Breaking Changes PR checks (openapi-diff) to flag changes to tag names.
Contributor guide
Assessment
This issue has not been assessed yet.