apache/airflow

Publish JSON schema for airflow.cfg

Open

#42,850 opened on Oct 9, 2024

View on GitHub
 (16 comments) (0 reactions) (0 assignees)Python (16,781 forks)batch import
area:dev-envgood first issuekind:feature

Repository metrics

Stars
 (44,809 stars)
PR merge metrics
 (Avg merge 7d 18h) (834 merged PRs in 30d)

Description

Description

There is already a good structured YAML file providing metadata about all valid configuration options in airflow.cfg: airflow/config_templates/config.yml.

I think publishing the same data as a JSON schema and eventually to https://www.schemastore.org/json/ could be very useful.

Use case/motivation

  • People could use extensions like Even Better TOML with their IDE to benefit from validation and powerful auto-completion while editing airflow.cfg
  • It would be easy to leverage pre-commit hooks or other CI tools to catch mistakes in the config file.

Airflow won't complain if the configuration file contains a typo or a non-existent configuration key making it easy to make mistakes. It could also make it easier to catch invalid values earlier.

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor guide

Research direction
Review the existing config.yml in airflow/config templates/config.yml and create a JSON schema that mirrors its structure. Validate the schema against sample airflow.cfg files.
Tech stack
python
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonJSON SchemaYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70