api-schema-removed

Schema deleted from components/schemas.

areacomponentskindexistenceactionremove

Not breaking (level: info)

oasdiff reports this in the changelog but does not treat it as a breaking change, so it does not fail CI by default.

Example

Before
components:
  schemas:
    User:
      type: object
    Address:
      type: object
After
components:
  schemas:
    User:
      type: object

The "Address" schema was removed from components/schemas. Any request or response that referenced it via $ref no longer resolves.

Change its severity or ignore it

To change the severity oasdiff assigns to api-schema-removed, 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
api-schema-removed err

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

Browse all 500 checks →