docs: mark view and url as unstable

openedx · Sep 13, 2024 · eb1a0f3 · eb1a0f3
1 parent 45f392c
commit eb1a0f3
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/openedx/core/djangoapps/xblock/rest_api/urls.py b/openedx/core/djangoapps/xblock/rest_api/urls.py
@@ -31,6 +31,7 @@
     ])),
     path('xblocks/v2/<str:usage_key_str>/', include([
         # render one of this XBlock's views (e.g. student_view) for embedding in an iframe
+        # NOTE: this endpoint is **unstable** and subject to changes after Sumac
         re_path(r'^embed/(?P<view_name>[\w\-]+)/$', views.embed_block_view),
     ])),
 ]
diff --git a/openedx/core/djangoapps/xblock/rest_api/views.py b/openedx/core/djangoapps/xblock/rest_api/views.py
@@ -99,6 +99,8 @@ def render_block_view(request, usage_key_str, view_name):
 def embed_block_view(request, usage_key_str, view_name):
     """
     Render the given XBlock in an <iframe>
+
+    Unstable - may change after Sumac
     """
     try:
         usage_key = UsageKey.from_string(usage_key_str)