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

Add API versioning #380

Open
sabineschaller opened this issue Nov 22, 2023 · 4 comments
Open

Add API versioning #380

sabineschaller opened this issue Nov 22, 2023 · 4 comments

Comments

@sabineschaller
Copy link
Member

For the OpenAPI schemas, we need to add versioning just like we had it on readme.

We want to add a dropdown to select the API version. It can be parsed from the yaml file. Additionally, we need to always show what's on main as the "version in development" (somebody find a better term for that).

@sabineschaller sabineschaller added the type: documentation Improvements or additions to documentation label Nov 22, 2023
@huijing
Copy link
Contributor

huijing commented Dec 8, 2023

@sabineschaller
Copy link
Member Author

We decided to only have 2 versions. A stable one and a latest one which we can make changes to.

@melissahenderson melissahenderson added user-docs and removed type: documentation Improvements or additions to documentation labels Sep 12, 2024
@melissahenderson
Copy link
Contributor

Considering the age of this issue, we will need to discuss whether this is still something we want to do.

@melissahenderson
Copy link
Contributor

@sabineschaller Is this something we should proceed with? Should the user docs only display the stable version, or do we want to make both versions available?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Status: Backlog
Development

No branches or pull requests

3 participants