Skip to content

docs: add AI and LLM Gateway section and OpenAPI 3.2 support to README#3075

Merged
rrayst merged 2 commits into
masterfrom
docs/ai-llm-gateway-readme
Jul 10, 2026
Merged

docs: add AI and LLM Gateway section and OpenAPI 3.2 support to README#3075
rrayst merged 2 commits into
masterfrom
docs/ai-llm-gateway-readme

Conversation

@predic8

@predic8 predic8 commented Jul 9, 2026

Copy link
Copy Markdown
Member

Summary

Documents Membrane's AI capabilities and OpenAPI 3.2 support in the README.

  • New "AI and LLM Gateway" section with two subsections:
    • LLM GatewayllmGateway routing to Claude/OpenAI/Google, per-request input/output token limits, model allow-lists, and secure per-user API-key sharing via simpleStore. Example based on the ai/llm-gateway tutorial.
    • MCP ProtectionmcpProtection with top-down allow/deny tool rules, plus a diagram. Example based on the ai/mcp tutorial.
  • OpenAPI 3.2 subsection under OpenAPI Support, listing the constructs Membrane validates (QUERY method, additionalOperations, itemSchema, in: querystring, xml.nodeType), linked to the openapi/v32 tutorial.
  • Section numbering — top-level headings are numbered to match the table of contents, with all affected in-page anchors (TOC and inline cross-references) updated accordingly.
  • Adds docs/images/mcp-protection-api-gateway.png.

Notes

  • Examples are grounded in the existing tutorials under distribution/tutorials/ai/ and distribution/tutorials/openapi/v32/.
  • All internal anchors were validated after renumbering; external links were checked and resolve.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized the API Gateway documentation with updated numbered section headings and refreshed table of contents.
    • Expanded OpenAPI coverage with a new OpenAPI 3.2 section, including added capability points and a tutorial link.
    • Updated the features overview to include MCP Protection and refreshed the AI/LLM Gateway and legacy web services sections, along with renamed/additional feature sections.

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]>
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 12d70b61-40cf-4094-a2d1-402f9dcf32d7

📥 Commits

Reviewing files that changed from the base of the PR and between caba7b5 and ba38b34.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.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.

Changes

README Documentation Restructuring

Layer / File(s) Summary
Feature list and gateway content
README.md
Adds OpenAPI 3.2 details, updates MCP Protection and legacy web service links, and expands AI and LLM Gateway documentation.
Table of contents rewrite
README.md
Replaces the Content section with numbered entries matching the updated headings and anchors.
Section heading renumbering
README.md
Renumbers sections from 1 through 13, including scripting, security, traffic control, SOAP, operation, and community support.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: rrayst, russelmrcl, t-burch

Poem

A rabbit hops through docs anew,
OpenAPI blooms in version 3.2.
MCP links shine bright,
Headings line up right—
A tidy README greets the view! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main README documentation updates for AI and LLM Gateway and OpenAPI 3.2 support.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/ai-llm-gateway-readme

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between d6d92d4 and caba7b5.

⛔ Files ignored due to path filters (1)
  • docs/images/mcp-protection-api-gateway.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment thread README.md Outdated
rrayst
rrayst previously approved these changes Jul 9, 2026
…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.
@rrayst rrayst merged commit c19debd into master Jul 10, 2026
5 checks passed
@rrayst rrayst deleted the docs/ai-llm-gateway-readme branch July 10, 2026 08:51
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