Tufin / oasdiff

OpenAPI Diff and Breaking Changes
https://www.oasdiff.com
Apache License 2.0
763 stars 63 forks source link

Report a removal of deprecated endpoint in oasdiff changelog #619

Closed realitycheck closed 1 month ago

realitycheck commented 1 month ago

Is your feature request related to a problem? Please describe.

Seems like there is no indication in changelog output in case of removal of deprecated endpoint.

Describe the solution you'd like Info in changelog about removed endpoint.

Describe alternatives you've considered None.

Additional context

oasdiff version: 1.10.26

There trails of endpoint-removed messages are existed in code but no implementation or usage seems found: https://github.com/Tufin/oasdiff/blob/main/checker/generator/messages.yaml#L8

reuvenharrison commented 1 month ago

This is by design. Removing a deprecated resource is not considered breaking. Please read this for more details and let me know if you have any further comments: https://github.com/Tufin/oasdiff/blob/main/docs/DEPRECATION.md

reuvenharrison commented 1 month ago

Actually, you have a point. I am going to add an info-level check when removing an endpoint after deprecation.