Skip to content

Add /v0/run API docs#765

Merged
epompeii merged 1 commit intodevelfrom
u/ep/api-run-docs
Apr 4, 2026
Merged

Add /v0/run API docs#765
epompeii merged 1 commit intodevelfrom
u/ep/api-run-docs

Conversation

@epompeii
Copy link
Copy Markdown
Member

@epompeii epompeii commented Apr 4, 2026

This changeset adds /v0/run API docs, ie bencher run.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 4, 2026

🤖 Claude Code Review

PR: #765
Base: devel
Head: u/ep/api-run-docs
Commit: 6623d7397db28106c1004241552429e86e7e3d25


PR Review: Add Run API Documentation Pages

Commit: 6623d7397run_api

Summary

This PR adds documentation pages for the /v0/run API endpoint to the Bencher Console. It follows the existing pattern used by other API doc sections (organizations, projects, users, server).

Verdict: Looks Good

The changes are straightforward and consistent with the existing codebase patterns. All four new page files ([slug].astro, index.astro for both docs/ and [lang]/docs/) are near-identical copies of the organizations equivalent, just swapping Collection.api_organizationsCollection.api_run. The collection enum, content config, and menu updates are all minimal and correct.

Minor Issues

  1. Inconsistent indentation in ApiList.astro (lines 27-31): The new api_run entry uses 2-space indentation while the existing entries below it use tab indentation. This will likely be caught by Biome but worth fixing for consistency.

  2. Commit message is terse: run_api doesn't follow a conventional format (e.g., "Add Run API documentation pages"). Minor nit given this is a docs-only change.

No Issues Found

  • Pattern compliance: All new files match the existing API doc page structure exactly.
  • Collection wiring: collection.ts enum, ApiCollections array, collectionPath switch, and content.config.ts are all updated consistently.
  • Menu integration: Both ApiList.astro and DocsMenu.astro correctly add the run collection at the top of the API section with the 1 + apiRunCollection?.length counting pattern.
  • Content definition (run.mdx): Frontmatter matches the schema used by other API content files with path, method, headers, and cli fields.
  • No security concerns: Static page generation only, no dynamic user input handling.
  • No performance concerns: One additional getCollection() call at build time, negligible impact.

Model: claude-opus-4-6

@epompeii epompeii merged commit c98cc39 into devel Apr 4, 2026
67 of 70 checks passed
@epompeii epompeii deleted the u/ep/api-run-docs branch April 4, 2026 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant