docs(admin): clarify self-hosted and managed API scope#762
Merged
Conversation
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 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.
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.descriptionto describe the self-hosted vs managed deployment boundary in product-neutral terms. - Updated the
ApiKeyRequestschema 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
standalonelabel.Changes
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 --checkcargo run -p aisix-admin --bin dump-openapicargo test -p aisix-admin openapi --lib(20 passed)