Skip to content

Commit

Permalink
docs: add invite Client Docs (litmuschaos#7)
Browse files Browse the repository at this point in the history
Signed-off-by: 잉퓨 <[email protected]>
  • Loading branch information
inpyu committed Nov 14, 2024
1 parent 3fa4787 commit 5e58af6
Showing 1 changed file with 103 additions and 0 deletions.
103 changes: 103 additions & 0 deletions docs/invitation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@

# Invitation Request

```mermaid
classDiagram
class AcceptInvitationRequest {
-String projectId
-String userId
+AcceptInvitationRequest(String projectId, String userId)
}
```
```mermaid
classDiagram
class DeclineInvitationRequest {
-String projectId
-String userId
+DeclineInvitationRequest(String projectId, String userId)
}
```
```mermaid
classDiagram
class InviteUsersRequest {
-String projectId
-String userId
+InviteUsersRequest(String projectId, String userId)
}
```
```mermaid
classDiagram
class ListInvitationRequest {
-String projectId
-String userId
+ListInvitationRequest(String projectId, String userId)
}
```
```mermaid
classDiagram
class RemoveInvitationRequest {
-String projectId
-String userId
+RemoveInvitationRequest(String projectId, String userId)
}
```
```mermaid
classDiagram
class SendInvitationRequest {
-String projectId
-String userId
-String role
+SendInvitationRequest(String projectId, String userId, String role)
}
```

# Invitation Response
```mermaid
classDiagram
class 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
+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)
}
class UserInfo {
-String userID
-String username
-String email
+UserInfo(String userID, String username, String email)
}
InviteUsersResponse --> UserInfo
```
```mermaid
classDiagram
class ListInvitationResponse {
-String projectID
-String projectName
-ProjectUser projectOwner
-String invitationRole
+ListInvitationResponse(String projectID, String projectName, ProjectUser projectOwner, String invitationRole)
}
class ProjectUser {
-String userID
-String username
-String email
-String name
-String role
-String invitation
-long joinedAt
+ProjectUser(String userID, String username, String email, String name, String role, String invitation, long joinedAt)
}
ListInvitationResponse --> ProjectUser
```

0 comments on commit 5e58af6

Please sign in to comment.