Add API Management documents to WSO2 Cloud - Integration Platform#570
Merged
Conversation
itsvishwa
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (13)
📒 Files selected for processing (7)
👮 Files not reviewed due to content moderation or server errors (7)
📝 Walkthrough
✨ 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 |
Broken links, images & orphan pages
Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by Summary
Broken links & imagesIntroduced by this PRNo new broken link(s)/image(s) introduced by this PR. ✅ Already on
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new API Management documentation section to the WSO2 Cloud – Integration Platform docs, and wires it into the Docusaurus sidebar under manage/cloud/api-management.
Changes:
- Adds an API Management category to
en/sidebars.tswith an overview page, feature pages, and a “Consuming APIs” subsection. - Introduces new API management docs covering overview, lifecycle management, security schemes, rate limiting, and API consumption guides (API Key and OAuth2).
Reviewed changes
Copilot reviewed 7 out of 20 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| en/sidebars.ts | Adds the “API Management” sidebar category and links to the new docs. |
| en/docs/manage/cloud/api-management/overview.md | New landing page describing API management capabilities and linking to subtopics. |
| en/docs/manage/cloud/api-management/lifecycle-management.md | New guide describing lifecycle states and how to transition them in the console. |
| en/docs/manage/cloud/api-management/api-security.md | New guide describing API Key/OAuth2 security schemes and configuration steps. |
| en/docs/manage/cloud/api-management/api-rate-limiting.md | New guide describing rate limiting setup and response headers. |
| en/docs/manage/cloud/api-management/consuming-apis/consuming-an-api-secured-with-an-api-key.md | New step-by-step guide for consuming API Key secured APIs via the Developer Portal. |
| en/docs/manage/cloud/api-management/consuming-apis/consuming-an-api-secured-with-oauth2.md | New step-by-step guide for consuming OAuth2 secured APIs via the Developer Portal. |
Comment on lines
+23
to
+25
| 4. In the integration **Overview** page, on the right side, click the **Developer Portal** icon. This will open the Developer Portal for the selected API. | ||
|  | ||
| 5. In the Developer Portal, click **Subscribe** to subscribe the API to an application. |
Comment on lines
+27
to
+29
| 7. Once the application is created, click **Subscribe** to complete the subscription process. | ||
|  | ||
| 8. In the left navigation menu, click **Applications** and select your application. |
Comment on lines
+32
to
+34
| 11. Enter a name for the API Key in the **API Key Name** field and click **Generate** to generate the API Key. | ||
|  | ||
|
|
Comment on lines
+23
to
+25
| 4. In the integration **Overview** page, on the right side, click the **Developer Portal** icon. This will open the Developer Portal for the selected API. | ||
|  | ||
| 5. In the Developer Portal, click **Subscribe** to subscribe the API to an application. |
Comment on lines
+27
to
+29
| 7. Once the application is created, click **Subscribe** to complete the subscription process. | ||
|  | ||
| 8. In the left navigation menu, click **Applications** and select your application. |
Comment on lines
+33
to
+35
| 12. To test the API, click **Generate** under the **Token** subsection. This will generate an access token using the OAuth2 client credentials flow. | ||
|  | ||
|
|
Comment on lines
+30
to
+32
| 4. In the integration **Overview** page, on the right side, click **Configure Security**. | ||
|  | ||
| 5. In the **Configure Security** pane, select the **Security Scheme** you want to use (API Key or OAuth2). |
Comment on lines
+34
to
+37
| - With the **API Key** scheme, you can select Resource Level security for the API. By default, security is applied at the API level. | ||
|  | ||
| - With the **OAuth2** scheme, in addition to Resource Level security configurations, you can also configure permissions for the API. You can select from the available scopes or create new ones, and then assign them to each resource. | ||
|  |
pcnfernando
approved these changes
Jul 2, 2026
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.
Purpose
Adding the API Management documentation into the WSO2 Cloud - Integration Platform doc space under
manage/cloud/api-managementResolves https://github.com/wso2-enterprise/integration-engineering/issues/1827