feat: add openapi.json to llms.txt optional links#250
Conversation
- Add scripts/generate-openapi-json.mjs to convert developers/agent-api-openapi.yaml → public/openapi.json at build time - Add prebuild and predev npm scripts so the JSON is always regenerated before any build or dev run - Gitignore public/openapi.json (generated artifact — Vercel will regenerate it via prebuild on every deploy) - Add server-rendered endpoint index to src/pages/api.astro so crawlers and AI agents can read API content without executing JavaScript Co-Authored-By: Oz <oz-agent@warp.dev>
Adds the JSON format of the Oz Agent API spec alongside the existing YAML entry in the starlightLlmsTxt optionalLinks config. Both will appear in the ## Optional section of docs.warp.dev/llms.txt, which gets inlined verbatim into warp.dev/llms.txt. Co-Authored-By: Oz <oz-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 |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR adds a generated JSON copy of the Oz Agent API OpenAPI spec, exposes it through the llms.txt optional links, and adds a server-rendered API endpoint index to the standalone API page for crawlers and agents. I did not find correctness, security, docs-structure, or spec-alignment issues that need changes.
Concerns
- No approved or repository spec context was provided, so there were no spec commitments to compare against.
- Local typecheck could not be completed in this sandbox because dependencies are not installed (
astrowas not available), but static review did not identify issues in the changed lines.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
2 participants
Adds the JSON format of the Oz Agent API spec to the
optionalLinksconfig inastro.config.mjs, alongside the existing YAML entry. Both will appear in the## Optionalsection ofdocs.warp.dev/llms.txt, which gets inlined intowarp.dev/llms.txtverbatim.Part of the AEO improvement work — helps agents and scanners discover the spec by name.
Co-Authored-By: Oz oz-agent@warp.dev