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

Versioning of the API spec? #32

Open
mgoltzsche opened this issue Dec 10, 2023 · 1 comment
Open

Versioning of the API spec? #32

mgoltzsche opened this issue Dec 10, 2023 · 1 comment

Comments

@mgoltzsche
Copy link

mgoltzsche commented Dec 10, 2023

How is the AURA API versioned?
I already noticed that the old beets web API is not versioned. Unfortunately, that also seems to be the case with the new AURA API, isn't it?

There are two common ways of versioning REST APIs:

  • The text book way: specifying the version as part of the path prefix, e.g. /aura/v1/tracks.
  • Specifying the version as part of the Content-Type which simplifies supporting multiple API versions at the same time and negotiating versioning with the clients.
@mgoltzsche mgoltzsche changed the title Versioning? Versioning of the API spec? Dec 10, 2023
@sampsyo
Copy link
Member

sampsyo commented Dec 15, 2023

This is a great point; thanks for bringing it up. It seems like I never actually wrote the down anywhere, but my original idea was your "textbook" suggestion—basically, everything the spec currently specifies is supposed to be hosted under a top-level path like /aura/1 or similar.

But I'm also open to the content-negotiation style… I've never used an API that uses that style! Clearly, we should pick one and actually specify it here.

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