[public-api] Add experimental TeamsService

Author: easyCZ

Diff for: components/public-api/gitpod/experimental/v1/teams.proto

@@ -0,0 +1,127 @@
+syntax = "proto3";
+
+package gitpod.experimental.v1;
+
+option go_package = "github.com/gitpod-io/gitpod/public-api/experimental/v1";
+
+message Team {
+    // id is a UUID of the Team
+    string id = 1;
+
+    // name is the name of the Team
+    string name = 2;
+
+    // slug is the short version of the Team name
+    string slug = 3;
+
+    // members are the team members of this Team
+    repeated TeamMember members = 4;
+
+    // team_invitation is the team invitation.
+    TeamInvitation team_invitation = 5;
+}
+
+message TeamMember {
+    // user_id is the identifier of the user
+    string user_id = 1;
+
+    // role is the role this member is assigned
+    TeamRole role = 2;
+}
+
+enum TeamRole {
+    // TEAM_ROLE_UNKNOWN is the unkwnon state.
+    TEAM_ROLE_UNSPECIFIED = 0;
+
+    // TEAM_ROLE_OWNER is the owner of the team.
+    // A team can have multiple owners, but there must always be at least one owner.
+    TEAM_ROLE_OWNER = 1;
+
+    // TEAM_ROLE_MEMBER is a regular member of a team.
+    TEAM_ROLE_MEMBER = 2;
+}
+
+message TeamInvitation {
+    // id is the invitation ID.
+    string id = 1;
+}
+
+service TeamsService {
+
+    // CreateTeam creates a new Team.
+    rpc CreateTeam(CreateTeamRequest) returns (CreateTeamResponse) {};
+
+    // ListTeams lists the caller has access to.
+    rpc ListTeams(ListTeamsRequest) returns (ListTeamsResponse) {};
+
+    // JoinTeam makes the caller a TeamMember of the Team.
+    rpc JoinTeam(JoinTeamRequest) returns (JoinTeamResponse) {};
+
+    // ResetTeamInvitation resets the invitation_id for a Team.
+    rpc ResetTeamInvitation(ResetTeamInvitationRequest) returns (ResetTeamInvitationResponse) {};
+
+    // UpdateTeamMember updates team membership properties.
+    rpc UpdateTeamMember(UpdateTeamMemberRequest) returns (UpdateTeamMemberResponse) {};
+
+    // DeleteTeamMember removes a TeamMember from the Team.
+    rpc DeleteTeamMember(DeleteTeamMemberRequest) returns (DeleteTeamMemberResponse) {};
+}
+
+message CreateTeamRequest {
+    // name is the team name
+    string name = 1;
+}
+
+message CreateTeamResponse {
+    Team team = 1;
+}
+
+message ListTeamsRequest {
+    // TODO: pagination options
+}
+
+message ListTeamsResponse {
+    repeated Team teams = 1;
+}
+
+message JoinTeamRequest {
+    // invitation_id is the invitation ID for a Team
+    string invitation_id = 1;
+}
+
+message JoinTeamResponse {
+    // team is the team the user has just joined
+    Team team = 1;
+}
+
+message ResetTeamInvitationRequest {
+    string team_id = 1;
+}
+
+message ResetTeamInvitationResponse {
+    // team_invitation is the new invitation for the team.
+    TeamInvitation team_invitation = 1;
+}
+
+message UpdateTeamMemberRequest {
+    // team_id is the ID of the team in which the role is to be updated
+    string team_id = 1;
+
+    // team_member is the team member being updated.
+    TeamMember team_member = 2;
+
+}
+
+message UpdateTeamMemberResponse {
+    TeamMember team_member = 2;
+}
+
+message DeleteTeamMemberRequest {
+    // team_id is the ID of the team in which a member should be deleted.
+    string team_id = 1;
+
+    // team_member_id is the ID of the TeamMember that should be deleted from the team.
+    string team_member_id = 2;
+}
+
+message DeleteTeamMemberResponse {}