request-property-enum-value-added

Request property enum value added.

directionrequestareaschemakindvaluesactionadd

Not breaking (level: info)

oasdiff records this in the changelog but does not fail CI by default. Requests that were valid under the old contract are still valid, so existing clients are not affected.

What this check detects

An enum on a request property limits which values the server accepts. Adding a value widens that set, so it is backward compatible: every request that was valid before is still valid.

This is the mirror image of adding a value to a response enum. On the request side more accepted values is safe (informational); on the response side more possible values is a warning, because the risk sits with the client that has to handle them.

Example

Before
After
1schema:1schema:
2 type: object2 type: object
3 properties:3 properties:
4 status:4 status:
5 type: string5 type: string
6 enum: [active, inactive]6 enum: [active, inactive, archived]

The "status" request property now accepts an additional value, "archived". Existing requests remain valid, so this is informational.

Change its severity

oasdiff reports request-property-enum-value-added 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
request-property-enum-value-added err

Then pass it to oasdiff:

oasdiff changelog base.yaml revision.yaml --severity-levels severity.txt

Related schema rules

Browse all 509 checks →