Skip to main content

Breaking Change Checks

ruleset:
- "breaking-changes":

What Optic Checks For:

Request Parameters

Prevent adding a required Query Parameter

only applies to existing operations, new operations can have required query parameters

Prevent changing an optional Query Parameter to required

only applies to existing operations, new operations can have required query parameters

Prevent adding a required Header Parameter

only applies to existing operations, new operations can have required query parameters

Prevent changing an optional Header Parameter to required

only applies to existing operations, new operations can have required header parameters

only applies to existing operations, new operations can have required query parameters

only applies to existing operations, new operations can have required cookie parameters

Prevent restricting the options for an enum Parameter

applies to parameters with enum schemas. Removing an option that was supported previously is a breaking change

Prevent changing the type of Parameter

applies to parameters with schemas. Incompatible type changes are a breaking change

Operations

Prevent removing an Operation

applies to every operation

Prevent removing a documented Response Status Code

applies to every operation

Request Body Properties

Prevent making an optional Property required

applies to existing properties in existing operations. Request Properties in new operations can be made required

Prevent adding a required Property

applies to existing operations. Adding required properties is a breaking change. Request Properties in new operations can be made required

Prevent changing the type of Property

Incompatible type changes are a breaking change

Response Body Properties

Prevent making a required Property optional

applies to existing properties in existing operations. Response Properties in new operations can be made optional

Prevent removing a required Property

applies to existing operations. Removing required response properties is a breaking change.

Prevent changing the type of Property

Incompatible type changes are a breaking change