Rebuild Guide API reference around canonical OpenAPI shape#301
Open
PunchTheDev wants to merge 1 commit into
Open
Rebuild Guide API reference around canonical OpenAPI shape#301PunchTheDev wants to merge 1 commit into
PunchTheDev wants to merge 1 commit into
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
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
Restructures
QuickstartGuideAPI reference section to match the canonical OpenAPI schema served by${API_BASE_URL}/openapi.json. Adds 7 missing endpoints, switches path params from generic{id}to canonical{round_id}/{spec_id}/{contributor}/{submission_id}, and groups by intent instead of dumping a flat 14-row table.Motivation
A first-timer scanning the table previously saw
{id}everywhere — Swagger uses{round_id}/{spec_id}/{submission_id}, so copy-pasted curls wouldn't drop into the try-it-out console without rewriting. The table was also missing several pedagogically important endpoints (POST /eval/previewfor scoring without recording,GET /submissions/{id}/stepfor fetching the STEP file, all/roundsvariants), and intent was implicit. Live OpenAPI audit confirmed 21 canonical paths; the Guide previously documented 14.Changes
QuickstartGuide.tsxL744–826: API reference rebuilt with 7 intent groups (Rounds / Specs / SOTA / Leaderboards / Submissions / Eval / Health). Path params canonicalized. Swagger/docslink promoted from buried footer-line into a top-of-section callout card with hover tooltip.GET /rounds— all rounds (past + active)GET /rounds/{round_id}— single round metadataGET /submissions/{submission_id}— single submission detailGET /submissions/{submission_id}/step— STEP file (3D viewer source)POST /eval/preview— score an agent against one spec without recording (body:{agent_code, spec_id})GET /health+GET /health/deep#explore) gains a↓ full endpoint tablecross-link before the curl block — closes the loop between the inline curl tutorial and the complete reference (step 281 cross-link pattern).○ ○ ○→● ● ●with rationale.Verification
Puppeteer at 1440×900 on
/guide#api:{id}generic path params remain${API_BASE_URL}/docs+ 129-char tooltipPuppeteer at 1440×900 on
/guide#explore:#apiwith text "full endpoint table ↓"0 new console errors (1 pre-existing 404 on a tile resource — unchanged baseline).