Skip to content

docs: mention local compare API in examples guide#391

Open
kaizeenn wants to merge 1 commit into
aaronlab:mainfrom
kaizeenn:docs/issue-387-compare-api
Open

docs: mention local compare API in examples guide#391
kaizeenn wants to merge 1 commit into
aaronlab:mainfrom
kaizeenn:docs/issue-387-compare-api

Conversation

@kaizeenn
Copy link
Copy Markdown
Contributor

@kaizeenn kaizeenn commented May 21, 2026

Summary

  • add a short note in examples/README.md that scripts/dashboards can call GET /api/compare/<failed_run_id>/<success_run_id> while the local UI is running
  • keep it next to the existing browsertrace compare ... --json guidance
  • extend tests/test_metadata.py examples README coverage for the new API sentence

Verification

  • uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q (not run: uv is not available in this environment)
  • git diff --check

Closes #387

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: mention compare API in examples guide

1 participant