openedx / edx-platform

The Open edX LMS & Studio, powering education sites around the world!
https://openedx.org
GNU Affero General Public License v3.0
7.1k stars 3.79k forks source link

Migrating LMS APIs to DRF #35057

Open awais786 opened 6 days ago

awais786 commented 6 days ago

This document Big changes to edx-platform contains a segment to convert

Improve HTTP APIs.

  1. Switch all APIs to be using DRF with standard Auth classes.
  2. Document APIs to clearly separate Operator, Instructor, and Learner APIs.
  3. Map existing APIs to product features and build out missing APIs.
  4. Define best practices for how to build APIs?
### Tasks releated with 1st point Switch all APIs to be using DRF with standard Auth classes.
- [x] https://github.com/openedx/edx-platform/issues/35058
- [x] https://github.com/openedx/edx-platform/issues/35059
- [x] https://github.com/openedx/edx-platform/issues/35060
- [x] https://github.com/openedx/edx-platform/issues/35061
- [x] https://github.com/openedx/edx-platform/issues/35062
- [ ] https://github.com/openedx/edx-platform/issues/35064
- [ ] https://github.com/openedx/edx-platform/issues/35065
- [ ] https://github.com/openedx/edx-platform/issues/35066
- [ ] https://github.com/openedx/edx-platform/issues/35067
- [ ] https://github.com/openedx/edx-platform/issues/35068
- [ ] https://github.com/openedx/edx-platform/issues/35069
- [ ] https://github.com/openedx/edx-platform/issues/35070
- [ ] https://github.com/openedx/edx-platform/issues/35071
- [ ] https://github.com/openedx/edx-platform/issues/35072
- [ ] https://github.com/openedx/edx-platform/issues/35073
- [ ] https://github.com/openedx/edx-platform/issues/35074
- [ ] https://github.com/openedx/edx-platform/issues/35075
- [ ] List_background_email_tasks
- [ ] List_email_content
- [ ] List_instructor_tasks
- [ ] List_entrance_exam_instructor_tasks
- [ ] List_report_downloads
- [ ] List_financial_report_downloads
- [ ] Export_ora2_data
- [ ] Export_ora2_summary
- [ ] Export_ora2_submission_files
- [ ] Calculate_grades_csv
- [ ] Problem_grade_report
- [ ] List_forum_members
- [ ] Send_email
- [ ] Update_forum_role_membership
- [ ] Change_due_date
- [ ] Reset_due_date
- [ ] Show_unit_extensions
- [ ] Mark_student_can_skip_entrance_exam
- [ ] Start_certificate_generation
- [ ] Start_certificate_regeneration
- [ ] Certificate_exception_view
- [ ] Generate_certificate_exceptions
- [ ] Generate_bulk_certificate_exceptions
- [ ] Certificate_invalidation_view
- [x] https://github.com/openedx/edx-platform/issues/35085
### Tasks