openedx.core.djangoapps.olx_rest_api package

Contents

openedx.core.djangoapps.olx_rest_api package#

Submodules#

openedx.core.djangoapps.olx_rest_api.api module#

Public Python API for the OLX REST API app

openedx.core.djangoapps.olx_rest_api.apps module#

olx_rest_api Django application initialization.

class openedx.core.djangoapps.olx_rest_api.apps.OlxRestApiAppConfig(app_name, app_module)#

Bases: AppConfig

Configuration for the olx_rest_api Django plugin application. See: openedx/edx-platform

name = 'openedx.core.djangoapps.olx_rest_api'#

plugin_app = {'url_config': {'cms.djangoapp': {'namespace': 'olx_rest_api'}}}#

verbose_name = 'Modulestore OLX REST API'#

openedx.core.djangoapps.olx_rest_api.test_views module#

openedx.core.djangoapps.olx_rest_api.urls module#

Studio URL configuration for openedx-olx-rest-api.

openedx.core.djangoapps.olx_rest_api.views module#

REST API for getting modulestore XBlocks as OLX

openedx.core.djangoapps.olx_rest_api.views.get_block_exportfs_file(request, *args, **kwargs)#: Serve a static file that got added to the XBlock’s export_fs during XBlock serialization. Typically these would be video transcript files.

openedx.core.djangoapps.olx_rest_api.views.get_block_olx(request, *args, **kwargs)#: Given a modulestore XBlock usage ID (block-v1:…), get its OLX and a list of any static asset files it uses. (There are other APIs for getting the OLX of openedx_content XBlocks.)

Module contents#