docs: document local compare API - #395
Closed
mikemikimike wants to merge 1 commit into
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refs #387
The examples guide already documents the
browsertrace compareCLI. This adds the local API endpoint so scripts, dashboards, and automation checks can retrieve the same first-divergence JSON while the local UI is running.Changes
GET /api/compare/<failed_run_id>/<success_run_id>recipe toexamples/README.md.Compatibility
Documentation and test-only changes; no runtime or server behavior changes.
Validation
$env:PYTHONUTF8='1'; python -m pytest tests/test_metadata.py -q— 401 passed, 1 skipped.git diff --check— passed.The repository-prescribed
uv run --python 3.11 --extra dev pytest ...command was attempted first, butuvstalled while downloading Python 3.11 in this environment. The equivalent installed Python test command passed with UTF-8 mode enabled because Windows otherwise defaulted to GBK when reading the repository's UTF-8 docs.