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.

Sign up for GitHub

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

Jump to bottom

Mark API as deprecated #399

Open
jk2K opened this issue Jul 11, 2017 · 6 comments
Open

Mark API as deprecated #399

jk2K opened this issue Jul 11, 2017 · 6 comments
Labels
type (3): Improvement

Comments

@jk2K
Copy link

jk2K commented Jul 11, 2017

There should be a property to indicate whether a API is deprecated
@nullifiedaccount3
Copy link

This is very very important feature we all need for APIs.

@alexanderscott-eb
Copy link

+1

@splokhikh
Copy link

It will be very good feature, that make API documentation more transparent. How often apiary developers implements proposals? :-)

@zubairIftikharKwe
Copy link

not implement yet?

@rb80
Copy link

rb80 commented May 4, 2021

Is there a roadmap for implementing the deprecated flag in Open API Initiative v2.0 - either for an operation or for a whole API - such that the Documentation tab shows that an operation or an API is deprecated?

@toknT
Copy link

toknT commented Nov 10, 2021

In 2021 , 5 years later I am finding same feature😂

tobice added a commit to apify/apify-docs that referenced this issue Feb 13, 2024
@tobice
docs(api): mark run and build endpoints under /acts/:actor_id deprecated
33ffa72 
Runs and builds have had dedicated namespaces for a long time (/actor-runs/:run_id and /actor-builds/:build_id). The API reference wasn't making it very clear, so this is an attempt to improve the situation.

Unfortunately, there is no native way for API Blueprint to mark endpoints as deprecated [1], so good old bold text will have to do.

[1] apiaryio/api-blueprint#399
@tobice tobice mentioned this issue Feb 13, 2024
Merged
tobice added a commit to apify/apify-docs that referenced this issue Feb 14, 2024
@tobice
docs(api): mark run and build endpoints under /acts/:actor_id depreca…
a370311 
…ted (#859)

Runs and builds have had dedicated namespaces for a long time
(/actor-runs/:run_id and /actor-builds/:build_id). The API reference
wasn't making it very clear, so this is an attempt to improve the
situation.

Unfortunately, there is no native way for API Blueprint to mark
endpoints as deprecated [1], so good old bold text will have to do
(advice from ChatGPT).

[1] apiaryio/api-blueprint#399
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type (3): Improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@kylef @nullifiedaccount3 @jk2K @splokhikh @toknT @alexanderscott-eb @rb80 @zubairIftikharKwe