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
66ae31f5
Commit
66ae31f5
authored
Mar 04, 2016
by
Peter Desjardins
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #11747 from edx/pdesjardins/DOC-2250
Fix minor typographical errors in the platform API documentation
parents
57d2d623
6650cffd
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
9 additions
and
11 deletions
+9
-11
docs/en_us/platform_api/source/mobile/overview.rst
+7
-8
docs/en_us/platform_api/source/read_me.rst
+2
-3
No files found.
docs/en_us/platform_api/source/mobile/overview.rst
View file @
66ae31f5
...
...
@@ -42,17 +42,17 @@ Mobile API User Resource
- Method
- Endpoint
* - :ref:`Get details about a user<Get User Details>`
- GET
- GET
- /api/mobile/v0.5/users/{username}
* - :ref:`Get course enrollments for a user<Get a User's Course Enrollments>`
- GET
- GET
- /api/mobile/v0.5/users/{username}/course_enrollments/
* - :ref:`Get a user's status in a course<Get or Change User Status in a Course>`
- GET
- GET
- /api/mobile/v0.5/users/{username}/course_status_info/{course_id}
* - :ref:`Change a user's status in a course<Get or Change User Status in a Course>`
- PATCH
- /api/mobile/v0.5/rs/{username}/course_status_info/{course_id}
- PATCH
- /api/mobile/v0.5/
use
rs/{username}/course_status_info/{course_id}
========================================
Mobile API Course Information Resource
...
...
@@ -67,7 +67,7 @@ Mobile API Course Information Resource
- Endpoint
* - :ref:`Get updates for a course<Get Course Updates>`
- GET
- /api/mobile/v0.5/course_info/{organization}/{course_number}/{course_run}/updates
- /api/mobile/v0.5/course_info/{organization}/{course_number}/{course_run}/updates
* - :ref:`Get handouts for a course<Get Course Handouts>`
- GET
- /api/mobile/v0.5/course_info/{organization}/{course_number}/{course_run}/handouts
...
...
@@ -88,4 +88,4 @@ Mobile API Video Outlines Resource
- /api/mobile/v0.5/video_outlines/courses/{organization}/{course_number}/{course_run}
* - :ref:`Get a video transcript<Get a Video Transcript>`
- GET
- /api/mobile/v0.5/video_outlines/transcripts/{organization}/{course_number}/{course_run}/{video ID}/{language code}
\ No newline at end of file
- /api/mobile/v0.5/video_outlines/transcripts/{organization}/{course_number}/{course_run}/{video ID}/{language code}
docs/en_us/platform_api/source/read_me.rst
View file @
66ae31f5
...
...
@@ -6,7 +6,7 @@ The edX Platform API documentation is created using RST_
files and Sphinx_. You, the user community, can help update and revise this
documentation project on GitHub:
https://github.com/edx/edx-platform/tree/master/docs/
platforms
_api/source
https://github.com/edx/edx-platform/tree/master/docs/
en_us/platform
_api/source
To suggest a revision, fork the project, make changes in your fork, and submit
a pull request back to the original project: this is known as the `GitHub Flow`_.
...
...
@@ -14,4 +14,4 @@ a pull request back to the original project: this is known as the `GitHub Flow`_
.. _Sphinx: http://sphinx-doc.org/
.. _LaTeX: http://www.latex-project.org/
.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser
.. _RST: http://docutils.sourceforge.net/rst.html
\ No newline at end of file
.. _RST: http://docutils.sourceforge.net/rst.html
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