-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(be): add admin/client user docs (#1509)
* refactor(be): add explicit type in graphQL * docs(be): add admin user docs * refactor(be): add explicit type in graphQL * docs(be): add some user client api docs * docs(be): add user client docs * docs(be): modify documentation files --------- Co-authored-by: Jaehyeon Kim <[email protected]>
- Loading branch information
1 parent
70014f3
commit ea3bdda
Showing
55 changed files
with
957 additions
and
427 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
collection/admin/User/Delete Group Member/BAD_REQUEST(1).bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| meta { | ||
| name: BAD_REQUEST(1) | ||
| type: graphql | ||
| seq: 2 | ||
| } | ||
|
|
||
| post { | ||
| url: {{gqlUrl}} | ||
| body: graphql | ||
| auth: none | ||
| } | ||
|
|
||
| body:graphql { | ||
| mutation DeleteGroupMember($userId: Int!, $groupId: Int!) { | ||
| deleteGroupMember(userId: $userId, groupId: $groupId) { | ||
| userId | ||
| groupId | ||
| isGroupLeader | ||
| createTime | ||
| updateTime | ||
| } | ||
| } | ||
| } | ||
|
|
||
| body:graphql:vars { | ||
| { | ||
| "groupId": 2, | ||
| "userId": 99 | ||
| } | ||
| } |
30 changes: 30 additions & 0 deletions
30
collection/admin/User/Delete Group Member/BAD_REQUEST(2).bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| meta { | ||
| name: BAD_REQUEST(2) | ||
| type: graphql | ||
| seq: 3 | ||
| } | ||
|
|
||
| post { | ||
| url: {{gqlUrl}} | ||
| body: graphql | ||
| auth: none | ||
| } | ||
|
|
||
| body:graphql { | ||
| mutation DeleteGroupMember($userId: Int!, $groupId: Int!) { | ||
| deleteGroupMember(userId: $userId, groupId: $groupId) { | ||
| userId | ||
| groupId | ||
| isGroupLeader | ||
| createTime | ||
| updateTime | ||
| } | ||
| } | ||
| } | ||
|
|
||
| body:graphql:vars { | ||
| { | ||
| "groupId": 3, | ||
| "userId": 3 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| meta { | ||
| name: Succeed | ||
| type: graphql | ||
| seq: 1 | ||
| } | ||
|
|
||
| post { | ||
| url: {{gqlUrl}} | ||
| body: graphql | ||
| auth: none | ||
| } | ||
|
|
||
| body:graphql { | ||
| mutation DeleteGroupMember($userId: Int!, $groupId: Int!) { | ||
| deleteGroupMember(userId: $userId, groupId: $groupId) { | ||
| userId | ||
| groupId | ||
| isGroupLeader | ||
| createTime | ||
| updateTime | ||
| } | ||
| } | ||
| } | ||
|
|
||
| body:graphql:vars { | ||
| { | ||
| "groupId": 2, | ||
| "userId": 5 | ||
| } | ||
| } | ||
|
|
||
| assert { | ||
| res.body.data.DeleteGroupMember[0].userId: isDefined | ||
| res.body.data.DeleteGroupMember[0].groupId: isDefined | ||
| res.body.data.DeleteGroupMember[0].isGroupLeader: isBoolean | ||
| res.body.data.DeleteGroupMember[0].createTime: isDefined | ||
| res.body.data.DeleteGroupMember[0].updateTime: isDefined | ||
| } | ||
|
|
||
| docs { | ||
| ## Delete Group Member | ||
| 특정 Group Member를 삭제합니다. | ||
|
|
||
| ### Args / Query / Params / Body | ||
| | 이름 | 타입 | 설명 | | ||
| |--|--|--| | ||
| |groupId|Int|삭제할 유저가 포함된 group의 Id| | ||
| |userId|Int|삭제하고 싶은 유저의 Id| | ||
|
|
||
| ### Error Case | ||
|
|
||
| #### Not a Member | ||
| 특정 group에 대해서 해당 userId의 유저가 포함되어 있지 않을 경우 (해당 userId의 유저가 존재하지 않을 때에도 위 에러로 반환됩니다.) | ||
|
|
||
| #### Delete Manager when num(Manager)=1 | ||
| 특정 group의 Manager가 삭제할 userId의 유저 한 명 뿐일 경우 | ||
| } |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.