Update API Gateway 1.1.0 quickstart - #433
Conversation
|
Warning Review limit reached
Next review available in: 32 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe 1.1.0 Gateway quick-start guide updates its date and reorganizes setup, API deployment, HTTP/HTTPS verification, port diagnostics, and shutdown instructions. ChangesGateway quick-start guide
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 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 `@en/docs/api-gateway/1.1.0/quick-start-guide.md`:
- Around line 56-60: Update the introductory sentence before the cd command to
use direct wording: “Change to the root directory of the Gateway distribution.”
Keep the command unchanged.
- Line 70: Update the “Verify that the Gateway Controller is healthy”
documentation text to use a single trailing colon instead of a duplicate colon.
- Around line 166-176: Replace the generic “Option 1” and “Option 2” headings in
the quick-start guide with descriptive headings that state the shutdown and data
behavior, such as “Stop the Gateway and keep data” and “Stop the Gateway and
remove data.”
- Around line 47-59: Remove the stale ${version} placeholder instruction near
the download and extraction commands, keeping the existing hardcoded 1.1.0 URL,
archive name, and directory path consistent.
- Around line 62-63: Update the changed sections of the quick-start guide to
follow WSO2 Markdown spacing: add blank lines around headings at Steps 2 and the
sections near lines 69, 78, 125, 166, and 175, add a blank line before the HTTPS
fenced code block, and remove trailing whitespace from the affected headings.
- Around line 44-54: Update the download and extraction procedure near the
distribution commands to support each listed platform: add platform-specific
Windows PowerShell, macOS, and Linux commands, or explicitly state the required
shell tools and provide an equivalent supported setup path for Windows. Keep the
existing versioned gateway URL and archive name consistent across all
instructions.
- Around line 134-137: Update the HTTPS self-signed certificate example to
explicitly state that the curl command using -k is only for localhost testing.
Add guidance that non-local HTTPS requests must omit -k and use --cacert with
the CA file or a trusted CA store.
- Around line 63-74: Update the Step 3 verification instructions after docker
compose up -d to wait for Gateway Controller readiness with a bounded retry loop
before issuing the health curl request. Stop retrying after a finite timeout and
preserve the existing health endpoint check once the service responds.
🪄 Autofix
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: ASSERTIVE
Plan: Pro Plus
Run ID: 49c7fdcc-721e-4492-8d8d-08e3c6cacc4e
📒 Files selected for processing (1)
en/docs/api-gateway/1.1.0/quick-start-guide.md
2 participants
Purpose
Please note the title.
Relates to #426 and previous PR that fixed 1.0.0 and 1.2.0 quickstarts.
Checklist
llms.txt(located aten/docs/llms.txt) is updated for AI readiness content.Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning