Closed npateriya closed 2 months ago
Thanks for reporting this. The example makes sense. Can you suggest a more general rule of when such a change is non-breaking?
We are also internally debating that marking all/general cases of adding {additional-information}
as non-breaking won't be right.
{content-type-xyz} to {content-type-xyz}; {additional-information}
It might be ok to leave this change type as breaking by default but if we identify this as specific rule changee.g. response-media-type-changed
(instead of current added & deleted) then on case by case basis we can use custom severity level
Thanks for the clarification. Your suggestion to be able to detect changes to the media-type names would require new logic to parse the media-types and decide whether they should be considered as modified vs. when they are truly different (added/deleted). I will am converting this issue to a discussion so we can get more feedback from other users.
Describe the bug When adding a char-set to a response the change is reported as breaking. Additionally the 'new' content type is reported as added media type
To Reproduce Steps to reproduce the behavior:
oasdiff changelog simple-response.yaml simple-response-mod.yaml
Spec 1:
Spec 2: URL or YAML or JSON
Output
info [response-media-type-added] at simple-response-mod.yaml in API GET /test added the media type 'application/json; charset=utf-8' for the response with the status '200'