https://github.com/deepset-ai/haystack-json-schema
JSON Schema for validating Haystack Pipeline YAML files
https://github.com/deepset-ai/haystack-json-schema
Last synced: 3 months ago
JSON representation
JSON Schema for validating Haystack Pipeline YAML files
- Host: GitHub
- URL: https://github.com/deepset-ai/haystack-json-schema
- Owner: deepset-ai
- License: apache-2.0
- Created: 2022-10-26T12:50:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T15:52:49.000Z (8 months ago)
- Last Synced: 2025-02-16T02:25:08.384Z (4 months ago)
- Homepage:
- Size: 560 KB
- Stars: 2
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON Schema for Haystack Pipeline YAML files
JSON Schema for validating [Haystack](https://haystack.deepset.ai/) [Pipeline YAML files](https://docs.haystack.deepset.ai/docs/pipelines#yaml-file-definitions). These schemas are [referenced in SchemaStore](https://www.schemastore.org/json/) 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](https://github.com/deepset-ai/haystack).**
Technical implementation:
- Schemas are generated using the [official Haystack Docker images](https://hub.docker.com/r/deepset/haystack), 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).