Add guide for gateway federation#305
Conversation
📝 WalkthroughAdded a new Gateway Federation documentation guide, “Discover APIs from AWS API Gateway.” It walks through the end-to-end workflow for integrating an AWS API Gateway REST API into WSO2 API Platform gateway federation via a third-party gateway: deploy an AWS REST API to a stage, create IAM credentials, register the third-party gateway in API Platform, run discovery to pull REST API metadata and create API references, validate the discovered APIs in Insights → Compliance, and publish them to the Developer Portal lifecycle so developers can discover and subscribe. The guide also includes an architecture overview, verification checklist, troubleshooting section, and next-step references. Updated WalkthroughAdds a new guide for discovering AWS API Gateway REST APIs through API Platform gateway federation. The guide covers AWS setup, IAM credential creation, Third Party Gateway registration, discovery, compliance review, publishing, verification, troubleshooting, and next steps. It also adds a Guides navigation entry for the new page. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 markdownlint-cli2 (0.22.1)en/docs/guides/gateway-federation/discover-apis-from-aws-api-gateway.mdmarkdownlint-cli2 wrapper config was not available before execution 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 (5)
en/docs/guides/gateway-federation/discover-apis-from-aws-api-gateway.md (5)
34-34: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winSpecify a language for the fenced code block.
The architecture diagram uses a fenced code block without a language specifier, which triggers markdownlint warning MD040. Add
textto satisfy the linter and maintain consistency.♻️ Proposed fix
-``` +```text🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md` at line 34, The fenced architecture diagram block is missing a language tag, which triggers the MD040 markdownlint warning. Update the diagram’s fenced block in the gateway-federation docs to use a language specifier, using the existing markdown fence around the diagram content and adding text so it matches the rest of the document.
84-86: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueVary the phrasing in successive numbered steps.
Steps 3–5 all begin with "Under," which reads repetitively. Consider rewording one step (e.g., "In the Choose an API type section, select...") for smoother flow.
🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md` around lines 84 - 86, The numbered setup steps in the gateway federation guide repeat the same “Under” phrasing, making the sequence feel repetitive. Reword one of the affected instruction lines in the API selection flow, such as the step that references API Details or API endpoint type, so the successive steps in the section read with varied phrasing while preserving the same actions.
20-20: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winHyphenate compound modifier "third-party" when it modifies a noun.
In prose, "third party" should be hyphenated as "third-party" when used attributively before a noun (e.g., "third-party gateway"). This occurs throughout the document. Keep UI labels verbatim (e.g., Third Party Gateway) but adjust running text for correctness.
🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md` at line 20, The guide text uses “third party” as an attributive modifier, which should be hyphenated throughout the prose. Update the running text in this document to use “third-party” before nouns, including the introductory sentence in the AWS API Gateway guide and any similar occurrences elsewhere, while leaving UI labels like “Third Party Gateway” unchanged.
156-180: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winStandardize hyphenation and capitalization for "third-party gateway" in prose.
In running text, use "third-party gateway" (hyphenated). Reserve "Third Party Gateway" for exact UI labels. Line 158 has inconsistent capitalization ("Third party gateway" — should be "third-party gateway" or "Third Party Gateway" if it's a proper noun).
🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md` around lines 156 - 180, Update the prose in the gateway registration section to use consistent hyphenation and capitalization for the concept of a third-party gateway. In the Step 3 heading/body around the gateway setup instructions, replace running-text uses like “Third party gateway” with “third-party gateway,” and keep “Third Party Gateway” only when referring to the exact UI tab or button labels in the API Platform Console. Use the surrounding Step 3 instructions and the “Add Third Party Gateway” label as the reference points for the wording.
163-163: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueAdjust UI label formatting for the tab name.
"Tab" should not be part of the bold UI label unless the tab itself is literally named "Third Party Tab". Use "Select the Third Party tab." or "Select Third Party." to match standard UI writing conventions.
🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md` at line 163, The UI label formatting in the AWS API Gateway guide needs to be corrected so “Tab” is not part of the bolded tab name unless that is the exact UI label. Update the wording around the “Third Party” tab in the affected doc to follow the standard convention used elsewhere, such as selecting the **Third Party** tab, and keep the phrasing consistent with other UI references in the same guide.
🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md`:
- Line 118: The numbered procedure has a duplicate step label, so update the
final item in the AWS API Gateway guide sequence to use the next unique number.
Adjust the step text for the Deploy action so the ordering in this list is
consistent, and keep the numbering aligned with the surrounding steps in the
same section.
- Around line 225-236: Step 5 currently jumps straight to Insights > Compliance
even though the user is still on the project overview after discovery. Update
the instructions in the gateway federation guide to first navigate to the
discovered API’s overview page, using the API name or equivalent selection step
in the surrounding flow, before opening Compliance. Keep the compliance check
tied to the API/component context by referencing the discovered API overview
step in this section.
---
Nitpick comments:
In `@en/docs/guides/gateway-federation/discover-apis-from-aws-api-gateway.md`:
- Line 34: The fenced architecture diagram block is missing a language tag,
which triggers the MD040 markdownlint warning. Update the diagram’s fenced block
in the gateway-federation docs to use a language specifier, using the existing
markdown fence around the diagram content and adding text so it matches the rest
of the document.
- Around line 84-86: The numbered setup steps in the gateway federation guide
repeat the same “Under” phrasing, making the sequence feel repetitive. Reword
one of the affected instruction lines in the API selection flow, such as the
step that references API Details or API endpoint type, so the successive steps
in the section read with varied phrasing while preserving the same actions.
- Line 20: The guide text uses “third party” as an attributive modifier, which
should be hyphenated throughout the prose. Update the running text in this
document to use “third-party” before nouns, including the introductory sentence
in the AWS API Gateway guide and any similar occurrences elsewhere, while
leaving UI labels like “Third Party Gateway” unchanged.
- Around line 156-180: Update the prose in the gateway registration section to
use consistent hyphenation and capitalization for the concept of a third-party
gateway. In the Step 3 heading/body around the gateway setup instructions,
replace running-text uses like “Third party gateway” with “third-party gateway,”
and keep “Third Party Gateway” only when referring to the exact UI tab or button
labels in the API Platform Console. Use the surrounding Step 3 instructions and
the “Add Third Party Gateway” label as the reference points for the wording.
- Line 163: The UI label formatting in the AWS API Gateway guide needs to be
corrected so “Tab” is not part of the bolded tab name unless that is the exact
UI label. Update the wording around the “Third Party” tab in the affected doc to
follow the standard convention used elsewhere, such as selecting the **Third
Party** tab, and keep the phrasing consistent with other UI references in the
same guide.
🪄 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: e958ba35-8aed-43f4-8e4a-961d5a20a94b
⛔ Files ignored due to path filters (8)
en/docs/assets/img/guides/gateway-federation/add-third-party-gateway.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/compliance-dashboard.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/create-api.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/created-api-list.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/discover-apis-from-gateways.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/discover-apis.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/publish-to-devportal.pngis excluded by!**/*.pngen/docs/assets/img/guides/gateway-federation/third-party-gateway-listing.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/docs/guides/gateway-federation/discover-apis-from-aws-api-gateway.mden/mkdocs.yml
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/guides/gateway-federation/discover-apis-from-aws-api-gateway.md`:
- Line 20: Update the wording in the AWS API Gateway discovery guide so the
compound modifier uses “third-party” consistently wherever it modifies “gateway”
or “gateways.” Fix the occurrences in the introductory paragraph and the later
reference near the end of the document, keeping the phrasing otherwise
unchanged.
- Line 20: The guide uses the unhyphenated compound modifier “third party
gateway” in the introduction and later reference, which should be written as
“third-party gateway” when modifying “gateway.” Update both occurrences in the
AWS API Gateway discovery guide so the wording is consistent and grammatically
correct, using the same terminology wherever the gateway is described.
🪄 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: e5ceda9a-10df-48ff-924f-d27e7bce46ef
📒 Files selected for processing (1)
en/docs/guides/gateway-federation/discover-apis-from-aws-api-gateway.md
1 participant
Purpose
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