Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: ADR for exposing existing studio views through new JWT-enabled endpoints [BD-03] [BB-3965] (#27129)

Browse Source 
* docs: ADR for exposing existing studio views through new JWT-enabled endpoints

To allow MFEs to drive existing studio functionality, we need to expose that
functionality via REST APIs that can be used by MFEs. This ADR describes an
approach to do that.

* Update cms/djangoapps/contentstore/docs/decisions/0002-restful-studio-apis-for-MFE.rst

Co-authored-by: Farhaan Bukhsh <farhaan@opencraft.com>

* Update cms/djangoapps/contentstore/docs/decisions/0002-restful-studio-apis-for-MFE.rst

Co-authored-by: Kyle McCormick <kdmc@pm.me>

Co-authored-by: Farhaan Bukhsh <farhaan@opencraft.com>
Co-authored-by: Kyle McCormick <kdmc@pm.me>
This commit is contained in:
Kshitij Sobti
2021-05-04 13:53:38 +00:00
committed by GitHub
parent f41551ac65
commit 456432fddb
1 changed files with 64 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
cms/djangoapps/contentstore/docs/decisions/0002-restful-studio-apis-for-MFE.rst Normal file
View File

@@ -0,0 +1,64 @@
0002: Expose Existing Studio APIs for use in MFEs
=================================================
Status
------
Proposed
Context
-------
New MFEs which are in development, need to use studio APIs to interact with course tabs
and advanced course settings. Currently these endpoints don't have RESTful APIs that
can be used by MFEs using OAuth2 or similar.
Currently the course tabs page at `<studio_url>/tabs/<course_key>` has a single
`old-style functional view`_ that serves as both the view for the HTML page and the
JSON-based API for post requests. It also only supports session-based auth. While
this works well currently, for MFE consumption this is not ideal. The
`advanced course settings`_ view is in a similar situation.
.. _old-style functional view: https://github.com/edx/edx-platform/blob/49296005db7397e1a45e2864d93d39cf790a5fce/cms/djangoapps/contentstore/views/tabs.py#L27
.. _advanced course settings: https://github.com/edx/edx-platform/blob/49296005db7397e1a45e2864d93d39cf790a5fce/cms/djangoapps/contentstore/views/course.py#L1367
To avoid disrupting the existing studio views that might still be needed for the next
few releases, we need to maintain these existing views while also enabling MFEs to
perform operations currently only enabled by these views.
Decision
--------
We will expose the existing studio APIs under a new versioned endpoint. These
endpoints will support the new JWT/OAuth2 authentication mechanisms supported by
MFEs.
The existing views can be kept as-is, and only the authentication layer will be
changed. These APIs can be versioned as v0 since the format of these APIs can be
changed to better suit MFEs in future revisions, and might potentially be
organised differently in the future.
The first APIs to get this treatment are:
1. The tabs APIs currently available at `<studio_url>/tabs/<course_key>`
will now also be exposed at `<studio_url>/api/contentstore/v0/tabs/<course_key>`.
2. The advanced course settings APIs currently available at `<studio_url>/settings/advanced/<course_key>`
will now also be exposed at `<studio_url>/api/contentstore/v0/advanced_settings/<course_key>`
Consequences
------------
The `Course Authoring MFE`_, and other MFEs will be able to use these APIs making it
possible to port existing studio pages to their new UX in Course Authoring MFE and
elsewhere.
There are some adjustments that may be needed for these APIs soon, such as the
ability to use the tabs APIs from MFEs, currently GET is only supported with HTML
not JSON.
For the short-term though, these APIs will unblock progress on new MFE UX without
without needing to write entirely new APIs.
.. _Course Authoring MFE: https://github.com/edx/frontend-app-course-authoring/