request-property-became-required

Request property became required.

directionrequestareaschemakindrequirednessactionchange

Breaking change (level: error)

oasdiff reports this as a breaking change by default. It can break existing API clients, so CI fails on it unless you downgrade its severity.

Example

Before
schema:
  type: object
  properties:
    name:
      type: string
    email:
      type: string
  required:
    - name
After
schema:
  type: object
  properties:
    name:
      type: string
    email:
      type: string
  required:
    - name
    - email

The "email" request property became required. Requests that omitted it were valid before and now fail.

Change its severity or ignore it

To change the severity oasdiff assigns to request-property-became-required, 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-property-became-required warn

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 schema rules

Browse all 500 checks →