tmp: address pr reviews

README.md

@@ -42,3 +42,9 @@ automatically after every push to `main` and `develop` as well as after a
 version tag has been set. The generated documentation is packaged into a
 docker container running [nginx](https://nginx.org/) and is served on the
 internal port `80`.
+
+The documentation can be built locally using docker:
+```bash
+docker build . -t snowballr-api
+docker run -it -p 8080:80 snowballr-api:latest
+```

proto/authentication.proto

@@ -36,6 +36,6 @@ message PasswordChangeRequest {
   string new_password = 2;
 }
 
-message EMailChangeRequest {
+message EmailChangeRequest {
   string new_email = 1;
 }

proto/main.proto

@@ -17,19 +17,20 @@ service SnowballR {
 
   rpc Register (RegisterRequest) returns (LoginSecret);
   rpc Login (LoginRequest) returns (LoginSecret);
+  rpc Logout (Nothing) returns (Nothing);
   rpc IsAuthenticated (Nothing) returns (BoolValue);
   rpc RenewSession (RenewRequest) returns (LoginSecret);
   rpc RequestPasswordReset (RequestPasswordResetRequest) returns (Nothing);
   rpc ResetPassword (PasswordResetRequest) returns (Nothing);
   rpc ChangePassword (PasswordChangeRequest) returns (Nothing);
-  rpc ChangeEMail (EMailChangeRequest) returns (Nothing);
+  rpc ChangeEmail (EmailChangeRequest) returns (Nothing);
 
 
   rpc GetAllUsers (Nothing) returns (User.List);
   // The currently logged in user of this session.
   rpc GetCurrentUser (Nothing) returns (User);
   rpc GetUserById (Id) returns (User);
-  rpc GetUserByEMail (Id) returns (User);
+  rpc GetUserByEmail (Id) returns (User);
   rpc UpdateUser (User.Update) returns (User);
   rpc SoftDeleteUser (Id) returns (Nothing);
   rpc SoftUndeleteUser (Id) returns (Nothing);

proto/project.proto

@@ -37,7 +37,8 @@ message Project {
   string name = 2;
   ProjectStatus status = 3;
   uint64 current_stage = 4;
-  Settings settings = 5;
+  uint64 max_stage = 5;
+  Settings settings = 6;
 
   message List {
     repeated Project projects = 1;

proto/user_settings.proto

@@ -8,7 +8,7 @@ import "project.proto";
 message UserSettings {
   bool show_hotkeys = 1;
   bool review_mode = 2;
-  Project.Settings project_settings = 3;
+  Project.Settings default_project_settings = 3;
   Criterion.List default_criteria = 4;
 
   message Update {