Skip to content

Add first draft of OEP-13 (API conventions) #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andy-armstrong merged 3 commits into from
Jul 25, 2017
Merged

Add first draft of OEP-13 (API conventions) #36

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6abc23a
Add first draft of OEP-13 (API conventions)
Dec 29, 2016
85daad7
fix a few points of feedback, and wrap lines where possible
Jan 3, 2017
f8c961f
withdrawing OEP-13
Jul 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions oeps/oep-0013.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 </oeps/oep-0013>` |
+---------------+-------------------------------------------+
| Title | Open edX web API conventions |
+---------------+-------------------------------------------+
| Last Modified | 2017-07-25 |
+---------------+-------------------------------------------+
| Author | Edward Fagin <eddie@edx.org> |
+---------------+-------------------------------------------+
| Arbiter | Andy Armstrong <andya@edx.org> |
+---------------+-------------------------------------------+
| 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.