YAML Support
How to programmatically manage tests using YAML
YAML Test Management
Revyl allows you to export and modify your tests programmatically using YAML configuration files. While creating new tests from scratch using YAML is not yet supported (coming soon!), you can export existing tests, modify them, and update them through our API endpoints.
Authentication
All API requests require authentication using your Revyl API key.
Variable | Required | Description |
---|---|---|
REVYL_API_KEY | Yes | API key for authentication. Get this from your settings page |
API Endpoints
Export Test Configuration
Export an existing test’s configuration as a YAML file.
Update Test Configuration
Update an existing test using a modified YAML configuration file.
Create Test From YAML
Create a new test from a provided YAML file. The input YAML should contain the test configuration without any id fields. This endpoint will generate UUID v4 for the test and for each task, insert the test into the database, and return the updated YAML content with generated id fields.
Example Input YAML:
Example Output YAML:
API Request Example:
Note: Ensure that the input YAML does not include any id fields; otherwise, the request will be rejected.
Coming Soon
- YAML templates and schemas
For running tests in CI/CD pipelines, please refer to our Github Actions documentation.