Scope SQL Server docs to the 'next' API Gateway version only#315
Scope SQL Server docs to the 'next' API Gateway version only#315AnuGayan wants to merge 1 commit into
Conversation
The SQL Server deployment content was present in all three API Gateway versions after the version restructuring. Revert the five affected files in 1.0.0 and 1.1.0 to their pre-SQL-Server state, keeping the SQL Server docs only in the in-development 'next' version. Released versions are unchanged except for this content. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
📝 WalkthroughScoped the SQL Server deployment documentation back to the in-development Updated the affected deployment and configuration pages to describe PostgreSQL only, including high-availability, database configuration, overview, and storage/backend documentation. This also simplified related examples and wording to match the PostgreSQL-only flow. The WalkthroughDocumentation across both the 1.0.0 and 1.1.0 API Gateway versions was updated to standardize on PostgreSQL as the exclusive database backend for Gateway Controller deployments, removing all references to SQL Server as an alternative. Affected pages include overview docs, Kubernetes deployment mode overviews, high-availability production deployment guides, database-configuration guides, and storage-and-backends setup pages. Database-configuration guides were restructured to provide PostgreSQL-only steps for database creation, secret naming, chart configuration, and DSN setup, and a new Connection Pool Tuning section was added. The 1.0.0 storage-and-backends page also gained a new Redis section for distributed rate limiting. Sequence Diagram(s)sequenceDiagram
participant Replica01 as Gateway Controller Replica 01
participant Postgres as PostgreSQL Database
participant Replica02 as Gateway Controller Replica 02
Replica01->>Postgres: Store deployment state
Replica02->>Postgres: Read deployment state
Postgres-->>Replica02: Return shared configuration
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: 2
🧹 Nitpick comments (1)
en/docs/api-gateway/1.1.0/setup/storage-and-backends.md (1)
17-17: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueFix heading level to resolve lint warning and improve document structure.
The
### PostgreSQL (Gateway Controller)heading skips h2 after the h1 title, triggering an MD001 heading-increment warning. Change to## PostgreSQL (Gateway Controller)(and similarly## Redis (Gateway Runtime — Distributed Rate Limiting)at line 35) to maintain proper heading hierarchy.🤖 Prompt for 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. In `@en/docs/api-gateway/1.1.0/setup/storage-and-backends.md` at line 17, The document headings are skipping a level and triggering the markdown lint warning. Update the “PostgreSQL (Gateway Controller)” heading to the next proper level after the page title, and apply the same correction to “Redis (Gateway Runtime — Distributed Rate Limiting)” so the structure stays consistent. Use the existing heading text in the storage-and-backends doc and make sure both sections follow the same h1-to-h2 hierarchy.
🤖 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.0.0/setup/storage-and-backends.md`:
- Line 35: The Redis section heading under the storage/backends docs is skipping
a hierarchy level after the page title. Update the markdown heading in the Redis
subsection from the current level to the next higher section level so it matches
the surrounding document structure and keeps the page outline consistent.
- Line 17: The document outline has heading levels that skip directly from the
page title to third-level headings, which breaks hierarchy. Update the
PostgreSQL section heading and the Redis section heading in this markdown file
from third-level to second-level so they sit directly under the page title and
keep the structure consistent.
---
Nitpick comments:
In `@en/docs/api-gateway/1.1.0/setup/storage-and-backends.md`:
- Line 17: The document headings are skipping a level and triggering the
markdown lint warning. Update the “PostgreSQL (Gateway Controller)” heading to
the next proper level after the page title, and apply the same correction to
“Redis (Gateway Runtime — Distributed Rate Limiting)” so the structure stays
consistent. Use the existing heading text in the storage-and-backends doc and
make sure both sections follow the same h1-to-h2 hierarchy.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ef3f291e-cf4f-474d-b1f9-40a70fd45087
📒 Files selected for processing (10)
en/docs/api-gateway/1.0.0/deployment/deployment-modes/kubernetes/overview.mden/docs/api-gateway/1.0.0/deployment/high-availability-production-deployment.mden/docs/api-gateway/1.0.0/deployment/production-deployment/database-configuration.mden/docs/api-gateway/1.0.0/overview.mden/docs/api-gateway/1.0.0/setup/storage-and-backends.mden/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/overview.mden/docs/api-gateway/1.1.0/deployment/high-availability-production-deployment.mden/docs/api-gateway/1.1.0/deployment/production-deployment/database-configuration.mden/docs/api-gateway/1.1.0/overview.mden/docs/api-gateway/1.1.0/setup/storage-and-backends.md
| # Configuring External Storage and Backends | ||
|
|
||
| ### External Database (Gateway Controller) | ||
| ### PostgreSQL (Gateway Controller) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix heading level increment.
The ### PostgreSQL (Gateway Controller) heading skips a level after the page title. Change to ## PostgreSQL (Gateway Controller) to maintain proper document outline.
- ### PostgreSQL (Gateway Controller)
+ ## PostgreSQL (Gateway Controller)Likewise, the ### Redis (Gateway Runtime — Distributed Rate Limiting) heading at Line 35 should become ## Redis (Gateway Runtime — Distributed Rate Limiting).
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for 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.
In `@en/docs/api-gateway/1.0.0/setup/storage-and-backends.md` at line 17, The
document outline has heading levels that skip directly from the page title to
third-level headings, which breaks hierarchy. Update the PostgreSQL section
heading and the Redis section heading in this markdown file from third-level to
second-level so they sit directly under the page title and keep the structure
consistent.
Source: Linters/SAST tools
| For the full list of storage configuration options for both databases, refer to the [config template](https://github.com/wso2/api-platform/blob/main/gateway/configs/config-template.toml). | ||
| For the full list of PostgreSQL configuration options, refer to the [config template](https://github.com/wso2/api-platform/blob/main/gateway/configs/config-template.toml). | ||
|
|
||
| ### Redis (Gateway Runtime — Distributed Rate Limiting) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix heading level increment.
The ### Redis (Gateway Runtime — Distributed Rate Limiting) heading also skips a level after the page title. Change to ## Redis (Gateway Runtime — Distributed Rate Limiting).
- ### Redis (Gateway Runtime — Distributed Rate Limiting)
+ ## Redis (Gateway Runtime — Distributed Rate Limiting)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Redis (Gateway Runtime — Distributed Rate Limiting) | |
| ## Redis (Gateway Runtime — Distributed Rate Limiting) |
🤖 Prompt for 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.
In `@en/docs/api-gateway/1.0.0/setup/storage-and-backends.md` at line 35, The
Redis section heading under the storage/backends docs is skipping a hierarchy
level after the page title. Update the markdown heading in the Redis subsection
from the current level to the next higher section level so it matches the
surrounding document structure and keeps the page outline consistent.
Source: Linters/SAST tools
There was a problem hiding this comment.
Pull request overview
This PR scopes SQL Server deployment documentation to the in-development next version of API Gateway by reverting SQL Server-related content from the already-released 1.0.0 and 1.1.0 docs, keeping those versions PostgreSQL-only.
Changes:
- Removed SQL Server mentions and configuration examples from
api-gateway/1.0.0docs. - Removed SQL Server mentions and configuration examples from
api-gateway/1.1.0docs. - Updated related wording/metadata in the affected pages so the released versions describe PostgreSQL-only HA/production setups.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| en/docs/api-gateway/1.1.0/setup/storage-and-backends.md | Removes SQL Server references; keeps PostgreSQL + Redis guidance for 1.1.0. |
| en/docs/api-gateway/1.1.0/overview.md | Updates HA overview text to PostgreSQL-only for 1.1.0. |
| en/docs/api-gateway/1.1.0/deployment/production-deployment/database-configuration.md | Removes SQL Server path and leaves PostgreSQL-only DB configuration steps for 1.1.0 HA deployments. |
| en/docs/api-gateway/1.1.0/deployment/high-availability-production-deployment.md | Updates HA production deployment narrative to PostgreSQL-only for 1.1.0. |
| en/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/overview.md | Adjusts Kubernetes deployment mode overview bullet to PostgreSQL-only for 1.1.0. |
| en/docs/api-gateway/1.0.0/setup/storage-and-backends.md | Removes SQL Server references; keeps PostgreSQL + Redis guidance for 1.0.0. |
| en/docs/api-gateway/1.0.0/overview.md | Updates HA overview text to PostgreSQL-only for 1.0.0. |
| en/docs/api-gateway/1.0.0/deployment/production-deployment/database-configuration.md | Removes SQL Server path and leaves PostgreSQL-only DB configuration steps for 1.0.0 HA deployments. |
| en/docs/api-gateway/1.0.0/deployment/high-availability-production-deployment.md | Updates HA production deployment narrative to PostgreSQL-only for 1.0.0. |
| en/docs/api-gateway/1.0.0/deployment/deployment-modes/kubernetes/overview.md | Adjusts Kubernetes deployment mode overview bullet to PostgreSQL-only for 1.0.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Purpose
Scope the SQL Server deployment documentation (originally from #306) to the in-development
nextversion only for API Gateway.After the component-versioning restructuring (#314), the SQL Server content ended up duplicated into all three API Gateway versions (
1.0.0,1.1.0, andnext). SQL Server support is an upcoming-release feature, so it should appear only in thenextdocs, not in the already-released1.0.0/1.1.0.Changes
Reverts the five SQL-Server-affected files in
1.0.0and1.1.0to their pre-SQL-Server state, leavingnextuntouched:deployment/deployment-modes/kubernetes/overview.mddeployment/high-availability-production-deployment.mddeployment/production-deployment/database-configuration.mdoverview.mdsetup/storage-and-backends.mdThe revert restores exactly the pre-SQL-Server content (verified: the only remaining differences vs. the original are the relative-link-depth adjustments required by the version folder layout). No other content in the released versions changes.
Result
1.0.01.1.0nextTesting
cd en && python -m mkdocs build→ 0 warnings.🤖 Generated with Claude Code