Repository navigation
Support OpenAPI 3.2 tag hierarchy in the API reference - #922
Conversation
Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR updates the OpenAPI sync transform to preserve OpenAPI 3.2 tag hierarchy metadata, updates Scalar, and refreshes the generated API reference. The transform change and Scalar pin look aligned with the stated goal, but the generated reference misclassifies one factory task lookup endpoint under the new Metrics group. No separate approved spec context was present, and the security pass did not find additional issues.
Concerns
getFactoryTaskByRunis now taggedfactory-metrics, which will place a task lookup endpoint under Metrics despite its route, summary, and response schema matching the adjacent factory task lookup endpoints.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /warp-agent-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
Restore the generated spec and derive download labels from the checked-in spec version.\n\nCo-Authored-By: Warp <agent@warp.dev>
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR updates the OpenAPI sync tooling to preserve OpenAPI 3.2 tag hierarchy metadata, prunes unused tags while retaining ancestors for referenced operations, updates the self-test coverage, reads the OpenAPI version into the llms.txt optional-link descriptions, and upgrades Scalar for hierarchy rendering. The spec-context attachment contains no approved or repository spec, and the reviewed changes do not introduce security concerns.
Concerns
- No blocking concerns found.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /warp-agent-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
Summary
The API reference uses Scalar 1.57.1, which ignores OpenAPI 3.2
tag.parentandtag.summaryfields and renders hierarchical tags as a flat list. This PR upgrades Scalar to 1.74.0 so hierarchies published by the normal release-candidate spec sync render as nested navigation.The checked-in OpenAPI spec remains unchanged from
origin/main. Release automation remains responsible for generated spec updates and reviewable sync PRs.Changes
summaryandparentin the manual sync tool, retain hierarchy ancestors for published operations, and prune unused leaf tags.developers/agent-api-openapi.yamlinstead of hardcoding it.Review guide
Start with the transform and self-test in
.agents/skills/sync-openapi-spec/scripts/sync_openapi.py, then review the dynamic version labels inastro.config.mjsand the Scalar version change insrc/pages/api.astro.developers/agent-api-openapi.yamlhas no diff. The release-candidate workflow will publish the hierarchy after the corresponding server changes are released.Validation
uv run --with pyyaml -- python3 .agents/skills/sync-openapi-spec/scripts/sync_openapi.py --mode self-testnpm run typechecknpm run test:heading-varsnpm run buildnpm run test:heading-tocsnpm run test:homepage-json-ldgit diff --checkThe screenshots below document that compatibility test. The pending OpenAPI 3.2 spec used for the test is not part of this PR.
Computer-use screenshots (2)
Scalar API reference sidebar with Factories expanded showing nested child groups Metrics, Scorers, Benchmarks (browser zoomed out)
Scalar API reference at 100% zoom with Factories expanded in sidebar showing endpoints and the nested Metrics child group
Unverified claims
None. Scalar behavior and the manual sync transform were verified with the pending OpenAPI 3.2 hierarchy.
Documentation risk
Risk: low
Rationale: Docs rendering and sync tooling only; no API specification content or API behavior changes.
Docs override: none
Co-Authored-By: Warp agent@warp.dev