Suite YAML reference (pages format)
Tags: suite, yaml, pages, steps, dataset, selector, xpath
What it is
A reference guide to the suite.yaml structure so teams can standardize suite format and review rules.
Why it’s needed
- Consistency reduces maintenance and onboarding time.
- Standards help regulated teams apply review and approval policies.
- A reference reduces tribal knowledge.
Benefits
- Fewer errors when authoring suites.
- Clear conventions for actions and assertions.
- Easier integration with external tooling that reads YAML.
How to use it in WebSureQTool
Core concepts:
- Suite metadata (name, description)
- Pages/sections (logical grouping)
- Steps/actions (navigate/click/type/wait/assert)
- Optional dataset binding for placeholders
Example (simplified):
```yaml
name: Login smoke
pages:
- name: Login
steps:
- action: navigate
url: "${BASE_URL}/login"
- action: type
selector: "#username"
value: "${USER}"
- action: click
selector: "button[type=submit]"
- action: assert_text_contains
selector: "h1"
expected: "Welcome"
```
Tip: keep selectors stable and keep assertions explicit.