Re: [PR] Adjustment external views [airflow]

[via GitHub]

bbovenzi commented on code in PR #51889:
URL: https://github.com/apache/airflow/pull/51889#discussion_r2155256883


##########
airflow-core/docs/administration-and-deployment/plugins.rst:
##########
@@ -195,18 +195,23 @@ definitions in Airflow.
     }
 
     # Creating a iframe view that will be rendered in the Airflow UI.
-    iframe_view_with_metadata = {
+    external_view_with_metadata = {
         "name": "Name of the Iframe View as displayed in the UI",
-        # Source URL of the iframe. This URL can be templated using context 
variables, depending on the location where the iframe is rendered
-        # the context variables available will be different, i.e a subset of 
(DAG_ID, RUN_ID, TASK_ID, MAP_INDEX)
-        "src": "https://example.com/{DAG_ID}/{RUN_ID}/{TASK_ID}";,
+        # Source URL of the external view. This URL can be templated using 
context variables, depending on the location where the external view is rendered
+        # the context variables available will be different, i.e a subset of 
(DAG_ID, RUN_ID, TASK_ID, MAP_INDEX).
+        "href": "https://example.com/{DAG_ID}/{RUN_ID}/{TASK_ID}";,
         # Destination of the iframe view. This is used to determine where the 
iframe will be loaded in the UI.
         # Supported locations are Literal["nav", "dag", "dag_run", "task", 
"task_instance"]
         "destination": "dag_run",
         # Optional icon, url to an svg file.
         "icon": "https://example.com/icon.svg";,
-        # Optional parameters, relative URL location when opening the iframe
-        "url_route": "/my_iframe_view",
+        # Optional dark icon for the dark theme, url to an svg file. If not 
provided, "icon" will be used for both light and dark themes.
+        "dark_mode_icon": "https://example.com/dark_icon.svg";,
+        # Optional parameters, relative URL location for the iframe rendering. 
If not provided, external view will be rendeded as an external link. Shouldn
+        # not contain a leading slash.
+        "url_route": "my_iframe_view",
+        # Optional category, only relevant for destination "nav". This is used 
to group the external links in the navigation bar.

Review Comment:
   ```suggestion
           # Optional category, only relevant for destination "nav". This is 
used to group the external links in the navigation bar. We will match the 
existing menus of ["browse", "docs", "admin", "user"] and if there's no match 
then create a new menu
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org