apache/airflow

Publish JSON schema for airflow.cfg

Open

#42 850 ouverte le 9 oct. 2024

Voir sur GitHub
 (16 commentaires) (0 réactions) (0 assignés)Python (16 781 forks)batch import
area:dev-envgood first issuekind:feature

Métriques du dépôt

Stars
 (44 809 stars)
Métriques de merge PR
 (Merge moyen 7j 18h) (834 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Commencez par examiner le fichier YAML existant à l'emplacement airflow/config templates/config.yml. Envisagez d'utiliser un script Python avec des bibliothèques comme `json schema generator` ou `pyyaml` pour convertir la structure YAML en un schéma JSON. Publiez ensuite le schéma sur https://www.schemastore.org/json/. Vérifiez les commentaires de l'issue pour toute exigence spécifique concernant la génération ou le format du schéma.
Stack technique
python
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonJSON SchemaYAML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70