Skip to content

Docs: mention compare API in examples guide #393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Photon101 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: mention compare API in examples guide #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ good:
Use `browsertrace compare <failed_run_id> <success_run_id> --json` when a
script, CI check, or AI/coding-agent troubleshooting flow needs structured
comparison output.
While the local UI is running, scripts, dashboards, or automation checks can
also call `GET /api/compare/<failed_run_id>/<success_run_id>` for the same
first-divergence JSON payload.

## Example Matrix

Expand Down
3 changes: 3 additions & 0 deletions tests/test_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3208,6 +3208,9 @@ def test_examples_readme_includes_command_cheat_sheet():
assert "error: upload preview did not appear" in examples_readme
assert "`browsertrace compare <failed_run_id> <success_run_id> --json`" in examples_readme
assert "structured comparison output" in " ".join(examples_readme.split())
assert "`GET /api/compare/<failed_run_id>/<success_run_id>`" in examples_readme
assert "scripts, dashboards, or automation checks" in examples_readme
assert "same first-divergence JSON payload" in " ".join(examples_readme.split())
assert 'pip install "browsertrace[ui]"' in examples_readme
assert "hosted sharing" not in examples_readme

Expand Down