openapi-diff icon indicating copy to clipboard operation
openapi-diff copied to clipboard

Removal of 'deprecated' not detected

Open michael-schnell opened this issue 2 years ago • 2 comments

Removal of 'deprecated' is not detected iny any section (headers, operation,parameter, schema).

V1

headers:
    X-RateLimit-Limit:
      schema:
          type: integer
      deprecated: true

V2 (removal of 'deprecated')

headers:
    X-RateLimit-Limit:
      schema:
          type: integer

A new 'deprecated' is detected everywhere, but removal not.

michael-schnell avatar Mar 03 '23 11:03 michael-schnell

@michael-schnell Thanks for reporting this!

Would you expect removing of the deprecation to be a breaking change or a mere informational message/compatible change?

joschi avatar Mar 04 '23 10:03 joschi

I think it's compatible. This change is only of interest for documentation purposes where you will state something like "X-RateLimit-Limit is no longer deprecated since version 1.2.3".

michael-schnell avatar Mar 04 '23 14:03 michael-schnell