Skip to content

Link OpenAPI spec from llms.txt and robots.txt#69

Merged
rachaelrenk merged 1 commit into
mainfrom
rachaelrenk/openapi-llms-robots
May 12, 2026
Merged

Link OpenAPI spec from llms.txt and robots.txt#69
rachaelrenk merged 1 commit into
mainfrom
rachaelrenk/openapi-llms-robots

Conversation

@rachaelrenk
Copy link
Copy Markdown
Contributor

Summary

Makes the Oz Agent API OpenAPI spec discoverable by AI agents, crawlers, and developer tooling by linking it from llms.txt and robots.txt.

Changes

  • src/pages/openapi.yaml.ts — New prerendered Astro endpoint serving the raw spec at /openapi.yaml (single source of truth, no file duplication)
  • astro.config.mjs — Added optionalLinks to the starlight-llms-txt plugin config so /llms.txt includes an ## Optional section with the spec URL
  • public/robots.txt — Added Llms-Txt directive (per llmstxt.org recommendation) and OpenAPI directive pointing to the spec

Context

Co-Authored-By: Oz oz-agent@warp.dev

- Add src/pages/openapi.yaml.ts endpoint to serve the raw spec at /openapi.yaml
- Add optionalLinks to starlight-llms-txt config so llms.txt references the spec
- Add Llms-Txt and OpenAPI directives to robots.txt

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 12, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 12, 2026 6:07pm

Request Review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 12, 2026

@rachaelrenk

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 /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds a prerendered /openapi.yaml endpoint backed by the existing OpenAPI source file, advertises it from llms.txt via optionalLinks, and exposes discovery links in robots.txt. I did not find correctness, documentation-structure, or security issues in the changed lines.

Concerns

  • None.

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

@rachaelrenk rachaelrenk merged commit 4ecda11 into main May 12, 2026
8 of 9 checks passed
@rachaelrenk rachaelrenk deleted the rachaelrenk/openapi-llms-robots branch May 12, 2026 18:13
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.

2 participants