request-property-enum-value-added

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

schema:
  type: object
  properties:
    status:
      type: string
      enum: [active, inactive]

schema:
  type: object
  properties:
    status:
      type: string
      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 or ignore it

To change the severity oasdiff assigns to request-property-enum-value-added, list its id and a level in a severity-levels file, 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

Setting the level to none disables the check, so it is no longer reported at all.