-
Notifications
You must be signed in to change notification settings - Fork 338
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deprecation HTTP Header #1563
Labels
Comments
ghost
pushed a commit
that referenced
this issue
Sep 1, 2021
7 tasks
Released in version https://github.com/stoplightio/prism/releases/tag/v4.4.0 :) |
Closed
Closed
Closed
Merged
This was referenced Apr 29, 2024
Closed
Closed
This issue was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
User story.
As a API client developer, I can interact with Prism Mock or Proxy, and find out when an endpoint I interact with is deprecated.
Is your feature request related to a problem?
Now that Studio and Docs mark HTTP Operations as deprecated, we need to help surface that to developers in any way possible.
Describe the solution you'd like
When an API client application is interacting with Prism, they should see a Deprecation HTTP header for any Mock endpoint which has
deprecated: true
.The Deprecation HTTP Header should look like this:
Seeing as OpenAPI does not offer any other information, like a date or replacement information, we cannot do anything more than this, but this is enough to let developers know that something is up (if they're looking for it, but that is a whole other story).
For the proxy, if the server has set its own
Deprecation
header then we should respect it, only add this header if there is not one defined in the message already.The text was updated successfully, but these errors were encountered: