summaryrefslogtreecommitdiffstats
path: root/lib/sellershut-core/proto/profile/profile.proto
blob: 61181b3733dc1ea9c536fa6e17140f6ce5ba9fd3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
syntax = "proto3";

package profile;

import "google/protobuf/timestamp.proto";

// A message representing a user profile
message User {
  // Unique identifier for the user
  string id = 1;
  // Email address of the user
  string email = 2;
  // Unique username chosen by the user
  string username = 3;
  // URL to the user's avatar image
  optional string avatar = 4;
  // Timestamp when the user was created
  google.protobuf.Timestamp created_at = 5;
  // Timestamp when the user was last updated
  google.protobuf.Timestamp updated_at = 6;
  // User-provided description or bio
  optional string description = 7;
}

// Request message for creating a new user profile
message CreateUserRequest {
  // Email address of the new user
  string email = 1;
  // Avatar for the new user
  optional string avatar = 2;
}

// Response message for CreateUser RPC
message CreateUserResponse {
  // Temporary assigned id 
  string temp_id = 1;
}

// Message to finalise profile creation
message CompleteUserRequest {
  // ID of the user to finalise
  string id = 1;
  // Required: username to finalise the profile
  string username = 2;
  // Optional: user-provided description
  optional string description = 3;
  // Optional: update avatar
  optional string avatar = 4;
}

// Profile gRPC service
service Profile {
  // Create a new user profile
  rpc CreateUser (CreateUserRequest) returns (CreateUserResponse);
  // Complete Profile
  rpc CompleteProfile (CompleteUserRequest) returns (User);
}