Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
42de3d89
Commit
42de3d89
authored
May 21, 2014
by
Mark Hoeber
Committed by
Jonathan Piacenti
Aug 20, 2015
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
API Doc
parent
2de84b51
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
16 changed files
with
312 additions
and
0 deletions
+312
-0
docs/en_us/developers/source/api_manager/api_overview.rst
+52
-0
docs/en_us/developers/source/api_manager/api_testing.rst
+4
-0
docs/en_us/developers/source/api_manager/courses.rst
+0
-0
docs/en_us/developers/source/api_manager/groups.rst
+28
-0
docs/en_us/developers/source/api_manager/index.rst
+21
-0
docs/en_us/developers/source/api_manager/sessions.rst
+10
-0
docs/en_us/developers/source/api_manager/system.rst
+28
-0
docs/en_us/developers/source/api_manager/users.rst
+28
-0
docs/en_us/developers/source/rest_api/courses.rst
+102
-0
docs/en_us/developers/source/rest_api/groups.rst
+4
-0
docs/en_us/developers/source/rest_api/index.rst
+18
-0
docs/en_us/developers/source/rest_api/sessions.rst
+4
-0
docs/en_us/developers/source/rest_api/system.rst
+4
-0
docs/en_us/developers/source/rest_api/users.rst
+4
-0
docs/en_us/platform_api/source/conf.py
+5
-0
lms/djangoapps/api_manager/courses/views.py
+0
-0
No files found.
docs/en_us/developers/source/api_manager/api_overview.rst
0 → 100644
View file @
42de3d89
###############################
edX ReST API Resources
###############################
**********
Courses
**********
.. list-table::
:widths: 20 60
:header-rows: 1
* - Goal
- Resource
* - :ref:`Get a List of Courses`
- GET /api/courses
* - :ref:`Get Course Content`
- GET /api/courses/{course_id}/content?type=content_type
* - :ref:`Get Course Details`
- GET /api/courses/{course_id}?depth=n
* - :ref:`Get Content Details`
- GET /api/courses/{course_id}/content/{content_id}?type=content_type
* - :ref:`Get a Course Overview`
- GET /api/courses/{course_id}/overview?parse=true
* - :ref:`Get Course Updates`
- GET /api/courses/{course_id}/updates?parse=true
* - :ref:`Get Pages`
- GET /api/courses/{course_id}/static_tabs?detail=true
* - :ref:`Get Page Detail`
- GET /api/courses/{course_id}/static_tabs/{tab_id}
* - :ref:`Get Users in a Course`
- GET /api/courses/{course_id}/users
* - :ref:`Add a User to a Course`
- POST /api/courses/{course_id}/users
* - :ref:`Get Details of a User in a Course`
- POST /api/courses/{course_id}/users/{user_id}
* - :ref:`Unenroll a User from a Course`
- DELETE /api/courses/{course_id}/users/{user_id}
**********
Sessions
**********
.. list-table::
:widths: 20 60
:header-rows: 1
* - Goal
- Resource
* -
-
\ No newline at end of file
docs/en_us/developers/source/api_manager/api_testing.rst
0 → 100644
View file @
42de3d89
###############################
Testing the edX ReST API
###############################
docs/en_us/developers/source/api_manager/courses.rst
0 → 100644
View file @
42de3d89
This diff is collapsed.
Click to expand it.
docs/en_us/developers/source/api_manager/groups.rst
0 → 100644
View file @
42de3d89
###############################
Gruops API Module
###############################
.. module:: api_manager
The page contains docstrings for:
* `Groups Views`_
* `Groups Tests`_
**************
Groups Views
**************
.. automodule:: groups.views
:members:
:show-inheritance:
**************
Groups Tests
**************
.. automodule:: groups.tests
:members:
:show-inheritance:
\ No newline at end of file
docs/en_us/developers/source/api_manager/index.rst
0 → 100644
View file @
42de3d89
.. _API:
###############################
edX Platform ReST API
###############################
This section contains information on edX Platform ReST API.
View the following chapters to understand the ReST API, how to test it, and the
available endpoints.
.. toctree::
:maxdepth: 2
api_overview
api_testing
courses
groups
sessions
system
users
docs/en_us/developers/source/api_manager/sessions.rst
0 → 100644
View file @
42de3d89
###############################
Sessions API Module
###############################
.. module:: api_manager
The page contains docstrings for:
*
\ No newline at end of file
docs/en_us/developers/source/api_manager/system.rst
0 → 100644
View file @
42de3d89
###############################
System API Module
###############################
.. module:: api_manager
The page contains docstrings for:
* `System Views`_
* `System Tests`_
**************
System Views
**************
.. automodule:: system.views
:members:
:show-inheritance:
**************
System Tests
**************
.. automodule:: system.tests
:members:
:show-inheritance:
\ No newline at end of file
docs/en_us/developers/source/api_manager/users.rst
0 → 100644
View file @
42de3d89
###############################
Users API Module
###############################
.. module:: api_manager
The page contains docstrings for:
* `Users Views`_
* `Users Tests`_
**************
Users Views
**************
.. automodule:: users.views
:members:
:show-inheritance:
**************
Users Tests
**************
.. automodule:: users.tests
:members:
:show-inheritance:
\ No newline at end of file
docs/en_us/developers/source/rest_api/courses.rst
0 → 100644
View file @
42de3d89
###############################
ReST API for Courses
###############################
The edX ReST API for courses enables you to:
* `Get a List of Courses`_
* `Get Course Details`_
.. _Get a List of Courses:
**********************
Get a List of Courses
**********************
.. http:get:: /api/courses
Retrieves a list of courses in the edX Platform as a JSON representation (array) of the set of Course entities.
**Example request**:
.. sourcecode:: http
GET /api/courses
**Example response**:
.. sourcecode:: http
HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS
[
{
"category": "course",
"name": "edX Demonstration Course",
"uri": "http://localhost:8000/api/courses/edX/Open_DemoX/edx_demo_course",
"number": "Open_DemoX",
"due": null,
"org": "edX",
"id": "edX/Open_DemoX/edx_demo_course"
}
{
"category": "course",
"name": "Introduction to Computer Science",
"uri": "http://localhost:8000/api/courses/University/101/1_2014",
"number": "101",
"due": null,
"org": "edX University",
"id": "University/101/1_2014"
}
]
.. _Get Course Details:
**********************
Get Course Details
**********************
.. http:get:: /api/courses/{course ID}
Retrieves a list of courses in the edX Platform as a JSON representation (array) of the set of Course entities.
**Example request**:
.. sourcecode:: http
GET /api/courses
**Example response**:
.. sourcecode:: http
HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS
[
{
"category": "course",
"name": "edX Demonstration Course",
"uri": "http://localhost:8000/api/courses/edX/Open_DemoX/edx_demo_course",
"number": "Open_DemoX",
"due": null,
"org": "edX",
"id": "edX/Open_DemoX/edx_demo_course"
}
{
"category": "course",
"name": "Introduction to Computer Science",
"uri": "http://localhost:8000/api/courses/University/101/1_2014",
"number": "101",
"due": null,
"org": "edX University",
"id": "University/101/1_2014"
}
]
\ No newline at end of file
docs/en_us/developers/source/rest_api/groups.rst
0 → 100644
View file @
42de3d89
###############################
ReST API for Groups
###############################
docs/en_us/developers/source/rest_api/index.rst
0 → 100644
View file @
42de3d89
.. _ReST API:
###############################
ReST API
###############################
The edX ReST API is enabled by the :ref:`API Manager` module
.. toctree::
:maxdepth: 2
api_commands
testing_api
courses
groups
sessions
system
users
docs/en_us/developers/source/rest_api/sessions.rst
0 → 100644
View file @
42de3d89
###############################
ReST API for Sessions
###############################
\ No newline at end of file
docs/en_us/developers/source/rest_api/system.rst
0 → 100644
View file @
42de3d89
###############################
ReST API for System
###############################
\ No newline at end of file
docs/en_us/developers/source/rest_api/users.rst
0 → 100644
View file @
42de3d89
###############################
ReST API for Users
###############################
\ No newline at end of file
docs/en_us/platform_api/source/conf.py
View file @
42de3d89
...
...
@@ -222,6 +222,11 @@ sys.path.append(root / "common/lib/xmodule")
sys
.
path
.
append
(
root
/
"common/djangoapps"
)
sys
.
path
.
append
(
root
/
"lms/djangoapps"
)
sys
.
path
.
append
(
root
/
"openedx/core/djangoapps"
)
sys
.
path
.
append
(
root
/
"lms/djangoapps/mobile_api"
)
sys
.
path
.
append
(
root
/
"lms/djangoapps/mobile_api/course_info"
)
sys
.
path
.
append
(
root
/
"lms/djangoapps/mobile_api/users"
)
sys
.
path
.
append
(
root
/
"lms/djangoapps/mobile_api/video_outlines"
)
sys
.
path
.
append
(
root
/
"lms/djangoapps/api_manager"
)
sys
.
path
.
insert
(
0
,
...
...
lms/djangoapps/api_manager/courses/views.py
View file @
42de3d89
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment