From 6650cffd7f4fefeb309efdceb1dec3713f458f52 Mon Sep 17 00:00:00 2001 From: Peter Desjardins Date: Thu, 3 Mar 2016 17:00:55 -0500 Subject: [PATCH] Fix typo in REST path. --- docs/en_us/platform_api/source/mobile/overview.rst | 14 +++++++------- docs/en_us/platform_api/source/read_me.rst | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/en_us/platform_api/source/mobile/overview.rst b/docs/en_us/platform_api/source/mobile/overview.rst index 11b40d7367..2bcaa6ed68 100644 --- a/docs/en_us/platform_api/source/mobile/overview.rst +++ b/docs/en_us/platform_api/source/mobile/overview.rst @@ -42,17 +42,17 @@ Mobile API User Resource - Method - Endpoint * - :ref:`Get details about a user` - - GET + - GET - /api/mobile/v0.5/users/{username} * - :ref:`Get course enrollments for a user` - - GET + - GET - /api/mobile/v0.5/users/{username}/course_enrollments/ * - :ref:`Get a user's 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` - - PATCH - - /api/mobile/v0.5/rs/{username}/course_status_info/{course_id} + - PATCH + - /api/mobile/v0.5/users/{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 - - /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 - /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 - - /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} diff --git a/docs/en_us/platform_api/source/read_me.rst b/docs/en_us/platform_api/source/read_me.rst index 78cfe1fd31..d737cd74a4 100644 --- a/docs/en_us/platform_api/source/read_me.rst +++ b/docs/en_us/platform_api/source/read_me.rst @@ -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