openedx / openedx/openedx-platform
Course Team Management API
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
| Method | Endpoint | Services | Status | Existing API Path | Description |
|---|---|---|---|---|---|
| GET | /api/instructor/v1/courses/{course_key}/roles/ | student.auth | Missing | N/A | List all users with assigned roles in the course (supports filtering by role_type) |
| POST | /api/instructor/v1/courses/{course_key}/roles/{username} | student.auth | Partial | /courses/{course_id}/instructor/api/modify_access | Grant a course role to a user (role specified in request body) |
| DELETE | /api/instructor/v1/courses/{course_key}/roles/{username} | student.auth | Missing | N/A | Revoke a course role from a user (role specified in request body) |
| GET | /api/instructor/v1/courses/{course_key}/forum/members | discussion, student.auth | Partial | /courses/{course_id}/instructor/api/list_forum_members | List users with forum moderation roles |
| POST | /api/instructor/v1/courses/{course_key}/forum/members | discussion, student.auth | Partial | /courses/{course_id}/instructor/api/update_forum_role_membership | Grant forum moderation role to users |
| DELETE | /api/instructor/v1/courses/{course_key}/forum/members | discussion, student.auth | Missing | N/A | Revoke forum moderation role from users |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the existing API paths listed in the table, especially modify_access, list_forum_members, and update_forum_role_membership, along with the student.auth and discussion services. Compare their current behavior with the six endpoint descriptions. Done means the listed course-role and forum-members endpoints support the stated list, grant, and revoke operations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, authorization, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100