diff --git a/oeps/oep-0013.rst b/oeps/oep-0013.rst new file mode 100644 index 000000000..b5c65502a --- /dev/null +++ b/oeps/oep-0013.rst @@ -0,0 +1,46 @@ +==================================== +OEP-13: Open edX web API conventions +==================================== + +.. This is the template to use when you start a new OEP. + ++---------------+-------------------------------------------+ +| OEP | :doc:`OEP-13 ` | ++---------------+-------------------------------------------+ +| Title | Open edX web API conventions | ++---------------+-------------------------------------------+ +| Last Modified | 2017-07-25 | ++---------------+-------------------------------------------+ +| Author | Edward Fagin | ++---------------+-------------------------------------------+ +| Arbiter | Andy Armstrong | ++---------------+-------------------------------------------+ +| Status | Withdrawn | ++---------------+-------------------------------------------+ +| Type | Best Practice | ++---------------+-------------------------------------------+ +| Created | 2016-12-29 | ++---------------+-------------------------------------------+ +| `Resolution` | | ++---------------+-------------------------------------------+ +| `Replaces` | | ++---------------+-------------------------------------------+ +| `Replaced-By` | | ++---------------+-------------------------------------------+ +| `References` | | ++---------------+-------------------------------------------+ + +Abstract +======== + +This document captures the conventions to be used for all Open edX web APIs. + +Update: moved to https://openedx.atlassian.net/wiki/display/OpenDev/edX+REST+API+Conventions. + +Motivation +========== + +The Open edX platform contains many extension points for third-party developers +that wish to integrate with the platform. We wish to approach a standard +methodology for API design in order to give developers more consistency in their +API client design, and to make our endpoint behaviors more predictable. \ No newline at end of file