Skip to content

Document Platform Gateway registration and deployment - #11784

Open
YasasRangika wants to merge 3 commits into
wso2:masterfrom
YasasRangika:yasas-docs-apim-470-master
Open

Document Platform Gateway registration and deployment#11784
YasasRangika wants to merge 3 commits into
wso2:masterfrom
YasasRangika:yasas-docs-apim-470-master

Conversation

@YasasRangika

Copy link
Copy Markdown
Contributor

Description

  • Renamed the page to Gateway Registration and Deployment (gateway-registration-and-deployment.md).
  • Added an Overview section explaining the two registration modes: Admin Portal (manual) and Automated Gateway Registration (declarative via deployment.toml).
  • Create a Platform Gateway in the Admin Portal is now a brief pointer to the existing walkthrough in Getting Started (#create-a-platform-gateway-in-the-admin-portal), instead of duplicating it.

Comment addressed: #11780 (comment)

Screenshot

screencapture-127-0-0-1-8000-en-4-7-0-api-gateway-platform-gateway-gateway-registration-and-deployment-2026-08-13-10_59_47

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 3900680b-9072-4bc6-8569-cb2734fb801f

📥 Commits

Reviewing files that changed from the base of the PR and between 36629fb and 1ef78d4.

📒 Files selected for processing (2)
  • en/docs/api-gateway/platform-gateway/getting-started.md
  • en/mkdocs.yml

📝 Walkthrough

Summary

  • Renamed the guide to Gateway Registration and Deployment.
  • Added an overview of Admin Portal and automated registration methods.
  • Updated the guide structure for gateway creation, configuration, and startup.
  • Documented the subscription-less Platform Gateway invocation model.
  • Updated related documentation links and navigation to reference the new guide.

Walkthrough

The Gateway Registration and Deployment guide now covers Admin Portal and automated registration. It adds Admin Portal setup guidance, renames the automated registration section, and changes the gateway startup heading level. Platform Gateway guides now document policy-controlled, subscription-less API access and link to the consolidated registration guide. Navigation points to the updated guide.

Suggested reviewers: chamilaadhi, tharikagithub

Merge Risk: ⚪ Minimal · up to 1ef78

This documentation-only change updates Gateway registration guidance and navigation without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the main changes and includes a screenshot, but it omits most required template sections and supporting details. Complete the required sections, including Purpose, Goals, Approach, release note, testing, security checks, documentation, and related impacts.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation change: documenting Platform Gateway registration and deployment.
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

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.

@YasasRangika

Copy link
Copy Markdown
Contributor Author

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.

1 participant