Validating a pipeline configuration
You can validate a pipeline configuration at two stages: in your IDE (Integrated Development Environment), and on the server before you apply changes. Validating early helps you catch errors before they affect a running project.
Validating in the IDE
Qlik Talend Data Integration provides JSON schema definitions for all YAML configuration files. When you reference these schemas in your IDE, it can flag errors and offer suggestions as you type.
To enable schema validation in VS Code, install the YAML extension for VS Code (published by Red Hat). If you want to use another IDE, you can download schemas from Qlik - Open Source Software.
With schema validation active, VS Code flags syntax errors, unknown properties, and missing required fields in real time.
Validating on the server
Server-side validation checks the logical consistency of the configuration in addition to syntax. This validation runs automatically when you import or apply changes. You can also run it manually using the Validate API before you deploy.
Using the Validate-project-definitions API
The Validate-project-definitions API performs a dry-run import: it processes your configuration files and returns any validation errors without applying changes to the project. Use this in CI/CD pipelines to verify a configuration before triggering a deployment.
The API accepts a ZIP file in the same format (JSON or YAML) as an import and returns a list of errors. If there are no errors, the configuration is ready to deploy.
Understanding validation errors
Validation errors include the type of error and the path to the file or property where it was found. for more information, see Qlik.dev.