From 40b7a0d8484f562849b933db0beb1fb381b82603 Mon Sep 17 00:00:00 2001
From: Asim Aslam <asim@aslam.me>
Date: Thu, 8 Jul 2021 15:44:17 +0100
Subject: [PATCH] Update user.proto

---
 user/proto/user.proto | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/user/proto/user.proto b/user/proto/user.proto
index 6f42037..04c7a7c 100644
--- a/user/proto/user.proto
+++ b/user/proto/user.proto
@@ -123,14 +123,18 @@ message ReadSessionResponse {
 }
 
 
-// Login a user account
+// Login using username or email. The response will return a new session for successful login.
 message LoginRequest {
+    // The username of the user
     string username = 1;
+    // The email address of the user
     string email = 2;
+    // The password of the user
     string password = 3;
 }
 
 message LoginResponse {
+    // The session of the logged in  user
     Session session = 1;
 }
 
@@ -142,7 +146,9 @@ message LogoutRequest {
 message LogoutResponse {
 }
 
-message VerifyEmailRequest{
+// Verify the email address of an account from a token sent in an email to the user.
+message VerifyEmailRequest {
+        // The token from the verification email
 	string token = 1;
 }