Skip to content
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

Closed
philsturgeon opened this issue Dec 2, 2020 · 1 comment
Closed

Deprecation HTTP Header #1563

philsturgeon opened this issue Dec 2, 2020 · 1 comment

Comments

@philsturgeon
Copy link
Contributor

philsturgeon commented Dec 2, 2020

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:

Deprecation: true

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.

@philsturgeon philsturgeon pinned this issue Dec 2, 2020
@XVincentX XVincentX self-assigned this Dec 2, 2020
@XVincentX XVincentX added the team/platinum-falcons Team Platinum Falcons label Jan 7, 2021
@philsturgeon philsturgeon changed the title Deprecated HTTP Header Deprecation HTTP Header Feb 18, 2021
@chohmann chohmann assigned ghost Aug 30, 2021
@ghost
Copy link

ghost commented Sep 9, 2021

Released in version https://github.com/stoplightio/prism/releases/tag/v4.4.0 :)

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants