request-property-default-value-changed

Request property default value changed.

directionrequestareaschemakindvaluesactionchange

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

The `default` of a request property changed. The default is the value the server uses when a client omits the property, so changing it can change behavior for clients that rely on omission, but it does not invalidate any request.

oasdiff reports this as informational. (Adding a default where none existed is treated more strictly.)

Example

Before
After
1schema:1schema:
2 type: object2 type: object
3 properties:3 properties:
4 timeout:4 timeout:
5 type: integer5 type: integer
6 default: 306 default: 60

Clients that omit "timeout" now get 60 instead of 30. Existing requests remain valid either way.

Change its severity

oasdiff reports request-property-default-value-changed 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-default-value-changed err

Then pass it to oasdiff:

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

Related schema rules

Browse all 509 checks →