You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Previously, the breaking-only flag would detect any enum value deletion as a breaking change, which makes sense as this can cause customer's automation to break if they rely on an enum value in a request. -check-breaking does not classisfy that as a breaking change. We'd like to either have the check under -check-breaking or have it as a custom check.
To Reproduce
Steps to reproduce the behavior:
Run oasdiff -base base.yaml -revision revision.yaml -check-breaking
With base.yaml
openapi: 3.0.1info:
title: Test APItags:
- name: Testsdescription: Test tag.paths:
/api/deleteEnumTest:
get:
tags:
- Testssummary: This is a testdescription: Test description.operationId: getTestresponses:
"200":
description: OKcontent:
application/json:
schema:
type: stringdescription: Enum valuesenum:
- VALUE_1
- VALUE_2
- VALUE_3
With revision.yaml
openapi: 3.0.1info:
title: Test APItags:
- name: Testsdescription: Test tag.paths:
/api/deleteEnumTest:
get:
tags:
- Testssummary: This is a testdescription: Test description.operationId: getTestresponses:
"200":
description: OKcontent:
application/json:
schema:
type: stringdescription: Enum valuesenum:
- VALUE_1
- VALUE_2
- VALUE_5
Desktop (please complete the following information):
OS: Mac OS Monterey
The text was updated successfully, but these errors were encountered:
blva
changed the title
Enum value deletion is not detected as a breaking change by check-breaking
Enum value deletion/update is not detected as a breaking change by check-breaking
Mar 23, 2023
Describe the bug
Previously,
the breaking-only
flag would detect any enum value deletion as a breaking change, which makes sense as this can cause customer's automation to break if they rely on an enum value in a request. -check-breaking does not classisfy that as a breaking change. We'd like to either have the check under -check-breaking or have it as a custom check.To Reproduce
Steps to reproduce the behavior:
oasdiff -base base.yaml -revision revision.yaml -check-breaking
Expected behavior
Similar to -breaking-only
Desktop (please complete the following information):
The text was updated successfully, but these errors were encountered: