This repository has been archived by the owner on Jan 22, 2025. It is now read-only.
Enhancement/endpoints cleanup #61
Merged
Conversation
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
JibrilExe
approved these changes
Mar 7, 2024
Vucis
suggested changes
Mar 7, 2024
| """ | ||
| This function will return all the admins of a course | ||
| """ | ||
| abort_url = API_URL + "/courses/" + str(course_id) + "/admins" |
| """ | ||
| Api endpoint for adding new admins to a course, can only be done by the teacher | ||
| """ | ||
| abort_url = API_URL + "/courses/" + str(course_id) + "/admins" |
| """ | ||
| Api endpoint for removing admins of a course, can only be done by the teacher | ||
| """ | ||
| abort_url = API_URL + "/courses/" + str(course_id) + "/admins" |
| } | ||
|
|
||
| return { | ||
| "message": "Succesfully retrieved course with course_id: " + str(course_id), |
| to get all the users assigned to a course | ||
| everyone can get this data so no need to have uid query in the link | ||
| """ | ||
| abort_url = API_URL + "/courses/" + str(course_id) + "/students" |
| return json_message(message), 400 | ||
| add_abort_if_error(CourseStudent(uid=uid, course_id=course_id), abort_url) | ||
| commit_abort_if_error(abort_url) | ||
| response = json_message("User were succesfully added to the course") |
| delete_abort_if_error(student_relation, abort_url) | ||
| commit_abort_if_error(abort_url) | ||
|
|
||
| response = json_message("User were succesfully removed from the course") |
| HTTPException: If the current user is not authorized or | ||
| if the UID of the person to be made an admin is missing in the request body. | ||
| """ | ||
| url = API_URL + "/courses/" + str(course_id) + "/admins" |
| 403: If the user is not authorized to assign new students to the course. | ||
| 400: If the request body does not contain the required 'students' field. | ||
| """ | ||
| url = API_URL + "/courses/" + str(course_id) + "/students" |
backend/project/utils/misc.py
Outdated
| @@ -0,0 +1,76 @@ | |||
| """ | |||
| This module contains functions that are not related to anything specific but | |||
| are ought to be used throughout the project. | |||
There was a problem hiding this comment.
but are ought is wrong, you can say the functions ought to be used if they should be used, or the functions are usable if they can be used
Vucis
approved these changes
Mar 8, 2024
Gerwoud
reviewed
Mar 8, 2024
backend/project/utils/query_agent.py
Outdated
| return jsonify({ | ||
| "data": new_instance, | ||
| "message": "Object created succesfully.", | ||
| "url": urljoin(response_url_base, str(getattr(new_instance, url_id_field)))}), 201 |
There was a problem hiding this comment.
should be
url": urljoin(response_url_base + "/", str(getattr(new_instance, url_id_field)))}), 201
otherwise the response url won't be returned correctly
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.