Add the /api/private/crate-owner-invitations endpoint
#3763
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Turbo87
added
A-backend ⚙️
C-enhancement ✨
pietroalbini
force-pushed
the
get-crate-owner-invitations
branch
from
a69aa9f
to
27bcaf3
Compare
So there is no way to list all outstanding invitations you created? Only for specific crates or invitees? |
|
Not in the current implementation. This API is going to be used only by the crates.io frontend, and I'm not aware of plans to display all the invitations sent by the current user. Adding a new list filter is trivial though, and if @Turbo87 wants to implement showing all the invitations sent by the current user in the frontend I'm happy to add the extra filter. |
Turbo87
force-pushed
the
get-crate-owner-invitations
branch
from
27bcaf3
to
cdd06d6
Compare
Turbo87
reviewed
Jul 1, 2021
Turbo87
reviewed
Jul 1, 2021
|
sorry, forgot that this was still waiting on me 😞 looks great though, so: @bors r+ |
|
📌 Commit cdd06d6 has been approved by |
bors
added a commit
that referenced
this pull request
Aug 18, 2021
…bo87
Add the `/api/private/crate-owner-invitations` endpoint
The endpoint provides a listing of all the invitations sent to the current user or all the invitations to a crate the user owns. Unauthenticated users or unrelated users won't be able to see others' invitations to prevent abuses.
The two ways to query the endpoint are:
GET /api/private/crate-owner-invitations?crate_name={name}
GET /api/private/crate-owner-invitations?invitee_id={uid}
The endpoint is paginated using only seek-based pagination, and the next page field is provided when more results are available.
Once the frontend switches to use the new endpoint we can remove safely remove the old "v1" endpoint, as that's only used for the frontend. Because of this, the "v1" endpoint internally uses the same logic as the new one and converts the data to the old schema.
Part of #2868
r? `@Turbo87`
|
💔 Test failed - checks-actions |
The endpoint provides a listing of all the invitations sent to the
current user or all the invitations to a crate the user owns.
Unauthenticated users or unrelated users won't be able to see others'
invitations to prevent abuses.
The two ways to query the endpoint are:
GET /api/private/crate-owner-invitations?crate_name={name}
GET /api/private/crate-owner-invitations?invitee_id={uid}
The endpoint is paginated using only seek-based pagination, and the
next page field is provided when more results are available.
Once the frontend switches to use the new endpoint we can remove safely
remove the old "v1" endpoint, as that's only used for the frontend.
Because of this, the "v1" endpoint internally uses the same logic as the
new one and converts the data to the old schema.
Turbo87
force-pushed
the
get-crate-owner-invitations
branch
from
cdd06d6
to
2d1ac26
Compare
|
rebased to get rid of the merge failure :) |
|
@bors r+ |
|
📌 Commit 2d1ac26 has been approved by |
|
☀️ Test successful - checks-actions |
Turbo87
reviewed
Aug 19, 2021
| @@ -127,6 +127,12 @@ pub fn build_router(app: &App) -> RouteBuilder { | |||
| // Metrics | |||
| router.get("/api/private/metrics/:kind", C(metrics::prometheus)); | |||
|
|
|||
| // Crate ownership invitations management in the frontend | |||
| router.get( | |||
| "/api/private/crate-owner-invitations", | |||
There was a problem hiding this comment.
hmm, probably should've noticed this earlier: we've been using snake_case for all the URLs so far, instead of kebab-case
There was a problem hiding this comment.
Ugh, could you send a PR renaming the endpoints?
bors
added a commit
that referenced
this pull request
Aug 22, 2021
Rename `GET /api/private/crate-owner-invitations` to `GET /api/private/crate_owner_invitations` ... because the rest of the API also uses underscores Addresses #3763 (comment) :)
bors
added a commit
that referenced
this pull request
Aug 29, 2021
mirage/crate-owner-invitation: Adjust fake API to match the real API #3763 changed a few minor things about the crate owner invitations responses. This PR adjusts our mirage code to match these changes (excluding pagination).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The endpoint provides a listing of all the invitations sent to the current user or all the invitations to a crate the user owns. Unauthenticated users or unrelated users won't be able to see others' invitations to prevent abuses.
The two ways to query the endpoint are:
The endpoint is paginated using only seek-based pagination, and the next page field is provided when more results are available.
Once the frontend switches to use the new endpoint we can remove safely remove the old "v1" endpoint, as that's only used for the frontend. Because of this, the "v1" endpoint internally uses the same logic as the new one and converts the data to the old schema.
Part of #2868
r? @Turbo87