Skip to content

docs(admin): clarify self-hosted and managed API scope#762

Merged
kayx23 merged 2 commits into
mainfrom
docs/admin-api-managed-terminology
Jul 14, 2026
Merged

docs(admin): clarify self-hosted and managed API scope#762
kayx23 merged 2 commits into
mainfrom
docs/admin-api-managed-terminology

Conversation

@kayx23

@kayx23 kayx23 commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarify the deployment boundary in the generated AISIX Admin API reference while retaining the established self-hosted gateway terminology.

Why

The current description says only AISIX Cloud does not expose the self-hosted Admin API listener. The same boundary applies to AISIX Cloud On-Premises because both managed products configure gateways through the AISIX managed control plane.

The AI Gateway docs use self-hosted gateway for direct operation through the local Admin API and etcd. AISIX Cloud On-Premises is the documentation label for the customer-hosted AISIX Cloud control-plane stack. Keeping those terms distinct avoids presenting shared managed behavior as Cloud-only without introducing a competing standalone label.

Changes

  • Retain the AISIX Admin API description as the self-hosted runtime management interface.
  • Explain that managed deployments configure gateways through the AISIX managed control plane.
  • Describe caller-key ownership fields as managed-control-plane data instead of Cloud-projected data.

This changes public OpenAPI descriptions only. It does not change API behavior or schemas.

Related terminology investigation: https://github.com/api7/docs/issues/1803
Related Cloud Admin API contract PR: https://github.com/api7/AISIX-Cloud/pull/1016
Related docs PR: https://github.com/api7/docs/pull/1822

Validation

  • git diff --check
  • cargo run -p aisix-admin --bin dump-openapi
  • cargo test -p aisix-admin openapi --lib (20 passed)

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
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.
E2e Test Quality Review ✅ Passed Docs-only OpenAPI wording update; no behavior/schema changes, so E2E coverage isn’t applicable and I found no correctness issues.
Security Check ✅ Passed Docs-only OpenAPI wording changes; no logging, auth, storage, or endpoint behavior changed, and no sensitive data exposure found.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the PR’s OpenAPI documentation changes about clarifying Admin API deployment scope.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/admin-api-managed-terminology

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.

@kayx23 kayx23 changed the title docs(admin): clarify standalone and managed API scope docs(admin): clarify self-hosted and managed API scope Jul 14, 2026
@kayx23 kayx23 requested a review from Copilot July 14, 2026 09:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the generated AISIX Admin API OpenAPI reference text to clarify that the Admin API is a self-hosted gateway management interface and that managed deployments configure gateways through the managed control plane instead of exposing the Admin API listener.

Changes:

  • Revised the OpenAPI info.description to describe the self-hosted vs managed deployment boundary in product-neutral terms.
  • Updated the ApiKeyRequest schema description to clarify that managed control plane ownership fields are not accepted by the self-hosted Admin API.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@kayx23 kayx23 merged commit 30829d6 into main Jul 14, 2026
13 checks passed
@kayx23 kayx23 deleted the docs/admin-api-managed-terminology branch July 14, 2026 14:52
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