-
Notifications
You must be signed in to change notification settings - Fork 16
docs(be): modify client course bruno docs #3348
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
zero1177
wants to merge
2
commits into
main
Choose a base branch
from
t2410-modify-client-course-bruno-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -24,7 +24,59 @@ script:pre-request { | |
| } | ||
|
|
||
| docs { | ||
| # Get Group by Group Id | ||
| # 📘 Get Course by Id | ||
|
|
||
| **GET** `/course/:id` | ||
|
|
||
| Get a course information for a specific group Id. | ||
|
|
||
| URL param으로 전달된 강의 `groupId`를 통해 해당 강의의 정보를 가져와 반환합니다. | ||
|
|
||
| --- | ||
| - URL param으로 전달된 `groupId`를 통해 해당 group의 정보를 가져와 반환합니다. | ||
|
|
||
| ### 🔒 Authentication | ||
|
|
||
| ✅ Required | ||
|
|
||
| --- | ||
|
|
||
| ### 📥 Request Parameters | ||
|
|
||
| #### Path Parameters | ||
|
|
||
| | Name | Type | Required | Description | | ||
| |------|--------|----------|--------------------------| | ||
| | `id` | number | ✅ | ID of the target course | | ||
|
|
||
| --- | ||
|
Comment on lines
+43
to
+51
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Query Parameter도 추가해주세용 |
||
|
|
||
| ### 📝 Response Body | ||
|
|
||
| #### Content-Type: `application/json` | ||
|
|
||
| ``` | ||
| { | ||
| "id": 2, | ||
| "groupName": "정보보호개론", | ||
| "groupType": "Course", | ||
| "courseInfo": { | ||
| "courseNum": "SWE3033", | ||
| "classNum": 42, | ||
| "professor": "형식킴", | ||
| "semester": "2025 Spring" | ||
| }, | ||
| "isJoined": false | ||
| } | ||
| ``` | ||
|
|
||
| | Name | Type | Required | Description | | ||
| |------|--------|----------|---------------------------| | ||
| | `id` | number | ✅ | 그룹 id | | ||
| | `groupName` | string | ✅ | 그룹 제목 | | ||
| | `groupType` | string | ✅ | 그룹 유형 | | ||
| | `courseNum` | string | ✅ | 강의 번호 | | ||
| | `classNum` | number | ✅ | 분반 | | ||
| | `professor` | string | ✅ | 교수님 성함 | | ||
| | `semester` | string | ✅ | 학기 | | ||
| | `isJoined` | boolean | ✅ | 강의 등록 여부 | | ||
| } | ||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -24,7 +24,19 @@ script:pre-request { | |
| } | ||
|
|
||
| docs { | ||
| # Get Joined Groups | ||
| # 📘 Get Joined Courses | ||
|
|
||
| **GET** `/course/joined` | ||
|
|
||
| Get information of joined courses of current user. | ||
|
|
||
| 현재 User가 속해있는 group(강의)들의 정보를 반환합니다. | ||
|
|
||
| --- | ||
|
|
||
| ### 🔒 Authentication | ||
|
|
||
| ✅ Required | ||
|
|
||
| --- | ||
| - 현재 User가 속해있는 Group 정보를 반환합니다. | ||
| } | ||
|
Comment on lines
+27
to
42
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Response Body 추가 해주세용 |
||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
좀 더 자세한 설명이 있으면 좋겠습니당
(invited에 따라 어떻게 변하는 지 Joined 여부에 따라 어떻게 변하는 지 등)