openedx / openedx/openedx-platform
Listing Instructor apis on Swagger
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Currently only few instructor apis are listed on swagger, we should register all the available apis on swagger for convenience.
- list apis on swagger
- add description for the api functionality
- share the api endpoint url
- add the payload or any other specifications
- add the example response structure
This is a sub issue for this main ticket
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 reviewing the existing instructor APIs already registered in Swagger and the main ticket #35057 to identify the complete API set and the relevant registration area. Done means all available instructor endpoints are listed with their functionality, URLs, payload or other specifications, and example response structures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100