request-parameter-pattern-added

What this check detects

A regular-expression `pattern` was added to a request parameter that previously had none. The parameter now rejects any value that does not match, so a client sending a value that was accepted before but does not satisfy the pattern starts failing.

This is the parameter-level counterpart of adding a pattern to a request body property.

Example

A client sending ?code=usa (lowercase) was valid before and now fails the ^[A-Z]{3}$ pattern.

How to handle this change

When oasdiff flags request-parameter-pattern-added, you have a few ways to respond:

• Find a backward-compatible alternative. Redesign the change so clients that followed the old contract keep working, and agree on the approach with whoever introduced it.
• Release it in a new API version. Keep the current contract and introduce the change in a new version, then deprecate the old one with a sunset date so clients have time to migrate.
• Accept it as a deliberate breaking change. Sometimes a breaking change is unavoidable, such as an urgent or security fix. Approve it knowingly, document it in your release notes, and tell affected clients. This should be the exception, not a routine way of working.

If oasdiff's verdict does not match your API's compatibility policy, you can also change how it treats request-parameter-pattern-added with 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-parameter-pattern-added warn

Then pass it to oasdiff:

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