Skip to content

Fix ConfigResponse types to handle nulls #50918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dstandish wants to merge 1 commit into from
Closed

Fix ConfigResponse types to handle nulls #50918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions airflow-core/src/airflow/api_fastapi/core_api/datamodels/ui/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
class ConfigResponse(BaseModel):
"""configuration serializer."""

page_size: int
auto_refresh_interval: int
hide_paused_dags_by_default: bool
page_size: int | None
Copy link
Member

@ashb ashb May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aren't these all meant to have defaults in the configs, so they shouldn't actually be null, right @pierrejeambrun

Copy link
Member

@pierrejeambrun pierrejeambrun May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this looks odd, I’ll take a look tomorrow.

auto_refresh_interval: int | None
hide_paused_dags_by_default: bool | None
instance_name: str
enable_swagger_ui: bool
Copy link
Collaborator

@sunank200 sunank200 May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about other attributes? Can they not be None?

Copy link
Contributor Author

@dstandish dstandish May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't know; but, webserver does not crash now.

require_confirmation_dag_change: bool
default_wrap: bool
require_confirmation_dag_change: bool | None
default_wrap: bool | None
audit_view_excluded_events: str
audit_view_included_events: str
test_connection: str
Expand Down
20 changes: 15 additions & 5 deletions airflow-core/src/airflow/api_fastapi/core_api/openapi/_private_ui.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -741,13 +741,19 @@ components:
ConfigResponse:
properties:
page_size:
type: integer
anyOf:
- type: integer
- type: 'null'
title: Page Size
auto_refresh_interval:
type: integer
anyOf:
- type: integer
- type: 'null'
title: Auto Refresh Interval
hide_paused_dags_by_default:
type: boolean
anyOf:
- type: boolean
- type: 'null'
title: Hide Paused Dags By Default
instance_name:
type: string
Expand All @@ -756,10 +762,14 @@ components:
type: boolean
title: Enable Swagger Ui
require_confirmation_dag_change:
type: boolean
anyOf:
- type: boolean
- type: 'null'
title: Require Confirmation Dag Change
default_wrap:
type: boolean
anyOf:
- type: boolean
- type: 'null'
title: Default Wrap
audit_view_excluded_events:
type: string
Expand Down
45 changes: 40 additions & 5 deletions airflow-core/src/airflow/ui/openapi-gen/requests/schemas.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6003,15 +6003,36 @@ export const $BaseNodeResponse = {
export const $ConfigResponse = {
properties: {
page_size: {
type: "integer",
anyOf: [
{
type: "integer",
},
{
type: "null",
},
],
title: "Page Size",
},
auto_refresh_interval: {
type: "integer",
anyOf: [
{
type: "integer",
},
{
type: "null",
},
],
title: "Auto Refresh Interval",
},
hide_paused_dags_by_default: {
type: "boolean",
anyOf: [
{
type: "boolean",
},
{
type: "null",
},
],
title: "Hide Paused Dags By Default",
},
instance_name: {
Expand All @@ -6023,11 +6044,25 @@ export const $ConfigResponse = {
title: "Enable Swagger Ui",
},
require_confirmation_dag_change: {
type: "boolean",
anyOf: [
{
type: "boolean",
},
{
type: "null",
},
],
title: "Require Confirmation Dag Change",
},
default_wrap: {
type: "boolean",
anyOf: [
{
type: "boolean",
},
{
type: "null",
},
],
title: "Default Wrap",
},
audit_view_excluded_events: {
Expand Down
10 changes: 5 additions & 5 deletions airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1496,13 +1496,13 @@ export type type =
* configuration serializer.
*/
export type ConfigResponse = {
page_size: number;
auto_refresh_interval: number;
hide_paused_dags_by_default: boolean;
page_size: number | null;
auto_refresh_interval: number | null;
hide_paused_dags_by_default: boolean | null;
instance_name: string;
enable_swagger_ui: boolean;
require_confirmation_dag_change: boolean;
default_wrap: boolean;
require_confirmation_dag_change: boolean | null;
default_wrap: boolean | null;
audit_view_excluded_events: string;
audit_view_included_events: string;
test_connection: string;
Expand Down
Loading