api-schema-removed

Schema deleted from components/schemas.

areacomponentskindexistenceactionremove

Not breaking (level: info)

oasdiff records this in the changelog but does not fail CI by default. It is backward compatible, so existing clients are not affected.

Example

Before
After
1components:1components:
2 schemas:2 schemas:
3 User:3 User:
4 type: object4 type: object
5 Address:
6 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

oasdiff reports api-schema-removed 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
api-schema-removed err

Then pass it to oasdiff:

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

Related components rules

Browse all 509 checks →