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.

Sign up for GitHub

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

Jump to bottom

Add the /api/private/crate-owner-invitations endpoint #3763

Merged
merged 5 commits into from
Aug 18, 2021
Merged

Add the /api/private/crate-owner-invitations endpoint #3763

merged 5 commits into from
Aug 18, 2021

Commits on Aug 18, 2021

  1. clarify existing crate_owner_invitations APIs are in the v1 namespace

    @pietroalbini @Turbo87
    pietroalbini authored and Turbo87 committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    30f236b View commit details
    Browse the repository at this point in the history

  2. helpers/pagination: Implement enable_pages flag

    @pietroalbini @Turbo87
    pietroalbini authored and Turbo87 committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    2069eab View commit details
    Browse the repository at this point in the history

  3. views: Rename EncodableCrateOwnerInvitation to `EncodableCrateOwner… 

    …InvitationV1`
    @pietroalbini @Turbo87
    pietroalbini authored and Turbo87 committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    b6bacd4 View commit details
    Browse the repository at this point in the history

  4. tests/owners: Add v1 suffix to invitation tests

    @pietroalbini @Turbo87
    pietroalbini authored and Turbo87 committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    cccfc23 View commit details
    Browse the repository at this point in the history

  5. 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.
    @pietroalbini @Turbo87
    pietroalbini authored and Turbo87 committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    2d1ac26 View commit details
    Browse the repository at this point in the history