Skip to content

feat: include externalDocs link in API markdown output#106

Merged
rsbh merged 1 commit into
mainfrom
worktree-api-md-external-docs
May 26, 2026
Merged

feat: include externalDocs link in API markdown output#106
rsbh merged 1 commit into
mainfrom
worktree-api-md-external-docs

Conversation

@rsbh
Copy link
Copy Markdown
Member

@rsbh rsbh commented May 25, 2026

Summary

  • Add external documentation link to auto-generated API markdown (.md endpoint)
  • When an OpenAPI operation has externalDocs.url, renders as: "Read more about this operation in the external documentation."
  • Uses externalDocs.description as link label when available, falls back to "external documentation"
  • Placed after operation description, before method/path line — helps AI agents and LLMs discover related docs

Test plan

  • Add externalDocs to an OpenAPI operation and verify .md endpoint includes the link
  • Verify operations without externalDocs are unaffected
  • Verify externalDocs.description is used as link text when present

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 25, 2026

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

Project Deployment Actions Updated (UTC)
chronicle Ready Ready Preview, Comment May 25, 2026 8:26am

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 25, 2026

Warning

Review limit reached

@rsbh, we couldn't start this review because you've used your available PR reviews for now.

Your plan includes 1 review of capacity. Refill in 25 minutes and 22 seconds.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more review capacity refills, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than trial, open-source, and free plans. In all cases, review capacity refills continuously over time.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: eec0b077-dee7-4867-99ef-bf1448cd3017

📥 Commits

Reviewing files that changed from the base of the PR and between f2a6ea5 and b3b5e62.

📒 Files selected for processing (1)
  • packages/chronicle/src/server/utils/api-markdown.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch worktree-api-md-external-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread packages/chronicle/src/server/utils/api-markdown.ts
@rsbh rsbh merged commit 6bd54a7 into main May 26, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants