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

Provide Guidelines on version handling of endpoints across the eiffel-community #35

Open
SantoshNC68 opened this issue Apr 20, 2020 · 1 comment

Comments

@SantoshNC68
Copy link
Member

Description

There is no common guidelines about how to support the version handling and how long we should support the deprecated endpoints. This issue is create to make a guidelines available across the community so that we adhere the same across different repositories

Motivation

We have different repositories adhering to different ways w.r.t version handling of endpoints, so this can be brought in as a common way to support them.

Exemplification

Benefits

Possible Drawbacks

@e-backmark-ericsson
Copy link
Member

I agree it would be good to have a common guideline on how REST APIs in general and version handling in REST APIs in specifically should work across tools in the Eiffel eco-system.
I guess we should get input from looking at for example Swagger, RAML, Open API. We could also look at this recommendation from Zalando before we decide on our best practices here: https://opensource.zalando.com/restful-api-guidelines/
We should collect the current used standards in our existing Eiffel eco-system tools and relate them to current best practices in the open source world and set our own baseline for such guidelines (or just point to an existing one).

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

No branches or pull requests

2 participants