Skip to content

docs: document local compare API #395

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

Closed
mikemikimike wants to merge 1 commit into from
Closed

docs: document local compare API #395

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
8 changes: 8 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,14 @@ 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.

The local compare API (`GET /api/compare/<failed_run_id>/<success_run_id>`) is
useful for scripts, dashboards, or automation checks that need the same
first-divergence JSON payload while the local UI is running:

```bash
curl http://127.0.0.1:3000/api/compare/<failed_run_id>/<success_run_id>
```

## Example Matrix

| Example | Use when | Extra services | Command |
Expand Down
9 changes: 9 additions & 0 deletions tests/test_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,15 @@ def test_readme_intro_is_browser_use_first_for_pypi_description():
assert "AI browser agents" not in intro


def test_examples_guide_documents_local_compare_api():
project_root = Path(__file__).resolve().parents[1]
examples = (project_root / "examples" / "README.md").read_text()

assert "local compare API" in examples
assert "scripts, dashboards, or automation checks" in examples
assert "GET /api/compare/<failed_run_id>/<success_run_id>" in examples


def test_social_preview_source_uses_browser_use_first_positioning():
project_root = Path(__file__).resolve().parents[1]
svg = (project_root / "docs" / "social-preview.svg").read_text()
Expand Down