Title: Open edX REST API Conventions  
Owner: Nimisha Asthagiri
Creator: Nimisha Asthagiri Dec 23, 2014
Last Changed by: Sarina Canelake Jul 31, 2023
Tiny Link: (useful for email) https://openedx.atlassian.net/wiki/x/pQIYAQ
Export As: Word · PDF  
Open edX Community (1)
    Page: API Architecture Landscape
Hierarchy
Children (3)
    Page: Optional Fields and API Versioning
    Page: Proposal: API collection format.
    Page: Proposal: Opt-in Public Url Subset
Labels
Global Labels (1)
Page Permissions
Page restrictions:
Time Editor  
Jul 31, 2023 19:30 Sarina Canelake View Changes
Mar 29, 2021 13:52 Kyle McCormick View Changes
Update documentation section to point to edx-api-doc-tools
Mar 29, 2021 13:27 Kyle McCormick View Changes
remove funny spacing post editor conversion
Mar 29, 2021 13:24 Kyle McCormick View Changes
Version published after converting to the new editor
Mar 29, 2021 13:24 Kyle McCormick  
Outgoing Links
External Links (30)
    https://github.com/edx/edx-platform/tree/master/openedx/cor…
    https://github.com/edx/edx-platform/tree/master/common/djan…
    pages.apigee.com/rs/apigee/images/api-design-ebook-2012-03.…
    https://openedx.atlassian.net/wiki/display/TNL/Team+API
    https://edx-api-doc-tools.readthedocs.io/en/latest/writing.…
    https://github.com/edx/edx-platform/tree/master/lms/djangoa…
    https://github.com/edx/edx-platform/blob/master/lms/djangoa…
    https://github.com/edx/edx-platform/blob/0ad27ed2fe0dd82ea6…
    https://dev.twitter.com/rest/public
    https://edx-api-doc-tools.readthedocs.io/en/latest/adding.h…
    https://developers.facebook.com/docs/graph-api/reference/v2…
    tools.ietf.org/html/rfc5789
    https://instagram.com/developer/
    https://tools.ietf.org/html/rfc7396
    tomchristie.github.io/rest-framework-2-docs/
    https://courses.edx.org/api-docs/
    https://github.com/edx/edx-platform/tree/master/lms/djangoa…
    www.w3.org/TR/NOTE-datetime
    https://developer.linkedin.com/docs/rest-api
    https://developer.github.com/v3/
    https://api.stackexchange.com/
    https://en.wikipedia.org/wiki/HATEOAS
    www.django-rest-framework.org/api-guide/pagination/#pagenum…
    tools.ietf.org/html/rfc6902
    https://openedx.atlassian.net/wiki/pages/createpage.action?…
    https://edx-api-doc-tools.readthedocs.io/en/latest/excludin…
    https://developers.google.com/apis-explorer
    https://developer.salesforce.com/docs/atlas.en-us.api_rest.…
    https://openedx.atlassian.net/wiki/spaces/AC/pages/18350757…
    https://github.com/edx/api-doc-tools
Architecture and Engineering (1)     Page: API Thoughts