Fix lint

Author: pierrejeambrun

airflow-core/docs/howto/custom-view-plugin.rst

@@ -38,8 +38,7 @@ In this object reference, the list of dictionaries with Middleware factories obj
 initialization parameters and some metadata information like the name are passed on.
 
 Using external_views in Airflow plugin, allows to register custom views that are rendered in iframes or external link
-in the Airflow UI. This is useful for integrating external applications or custom dashboards into the Airflow UI, or link to
-external resources from the nav bar.
+in the Airflow UI. This is useful for integrating external applications or custom dashboards into the Airflow UI.
 In this object reference, the list of dictionaries with the view name, iframe src (templatable), destination and
 optional parameters like the icon and url_route are passed on.
 

airflow-core/src/airflow/ui/openapi-gen/requests/schemas.gen.ts

@@ -3269,6 +3269,80 @@ export const $ExternalLogUrlResponse = {
     description: 'Response for the external log URL endpoint.'
 } as const;
 
+export const $ExternalViewResponse = {
+    properties: {
+        name: {
+            type: 'string',
+            title: 'Name'
+        },
+        href: {
+            type: 'string',
+            title: 'Href'
+        },
+        icon: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Icon'
+        },
+        dark_mode_icon: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Dark Mode Icon'
+        },
+        url_route: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Url Route'
+        },
+        category: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Category'
+        },
+        destination: {
+            anyOf: [
+                {
+                    type: 'string',
+                    enum: ['nav', 'dag', 'dag_run', 'task', 'task_instance']
+                },
+                {
+                    type: 'null'
+                }
+            ],
+            title: 'Destination'
+        }
+    },
+    additionalProperties: true,
+    type: 'object',
+    required: ['name', 'href'],
+    title: 'ExternalViewResponse',
+    description: 'Serializer for IFrame Plugin responses.'
+} as const;
+
 export const $ExtraLinkCollectionResponse = {
     properties: {
         extra_links: {
@@ -3399,58 +3473,6 @@ export const $HealthInfoResponse = {
     description: 'Health serializer for responses.'
 } as const;
 
-export const $IFrameViewsResponse = {
-    properties: {
-        name: {
-            type: 'string',
-            title: 'Name'
-        },
-        src: {
-            type: 'string',
-            title: 'Src'
-        },
-        icon: {
-            anyOf: [
-                {
-                    type: 'string'
-                },
-                {
-                    type: 'null'
-                }
-            ],
-            title: 'Icon'
-        },
-        url_route: {
-            anyOf: [
-                {
-                    type: 'string'
-                },
-                {
-                    type: 'null'
-                }
-            ],
-            title: 'Url Route'
-        },
-        destination: {
-            anyOf: [
-                {
-                    type: 'string',
-                    enum: ['nav', 'dag', 'dag_run', 'task', 'task_instance']
-                },
-                {
-                    type: 'null'
-                }
-            ],
-            title: 'Destination'
-        }
-    },
-    additionalProperties: true,
-    type: 'object',
-    required: ['name', 'src'],
-    title: 'IFrameViewsResponse',
-    description: 'Serializer for IFrame Plugin responses.'
-} as const;
-
 export const $ImportErrorCollectionResponse = {
     properties: {
         import_errors: {
@@ -3830,12 +3852,13 @@ export const $PluginResponse = {
             type: 'array',
             title: 'Fastapi Root Middlewares'
         },
-        iframe_views: {
+        external_views: {
             items: {
-                '$ref': '#/components/schemas/IFrameViewsResponse'
+                '$ref': '#/components/schemas/ExternalViewResponse'
             },
             type: 'array',
-            title: 'Iframe Views'
+            title: 'External Views',
+            description: "Aggregate all external views. Both 'external_views' and 'appbuilder_menu_items' are included here."
         },
         appbuilder_views: {
             items: {
@@ -3849,7 +3872,8 @@ export const $PluginResponse = {
                 '$ref': '#/components/schemas/AppBuilderMenuItemResponse'
             },
             type: 'array',
-            title: 'Appbuilder Menu Items'
+            title: 'Appbuilder Menu Items',
+            deprecated: true
         },
         global_operator_extra_links: {
             items: {
@@ -3885,7 +3909,7 @@ export const $PluginResponse = {
         }
     },
     type: 'object',
-    required: ['name', 'macros', 'flask_blueprints', 'fastapi_apps', 'fastapi_root_middlewares', 'iframe_views', 'appbuilder_views', 'appbuilder_menu_items', 'global_operator_extra_links', 'operator_extra_links', 'source', 'listeners', 'timetables'],
+    required: ['name', 'macros', 'flask_blueprints', 'fastapi_apps', 'fastapi_root_middlewares', 'external_views', 'appbuilder_views', 'appbuilder_menu_items', 'global_operator_extra_links', 'operator_extra_links', 'source', 'listeners', 'timetables'],
     title: 'PluginResponse',
     description: 'Plugin serializer.'
 } as const;

airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts

@@ -871,6 +871,20 @@ export type ExternalLogUrlResponse = {
     url: string;
 };
 
+/**
+ * Serializer for IFrame Plugin responses.
+ */
+export type ExternalViewResponse = {
+    name: string;
+    href: string;
+    icon?: string | null;
+    dark_mode_icon?: string | null;
+    url_route?: string | null;
+    category?: string | null;
+    destination?: 'nav' | 'dag' | 'dag_run' | 'task' | 'task_instance' | null;
+    [key: string]: unknown | string;
+};
+
 /**
  * Extra Links Response.
  */
@@ -923,18 +937,6 @@ export type HealthInfoResponse = {
     dag_processor?: DagProcessorInfoResponse | null;
 };
 
-/**
- * Serializer for IFrame Plugin responses.
- */
-export type IFrameViewsResponse = {
-    name: string;
-    src: string;
-    icon?: string | null;
-    url_route?: string | null;
-    destination?: 'nav' | 'dag' | 'dag_run' | 'task' | 'task_instance' | null;
-    [key: string]: unknown | string;
-};
-
 /**
  * Import Error Collection Response.
  */
@@ -1034,8 +1036,14 @@ export type PluginResponse = {
     flask_blueprints: Array<(string)>;
     fastapi_apps: Array<FastAPIAppResponse>;
     fastapi_root_middlewares: Array<FastAPIRootMiddlewareResponse>;
-    iframe_views: Array<IFrameViewsResponse>;
+    /**
+     * Aggregate all external views. Both 'external_views' and 'appbuilder_menu_items' are included here.
+     */
+    external_views: Array<ExternalViewResponse>;
     appbuilder_views: Array<AppBuilderViewResponse>;
+    /**
+     * @deprecated
+     */
     appbuilder_menu_items: Array<AppBuilderMenuItemResponse>;
     global_operator_extra_links: Array<(string)>;
     operator_extra_links: Array<(string)>;