openedx / openedx/openedx-core
Ensure all REST APIs are typed and documented - Core, Content Libraries, XBlock v2
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 32
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 12
Description
All REST APIs in Open edX Core, Content Libraries REST API, and XBlock v2 REST API should be fully typed and documented using drf-spectacular per Platform ADR 0027: Standardize API Documentation & Schema Coverage
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 with docs/decisions/0027-standardize-api-documentation-and-schema-coverage.rst and review its drf-spectacular requirements. Inventory the REST APIs in Core, Content Libraries, and XBlock v2, then define coverage and typing checks for each area. Done means all identified APIs are typed and documented according to the ADR.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100