response-mediatype-enum-value-removed
Response mediatype enum value removed.
directionresponseareaschemakindvaluesactionremove
Not breaking (level: info)
oasdiff records this in the changelog but does not fail CI by default. Clients that worked under the old contract still work, so existing clients are not affected.
Example
Before
After
1responses:1responses:
2 '200':2 '200':
3 description: OK3 description: OK
4 content:4 content:
5 application/json:5 application/json:
6 schema:6 schema:
7 type: string7 type: string
8 enum: [active, inactive, pending]8 enum: [active, inactive]
The response media type can no longer return "pending". Reported as informational because clients receive a subset of the values they already handled.
Change its severity
oasdiff reports response-mediatype-enum-value-removed as informational, so it does not fail CI. To treat it as a warning or an error under your own compatibility policy, or to turn it off, set its level in a severity-levels file:
Put one rule per line; the level can be err, warn, or info, or none to disable the check entirely:
# severity.txt
response-mediatype-enum-value-removed errThen pass it to oasdiff:
oasdiff changelog base.yaml revision.yaml --severity-levels severity.txt