Azure / Azure/openapi-diff

[Rule] breaking changes, when x-ms-discriminator-value changes

Open
#241 2 comments 0 reactions 0 assignees View on GitHub
Rule
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

Case: https://github.com/Azure/azure-rest-api-specs/pull/20376#discussion_r959039927

Reason:
`x-ms-discriminator-value` is used in client to choose the correct type/class to initialize.

Changing its value will break SDK in runtime (there will be no API change, but SDK will fail to initialize the type in runtime), or client code (if customer uses REST API directly, and use its value to match the type).

Contributor guide

Open the contributing guide

Research direction

The issue names no file, test, or entry point. Start by locating how existing breaking-change rules are represented in this C# command-line tool, then trace comparison handling for x-ms-discriminator-value. Done means a changed value is reported as breaking while unchanged values are not.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.