course structure api removal from master (replaced by courses API)

[Dennis Jen]

Hi Open edXers:

The Course Structure API Version 0 has been deprecated for some time now and will be removed from the 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 (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.  As far as we know, edX Insights was the only consumer of the deprecated endpoints and has been cut over to the courses API.

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

[m.qais...@gmail.com]

Hi Dennis,

I am new to Open Edx platform, i want to use the 'Enrollment API' in my wordpress website. Can you please guide me how i can do.
simple steps to follow to get started with it.

1. From where i can download the API code ?
2. how to authenticate API with edx sever ?
3. is there any sample code for PHP for this API ?

THanks

[Nimisha Asthagiri]

Hi all,

It's been a while, but we have now finally removed the Course Structure API from the platform in this PR. 

As a reminder, the Course Blocks API should be used for retrieving Course structure data and the Grades API provides grades and grading policy information.  There is also an upcoming PR 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 has been deprecated for some time now and will be removed from the 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 (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.  As far as we know, edX Insights was the only consumer of the deprecated endpoints and has been cut over to the courses API.

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/msgid/edx-code/4a624a57-878d-4a4f-b7aa-cbbb4d85605e%40googlegroups.com.

[Jill Vogel]

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 link that Dennis shared above 404s, as do the Enrollment API and User API links from this old post Open edX ReST APIs.

--

Jill

@OpenCraft

To view this discussion on the web visit https://groups.google.com/d/msgid/edx-code/CACSOLjfWC2fQO-KBJEjfwjE%3DqjboU%3DJ%2Bcm%3D9%2BgC07Kgk35FgRw%40mail.gmail.com.

[Ned Batchelder]

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.

To view this discussion on the web visit https://groups.google.com/d/msgid/edx-code/CAMZ1At%2BQYbdq7Wi_Xuwpes08M%3DumLy3k%2BakyGEHqw38hpu7TxA%40mail.gmail.com.

[Nimisha Asthagiri]

If we really really need to, we can reinstate the User API and Enrollments API links.  However, there's no reason to put back the "deprecated Platform API" information.  That was causing another stream of confusion, which came in from external partners through the Enterprise team.

[Jill Vogel]

We're looking for a way to restore them.

Oh awesome, thank you!  It would be enough to just have something generic that points people to the right endpoints, and lets the Django REST framework docs do the rest.

Cheers,

--

Jill

@OpenCraft

[mdu...@edx.org]

Hi Jill,

We've updated the User and Enrollment API links to point to their respective views.py in GitHub. Hopefully this will be just a temporary solution as we look to have proper documentation later on.

Thanks,

Matt