The API docs were getting out of date because the complexity of building them from the edx-platform repo meant that they wouldn't build successfully any more. Perhaps too aggressively, we removed the ReadTheDocs projects rather than serve incorrect information. We're looking for a way to restore them.
--Ned. On Mon, Apr 23, 2018 at 5:17 AM, Jill Vogel <[email protected]> wrote: > Thank you for this information about the Course Structure API! > > But it looks like the API documentation has been removed from readthedocs > -- is this intentional? E.g. the Courses API V1 > <http://edx.readthedocs.io/projects/edx-platform-api/en/latest/courses/index.html> > link > that Dennis shared above 404s, as do the Enrollment API > <http://edx.readthedocs.io/projects/edx-platform-api/en/latest/enrollment/index.html> > and User API > <http://edx.readthedocs.io/projects/edx-platform-api/en/latest/user/index.html> > links from this old post Open edX ReST APIs > <https://open.edx.org/open-edx-rest-apis>. > > -- > Jill > @OpenCraft > <http://opencraft.com/> > > On Sat, Apr 21, 2018 at 10:47 PM, Nimisha Asthagiri <[email protected]> > wrote: > >> Hi all, >> >> It's been a while, but we have now finally removed the Course Structure >> API from the platform in this PR >> <https://github.com/edx/edx-platform/pull/17983>. >> >> As a reminder, the Course Blocks API >> <https://github.com/edx/edx-platform/blob/master/lms/djangoapps/course_api/blocks/views.py> >> should >> be used for retrieving Course structure data and the Grades API >> <https://github.com/edx/edx-platform/blob/master/lms/djangoapps/grades/api/urls.py> >> provides >> grades and grading policy information. There is also an upcoming PR >> <https://github.com/edx/edx-platform/pull/17602> that will create a v1 >> of the Grades API. >> >> Thanks, >> Nimisha >> >> On Tuesday, September 13, 2016 at 5:38:13 PM UTC+4, Dennis Jen wrote: >>>> >>>> Hi Open edXers: >>>> >>>> The Course Structure API Version 0 >>>> <http://edx.readthedocs.io/projects/edx-platform-api/en/latest/course_structure/index.html> >>>> has been deprecated for some time now and will be removed from the >>>> edx-platform <https://github.com/edx/edx-platform> codebase on the >>>> master branch and will not affect any Eucalyptus release, even future >>>> ones. Ficus will be the first Open edX release without the Course >>>> Structure API. The grading policy endpoint will remain for the time being >>>> and the tentative plan is for it to be incorporated into the grades api >>>> <https://github.com/edx/edx-platform/tree/master/lms/djangoapps/grades/api> >>>> (V0 and still under development). >>>> >>>> Specifically, the following endpoints will be removed: >>>> >>>> >>>> - >>>> >>>> api/course_structure/v0/course_structures/{course_id}/ >>>> - >>>> >>>> api/course_structure/v0/courses/{course_id} >>>> - >>>> >>>> api/course_structure/v0/courses/ >>>> >>>> >>>> The grading policy endpoint will remain for the time being, although >>>> still deprecated: >>>> >>>> >>>> - >>>> >>>> /api/course_structure/v0//grading_policies/ >>>> >>>> >>>> They can be replaced with similar endpoints on the Courses API V1 >>>> <http://edx.readthedocs.io/projects/edx-platform-api/en/latest/courses/index.html>. >>>> As far as we know, edX Insights >>>> <https://github.com/edx/edx-analytics-dashboard> was the only consumer >>>> of the deprecated endpoints and has been cut over to the courses API >>>> <https://github.com/edx/edx-analytics-dashboard/pull/550/>. >>>> >>>> We expect to have the course structure API removed the week of October >>>> 4th, 2016. If you’re impacted by this or need any help with the courses >>>> API, please let us know! >>>> >>>> Thanks, >>>> >>>> Dennis >>>> >>>> -- >>> You received this message because you are subscribed to the Google >>> Groups "General Open edX discussion" group. >>> To view this discussion on the web visit https://groups.google.com/d/ms >>> gid/edx-code/4a624a57-878d-4a4f-b7aa-cbbb4d85605e%40googlegroups.com >>> <https://groups.google.com/d/msgid/edx-code/4a624a57-878d-4a4f-b7aa-cbbb4d85605e%40googlegroups.com?utm_medium=email&utm_source=footer> >>> . >>> >> >> -- >> You received this message because you are subscribed to the Google Groups >> "General Open edX discussion" group. >> To view this discussion on the web visit https://groups.google.com/d/ms >> gid/edx-code/CACSOLjfWC2fQO-KBJEjfwjE%3DqjboU%3DJ%2Bcm%3D9% >> 2BgC07Kgk35FgRw%40mail.gmail.com >> <https://groups.google.com/d/msgid/edx-code/CACSOLjfWC2fQO-KBJEjfwjE%3DqjboU%3DJ%2Bcm%3D9%2BgC07Kgk35FgRw%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> > > -- > You received this message because you are subscribed to the Google Groups > "General Open edX discussion" group. > To view this discussion on the web visit https://groups.google.com/d/ > msgid/edx-code/CAMZ1At%2BQYbdq7Wi_Xuwpes08M%3DumLy3k% > 2BakyGEHqw38hpu7TxA%40mail.gmail.com > <https://groups.google.com/d/msgid/edx-code/CAMZ1At%2BQYbdq7Wi_Xuwpes08M%3DumLy3k%2BakyGEHqw38hpu7TxA%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > -- You received this message because you are subscribed to the Google Groups "General Open edX discussion" group. To view this discussion on the web visit https://groups.google.com/d/msgid/edx-code/CAGtJPNOT-xd31ZLoYu5nC_u9UujKM2zc0OM4rqp4DJy2zw2RqQ%40mail.gmail.com.
