request-parameter-removed

Request parameter deleted.

directionrequestareaparameterskindexistenceactionremove

Potentially breaking (level: warning)

oasdiff reports this as a warning: it breaks clients only in some cases, so it is surfaced for review rather than failing CI outright.

Mitigation

This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.

Change its severity or ignore it

To change the severity oasdiff assigns to request-parameter-removed, 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-parameter-removed 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.

Related parameters rules

Browse all 500 checks →