Skip to content

Commit 5e58af6

Browse files
committed
docs: add invite Client Docs (litmuschaos#7)
Signed-off-by: 잉퓨 <[email protected]>
1 parent 3fa4787 commit 5e58af6

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

docs/invitation.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
2+
# Invitation Request
3+
4+
```mermaid
5+
classDiagram
6+
class AcceptInvitationRequest {
7+
-String projectId
8+
-String userId
9+
+AcceptInvitationRequest(String projectId, String userId)
10+
}
11+
```
12+
```mermaid
13+
classDiagram
14+
class DeclineInvitationRequest {
15+
-String projectId
16+
-String userId
17+
+DeclineInvitationRequest(String projectId, String userId)
18+
}
19+
```
20+
```mermaid
21+
classDiagram
22+
class InviteUsersRequest {
23+
-String projectId
24+
-String userId
25+
+InviteUsersRequest(String projectId, String userId)
26+
}
27+
```
28+
```mermaid
29+
classDiagram
30+
class ListInvitationRequest {
31+
-String projectId
32+
-String userId
33+
+ListInvitationRequest(String projectId, String userId)
34+
}
35+
```
36+
```mermaid
37+
classDiagram
38+
class RemoveInvitationRequest {
39+
-String projectId
40+
-String userId
41+
+RemoveInvitationRequest(String projectId, String userId)
42+
}
43+
```
44+
```mermaid
45+
classDiagram
46+
class SendInvitationRequest {
47+
-String projectId
48+
-String userId
49+
-String role
50+
+SendInvitationRequest(String projectId, String userId, String role)
51+
}
52+
```
53+
54+
# Invitation Response
55+
```mermaid
56+
classDiagram
57+
58+
class InviteUsersResponse {
59+
-long updatedAt
60+
-long createdAt
61+
-UserInfo createdBy
62+
-UserInfo updatedBy
63+
-boolean isRemoved
64+
-String userID
65+
-String username
66+
-String salt
67+
-String email
68+
-String name
69+
-String role
70+
-boolean isInitialLogin
71+
+InviteUsersResponse(long updatedAt, long createdAt, UserInfo createdBy, UserInfo updatedBy, boolean isRemoved, String userID, String username, String salt, String email, String name, String role, boolean isInitialLogin)
72+
}
73+
74+
class UserInfo {
75+
-String userID
76+
-String username
77+
-String email
78+
+UserInfo(String userID, String username, String email)
79+
}
80+
InviteUsersResponse --> UserInfo
81+
```
82+
```mermaid
83+
classDiagram
84+
class ListInvitationResponse {
85+
-String projectID
86+
-String projectName
87+
-ProjectUser projectOwner
88+
-String invitationRole
89+
+ListInvitationResponse(String projectID, String projectName, ProjectUser projectOwner, String invitationRole)
90+
}
91+
92+
class ProjectUser {
93+
-String userID
94+
-String username
95+
-String email
96+
-String name
97+
-String role
98+
-String invitation
99+
-long joinedAt
100+
+ProjectUser(String userID, String username, String email, String name, String role, String invitation, long joinedAt)
101+
}
102+
ListInvitationResponse --> ProjectUser
103+
```

0 commit comments

Comments
 (0)