I am creating this topic so that we can have good documentation for all REST API endpoints which are currently available in the open edX platform.
Where can I find the REST API endpoint for user creation?
I have seen this question very often on the discussion forum and on the slack channels. And yes, we have an endpoint for this.
Normally when anyone lookup for the API for open edX they (or me) end up with this link: https://courses.edx.org/api-docs/. This link has APIs listed but some of the endpoints are missing (for example
The foundation for the API documentation was laid by @nedbat
I have gone through this PR which was merged previously but in
open-release/juniper.master some of the changes made with this PR are removed (Don’t know why!).
In the last, I would say that it will be nice if we can have all the REST API endpoints under one roof (centralized).
I think we can start like this:
- Create new doc which will have endpoint, method, description (if we have), codebase location
- By codebase location, developers or maintainers will be able to get the required body parameters
- Then gradually we can add the body parameters and can go on if everything goes well
People, please suggest if you have any good ideas about this.