Skip to content

Clarify Azure policy for new-version RequiredStatusChange findings - #542

Merged
Timothee Guerin (timotheeguerin) merged 6 commits into
mainfrom
copilot/clarify-requiredstatuschange-guidance
Oct 13, 2026
Merged

Timothee Guerin (timotheeguerin) merged 6 commits into
mainfrom
copilot/clarify-requiredstatuschange-guidance

Conversation

Copilot AI commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

The 1025 rule page implied that requiredness changes are non-breaking whenever the API version changes. Azure policy can still require breaking-change review, so a new-version finding is not inherently a tooling/documentation mismatch.

  • Policy boundary: Distinguish rule semantics and examples from Azure REST API review policy.
  • Contract impact: Explicitly warn that required-to-optional input/output and response/resource changes are not automatically safe in a new API version.
  • Recommended action: Explain that Azure specs policy and runner mapping can report RequiredStatusChange as breaking; recommend review rather than suppression-first guidance without evidence of an incorrect finding.
  • Fixes #3065

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
There may be pipelines that require an authorized user to comment /azp run to run.

Co-authored-by: jianingwang123 <141212663+jianingwang123@users.noreply.github.com>
Copilot AI changed the title [WIP] Clarify RequiredStatusChange guidance for new-version response Clarify Azure policy for new-version RequiredStatusChange findings Oct 9, 2026
@jianingwang123
Jianing Wang (MSFT) (jianingwang123) marked this pull request as ready for review October 9, 2026 06:34
Comment thread docs/rules/1025.md Outdated
**Description**: Checks whether an existing property's `required` status is changed from the previous specification.

**Cause**: This is considered a breaking change in the same api-version but not breaking in new api-version .
**Cause**: Under this rule's semantics, this is considered a breaking change in the same api-version but not in a new

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do find that part kind confusing still, why do we mention it is not a breaking change but right after says well maybe it is.
Should we say it is 100% a breaking change in the same api version but depends on a new api version

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot pls update the doc based on this comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 0f0998f: the cause now states that requiredness changes are breaking in the same API version, while new-version treatment depends on wire-contract impact and Azure REST API policy. Removed the categorical claim that new-version changes are non-breaking.

Co-authored-by: jianingwang123 <141212663+jianingwang123@users.noreply.github.com>
Comment thread docs/rules/1025.md Outdated
Co-authored-by: jianingwang123 <141212663+jianingwang123@users.noreply.github.com>
Comment thread docs/rules/1025.md Outdated
Co-authored-by: jianingwang123 <141212663+jianingwang123@users.noreply.github.com>
@timotheeguerin
Timothee Guerin (timotheeguerin) merged commit cd4f207 into main Oct 13, 2026
8 checks passed
@timotheeguerin
Timothee Guerin (timotheeguerin) deleted the copilot/clarify-requiredstatuschange-guidance branch October 13, 2026 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants