search

OpenAPITools / openapi-diff

Utility for comparing two OpenAPI specifications.
Apache License 2.0
784 stars 153 forks source link

Removal of 'deprecated' not detected #485

Open michael-schnell opened 1 year ago

michael-schnell commented 1 year ago

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.

joschi commented 1 year ago

@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?

michael-schnell commented 1 year ago

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".