Skip to content

Commit

Permalink
update Breaking Changes to Enum Values
Browse files Browse the repository at this point in the history
  • Loading branch information
Reuven committed Jan 12, 2024
1 parent 76e7440 commit a2470e3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion BREAKING-CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The required parts may appear in any order, in lower or upper case, and the conf
The configuration files can be of any text type, e.g., Markdown, so you can use them to document breaking changes and other important changes.

### Breaking Changes to Enum Values
The new Breaking Changes method support rules for enum changes using the `x-extensible-enum` extension.
Oasdiff supports special rules for enum changes using the `x-extensible-enum` extension.
This method allows adding new entries to enums used in responses which is very usable in many cases but requires clients to support a fallback to default logic when they receive an unknown value.
`x-extensible-enum` was introduced by [Zalando](https://opensource.zalando.com/restful-api-guidelines/#112) and picked up by the OpenAPI community. Technically, it could be replaced with anyOf+classical enum but the `x-extensible-enum` is a more explicit way to do it.
In most cases the `x-extensible-enum` is similar to enum values, except it allows adding new entries in messages sent to the client (responses or callbacks).
Expand Down

0 comments on commit a2470e3

Please sign in to comment.