TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Non-Breaking API deprecation in OpenAPI spec – what do you think?

1 pointsby lonelygiraffealmost 3 years ago
Sometimes APIs need to be retired, for example when they are superseded by a new version. OpenAPI specification supports a &quot;deprecated&quot; flag which can be used to mark operations and other object types as deprecated, but it lacks the ability to manage a 2-phased API retirement process: 1. Deprecate an API and, optionally, announce a &quot;sunset&quot; date 2. Delete the API at the sunset date or later<p>People seem to want such a process in order to prevent breaking-changes.<p>I wrote a diff tool for OpenAPI spec which supports detection of breaking-changes and I recently extended it to support this process and a bit more.<p>Now I&#x27;m looking for feedback.<p>Proposed Solution (currently in Beta): https:&#x2F;&#x2F;github.com&#x2F;Tufin&#x2F;oasdiff#non-breaking-removal-of-deprecated-resources<p>Related requests: 1. https:&#x2F;&#x2F;github.com&#x2F;Tufin&#x2F;oasdiff&#x2F;issues&#x2F;116 2. https:&#x2F;&#x2F;github.com&#x2F;OAI&#x2F;OpenAPI-Specification&#x2F;discussions&#x2F;2770<p>Your feedback is much appreciated!

no comments

no comments