Open pledesert-sg opened 2 weeks ago
Hi @pledesert-sg You are right. Deprecation is currently supported only for endpoints. Supporting deprecation for schemas would require adapting the endpoint deprecation code to schemas. Maybe someone from the community wants to pick this up?
Thanks, Reuven
Is your feature request related to a problem? Please describe. It may be necessary to remove an optional field. openapi support parameter deprecation, but oasdiff ignores it.
Describe the solution you'd like Treat parameter deprecation the same as route deprecation, (a parameter should have an associated x-sunset valid with the route grace period)
Describe alternatives you've considered Alternative will be to use oneOf and deprecation of schema, but it is even trickier for oasdiff (migrating existing schema to oneOf is considered a breaking change). Other alternative is to deprecate the whole route, and create a new route with version, but it is not optimal and respectful of REST principles.
Additional context orig.yml:
deprecate.yml:
deprecated_with_sunset.yml
removed.yml
-> no sunset, expected missing sunset warning