Azure / Azure/azure-rest-api-specs

[Docs cleanup] Refresh breaking-change / OAD guidance

Open
#44,678 1 comment 0 reactions 1 assignee Claimed by @markcowl View on GitHub
Docs
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

**Context:** Breaking-change detection (OAD / `Azure/openapi-diff`) still applies to generated OpenAPI, but the
top-level guideline doc is already marked deprecated. This issue tracks pointing it at the current policy.

**Legend:** 🔴 OBSOLETE (delete/archive) · 🟡 NEEDS-UPDATE (reword)

**Tasks:**

- [ ] 🔴 `documentation/Breaking changes guidelines.md` — already marked "Deprecated"; replace with pointer to current policy
- [ ] 🟡 `documentation/BreakingChange-Oad-Rules-Mapping.md` — keep it for now (uses current `Azure/openapi-diff`); replace with typespec diff tool when it is ready.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.