docs: add AI and LLM Gateway section and OpenAPI 3.2 support to README#3075
Conversation
Add a new "AI and LLM Gateway" section covering the llmGateway plugin (provider routing, per-request token limits, and secure API-key sharing via simpleStore) and mcpProtection (allow/deny tool rules), with examples drawn from the ai/llm-gateway and ai/mcp tutorials. Also document OpenAPI 3.2 support (QUERY method, additionalOperations, itemSchema, in: querystring, xml.nodeType) under OpenAPI Support, and number the top-level sections to match the table of contents (updating all affected anchors). Co-Authored-By: Claude Opus 4.8 <[email protected]>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughREADME.md is restructured with numbered sections, updated table-of-contents anchors, expanded OpenAPI 3.2 and AI gateway documentation, revised feature links, and renamed legacy web services and support sections. ChangesREADME Documentation Restructuring
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 199: The table of contents entry is out of sync with the actual section
heading, which is just “Support.” Update the TOC label in the README to match
the section title exactly, using the same wording as the final heading so the
anchor text remains consistent.
- Around line 128-132: The README feature heading is still using the old “AI
Gateway” label while the rest of the document uses “AI and LLM Gateway”; update
that heading to match the new terminology so the section title stays consistent.
Make the change in the markdown heading for the feature list and keep it aligned
with the TOC and detailed section wording.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 17420fbe-dd84-4cd2-bff9-955813fd6710
⛔ Files ignored due to path filters (1)
docs/images/mcp-protection-api-gateway.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
…ents Standardize section headings: "AI Gateway" updated to "AI and LLM Gateway" and "Support" to "Community and Enterprise Support," ensuring consistency with anchor links in the table of contents.
Summary
Documents Membrane's AI capabilities and OpenAPI 3.2 support in the README.
llmGatewayrouting to Claude/OpenAI/Google, per-request input/output token limits, model allow-lists, and secure per-user API-key sharing viasimpleStore. Example based on theai/llm-gatewaytutorial.mcpProtectionwith top-down allow/deny tool rules, plus a diagram. Example based on theai/mcptutorial.QUERYmethod,additionalOperations,itemSchema,in: querystring,xml.nodeType), linked to theopenapi/v32tutorial.docs/images/mcp-protection-api-gateway.png.Notes
distribution/tutorials/ai/anddistribution/tutorials/openapi/v32/.🤖 Generated with Claude Code
Summary by CodeRabbit