Azure / Azure/openapi-diff

[Rule] Allowed values for an enum have changed

Open
#36 4 comments 0 reactions 0 assignees View on GitHub
.NET planned Rule Rule Doc Needed
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

Enum “foo” had allowed values as “val1” and “val2” in v1 of API. If now, the values allowed/accepted by the service are “val1”, “val2” and “val3”, client will fail to de-serialize if “val3” comes back in the response.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the issue with two OpenAPI specifications where enum “foo” gains “val3”, then trace the command-line tool’s rule comparison for allowed enum values. Done means the change is reported when a newer specification accepts a value that the earlier one did not, covering the described deserialization risk.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.