request-optional-property-became-not-write-only

Request optional property became not write-only.

directionrequestareaschemakindmutabilityactionchange

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 reverse: an optional request property that was `writeOnly` no longer is, so it may now also appear in responses.

Requests are unaffected, the property was already sendable, so this is informational. It only widens where the field can show up.

Example

Before
After
1schema:1schema:
2 type: object2 type: object
3 properties:3 properties:
4 apiKey:4 apiKey:
5 type: string5 type: string
6 writeOnly: true

Sending "apiKey" is unchanged; the field is simply no longer restricted to requests.

Change its severity

oasdiff reports request-optional-property-became-not-write-only 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-optional-property-became-not-write-only err

Then pass it to oasdiff:

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

Related schema rules

Browse all 509 checks →