Azure / Azure/azure-sdk-tools

[Breaking Change] Cross-Version PR check reports false positive AddedRequiredProperty error

Open
#5,711 0 comments 0 reactions 1 assignee Claimed by @konrad-jamrozik View on GitHub
Breaking Changes Central-EngSys Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

The BreakingChange CrossVersion PR check in [PR 23076](https://github.com/Azure/azure-rest-api-specs/pull/23076/checks?check_run_id=11994461656) reports an AddedRequiredProperty error for the new `chat_completions` property in the `Capabilities` schema:

image

The description of [AddedRequiredProperty](https://github.com/Azure/openapi-diff/blob/master/docs/rules/1034.md) (which is linked from the report in the PR) says:

> Description: Checks whether a new required property has added from the previous specification.
>
> Cause: This is considered a breaking change. This change requires new api-version.

But this change _is_ in a new api-version. Further, the `Capabilities` schema is only used in response bodies, so adding a required property is not "breaking".

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.