Discovery Api and Open api

Site Operators Site Operations Help
1

Hello

I ran devstack Open edX (https://github.com/edx/devstack#edx-devstack-) locally then checked the discovery API (http://localhost:18381/api-docs/) which provided the list of available APIs.

In the open API of edX (https://courses.edx.org/api-docs/), there is a list of APIs which I would require like bookmarks, certificates. which are not available under the discovery API.

Could anyone guide me on how to access all the endpoints as listed in open APIs(https://courses.edx.org/api-docs/), in devstack discovery API (http://localhost:18381/api-docs/) .

2

Hello and welcome to the community,
https://courses.edx.org/ is the address of edx.org’s LMS; not their discovery service.
Try this one instead: http://localhost:18000/api-docs/
Of course you must have the latest version of edX platform because this feature is under development yet.

3

thanks for the information.

The URL (http://localhost:18000/api-docs/) provided was what I was looking for.

4

I recently pulled the latest devstack code and checked the link (http://localhost:18000/api-docs/)
now it is showing error as failed to load API definition

image
image1120×626 24.7 KB

5

Better to create a new post I think. Also provide more information about your new devstack version and clues you can find under LMS logs.

6

sure will do as stated.

7

Hi @mahyard

Is that http://localhost:18000/api-docs/ provide the edX API? I would like to find the Discovery API, where should I look for? I am running native Koa.2 release.

Thank you

8

each service has its own api-docs under its dedicated address (port)
so you should be able to find discovery’s docs here:
http://localhost:18381/api-docs/

9

Thanks @mahyard

I found the bug. Because of lacking ‘partner’ for ‘example.com’ (I don’t know why, maybe I delete that partner by accident) so I got “Server Error (500)” when access to http://localhost:18381/api-docs/. Now is ok, I can find Discovery API as well as edX API.

HP.