deepset-ai / haystack-json-schema

JSON Schema for validating Haystack Pipeline YAML files

JSON Schema for Haystack Pipeline YAML files

JSON Schema for validating Haystack Pipeline YAML files. These schemas are referenced in SchemaStore and allow IDEs to validate your Haystack Pipeline YAML files.

These schemas are all generated. PRs on this repo are not monitored and will be ignored. In case of problems, open an issue or discussion on the main Haystack repository.

Technical implementation:

• Schemas are generated using the official Haystack Docker images, matching the image tag with the release provided (or main for the unstable version).
• The workflow starts when this repo receives a disapatch event, either triggered from the haystack repository every time a new Docker image is published, or running the workflow manually.
• The desired Haystack version is contained in the dispatch event itself.
• The main schema is only updated when the Haystack release is main, allowing to update schemas for any release without disrupting the unstable version (this is handy to fix any issue we might have with the CI).