Some changes that we do not consider “breaking” might nonetheless break your code.

For example: adding a new enum value to an existing property is not considered breaking, but your parser may break depending on implementation.

Request Parameters

  • A new required query, header or cookie parameter was added to an existing endpoint.
  • An existing optional query, header or cookie parameter became required.
  • An enum value of an existing query, header, path or cookie parameter was removed or changed.
  • An existing query, header or cookie parameter changed its type to an incompatible one.

Operations

  • An existing operation was removed.
  • An existing response status code was removed from an existing operation.

Request Body Properties

  • An existing response body optional property became required.
  • An existing response body gained a new required property with no default value.
  • An existing response body property changed its type to an incompatible one.
  • An existing response enum value was removed.

Response Body Properties

  • An existing optional response body property became required.
  • An existing response body required property was removed.
  • An existing response body property changed its type to an incompatible one.

Was this page helpful?