/

Open edX REST API Conventions

Open edX REST API Conventions

Owned by Nimisha Asthagiri (Deactivated)

Last updated: Jul 31, 2023 by Sarina Canelake

9 min read

1 Background
2 High Level Requirements
3 Conventions
- 3.1 1. URL Naming
- 3.2 2. Identifying Resources
- 3.3 3. HTTP Verbs
  - 3.3.1 A note on HTTP PATCH
- 3.4 4. URL Parameters
- 3.5 5. Errors
- 3.6 6. Version
- 3.7 7. Pagination
- 3.8 8. Documentation
- 3.9 9. Discoverability
- 3.10 10. Multiple Formats
- 3.11 11. Authentication