Skip to content

Commit

Permalink
docs: mark view and url as unstable
Browse files Browse the repository at this point in the history
  • Loading branch information
rpenido committed Sep 13, 2024
1 parent 45f392c commit 8159ae6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions openedx/core/djangoapps/xblock/rest_api/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
URL configuration for the new XBlock API
"""
from django.urls import include, path, re_path

from . import views

# Note that the exact same API URLs are used in Studio and the LMS, but the API
Expand All @@ -20,6 +21,7 @@
# render one of this XBlock's views (e.g. student_view)
re_path(r'^view/(?P<view_name>[\w\-]+)/$', views.render_block_view),
# get the URL needed to call this XBlock's handlers
# NOTE: this endpoint is **unstable** and subject to changes in future

This comment has been minimized.

Copy link
@bradenmacdonald

bradenmacdonald Sep 13, 2024

Contributor

@rpenido This line is in the wrong place - should be below near "render one of this XBlock's views (e.g. student_view) for embedding in an iframe"

re_path(r'^handler_url/(?P<handler_name>[\w\-]+)/$', views.get_handler_url),
# call one of this block's handlers
re_path(
Expand Down
2 changes: 2 additions & 0 deletions openedx/core/djangoapps/xblock/rest_api/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ def get_handler_url(request, usage_key_str, handler_name):
the given XBlock handler.
The URL will expire but is guaranteed to be valid for a minimum of 2 days.
Unstable - may change after Sumac
"""
try:
usage_key = UsageKey.from_string(usage_key_str)
Expand Down

0 comments on commit 8159ae6

Please sign in to comment.