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

API versioning? #2

Open
paralaxsd opened this issue Mar 10, 2019 · 3 comments
Open

API versioning? #2

paralaxsd opened this issue Mar 10, 2019 · 3 comments

Comments

@paralaxsd
Copy link

Hi!
We're looking into integrating the Pouet API with our demo launcher UI.
This is an easy enough task but there's one thing that we have to be able to rely on: a stable API.

Unfortunately http://api.pouet.net/ states: "More to come, mostly on demand. Data structures are subject to change without notice."

since most demos we release will end up hosted on scene.org we're not able to update our client code once the demo's out in the wild.

Fortunately there's one easy thing to solve this problem for all of us: use versioning.
The current pouet API is available on http://api.pouet.net/v1. Introducing a new version of the API with breaking changes under http://api.pouet.net/v2 would be a sensible step to keep old clients in the game.

Is this something you would consider?

Thanks!

@Gargaj
Copy link
Contributor

Gargaj commented Mar 10, 2019

That's the hope at least, yes. The API is currently being expanded, but it's unlikely that fields get moved or removed.

@Gargaj
Copy link
Contributor

Gargaj commented Mar 10, 2019

Also you can always update client code too - see https://github.com/Gargaj/Conduit

@paralaxsd
Copy link
Author

paralaxsd commented Mar 10, 2019

Yeah, adding new fields and endpoints won't break v1 so that would be totally fine.

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