Move backend routes under api/v1 #1017
Conversation
For consistency, to avoid the clash with the frontend /me route that caused problems with staying logged in, to make it clear that these routes are part of the public HTTP API provided by crates.io, and to let us evolve these routes in the future.
|
Looks great to me @carols10cents! Works fine for me in a staging environment. This should also fix things for people who have HTML cached under the old route. |
|
thank you @jtgeibel! bors: r+ |
1017: Move backend routes under api/v1 r=carols10cents For consistency, to avoid the clash with the frontend /me route that caused problems with staying logged in, to make it clear that these routes are part of the public HTTP API provided by crates.io, and to let us evolve these routes in the future. This would make me feel comfortable about adding a cargo command that uses the info from the backend me route (see #1012). We could do this more conservatively by leaving the old routes here and only adding the new routes... but we haven't made any guarantees about the stability of these routes, so... See discussion: #910 (comment) @jtgeibel wdyt?
Build succeeded |
|
Is there any way I can get notified in advance for these API changes? Cargobot (which announces new crates on I realize that the crates.io API doesn't have any stability guarantees at the moment, but it would be nice to get a heads-up when things break! |
|
Hi! I had no idea about cargobot. In what form would you like to be notified, and for what kinds of API changes? |
|
Fortunately, the only routes that remain at the top level are However, it would be really nice if we had a list of known projects using the API so that we could reach out when we have such changes and even to just get a better understanding of how the broader ecosystem is using crates.io. |
|
Cargobot only depends on I think a GitHub mention would be okay, since I check that often. If/when we set up a general way to notify consumers about API changes (as suggested by @jtgeibel) I'll be happy to follow that instead. |
|
Ok! I started a wiki page for things I know use crates.io's api, and I'll try and remember to cc you if we change things about summary! |
For consistency, to avoid the clash with the frontend /me route that
caused problems with staying logged in, to make it clear that these
routes are part of the public HTTP API provided by crates.io, and to
let us evolve these routes in the future.
This would make me feel comfortable about adding a cargo command that uses the info from the backend me route (see #1012).
We could do this more conservatively by leaving the old routes here and only adding the new routes... but we haven't made any guarantees about the stability of these routes, so...
See discussion: #910 (comment)
@jtgeibel wdyt?