new-optional-request-default-parameter-to-existing-path
Optional request parameter added at path level.
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
A parameter declared directly under a path, above the individual operations, applies to every operation on that path. This check covers a new **optional** one added there.
Because it is optional, existing clients that do not send it stay valid, so the change is informational. The required version of the same change is breaking: it invalidates every call to every method on the path at once.
Example
The optional "verbose" parameter is inherited by GET /users and any other operation on the path. Clients that omit it are unaffected.
Change its severity
oasdiff reports new-optional-request-default-parameter-to-existing-path 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
new-optional-request-default-parameter-to-existing-path errThen pass it to oasdiff:
oasdiff changelog base.yaml revision.yaml --severity-levels severity.txt