Skip to content

Update develop-an-integration-as-an-api-service.md#1918

Open
ChamaliSandamini wants to merge 4 commits into
wso2:PEfrom
ChamaliSandamini:patch-1
Open

Update develop-an-integration-as-an-api-service.md#1918
ChamaliSandamini wants to merge 4 commits into
wso2:PEfrom
ChamaliSandamini:patch-1

Conversation

@ChamaliSandamini

Copy link
Copy Markdown

The "Develop an integration as an API service" guide was missing Step 2: Deploy the integration component. The steps jumped from Step 1 (Create) directly to Step 2 (Test), skipping the deployment step entirely. Additionally, the step numbering jumped from Step 2 directly to Step 4 with no Step 3.

Changes made:

  • Added missing Step 2: Deploy the integration component with all sub-steps
  • Renamed the existing Step 2 (Test the integration) to Step 3

Description

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Type of change

  • Change is only applicable for Developer view
  • Change is only applicable for Platform Engineer view
  • Change is applicable for both Developer and Platform Engineer views

Testing

  • Change is tested in Developer view
  • Change is tested in Platform Engineer view

Related issues

List related issues here

The "Develop an integration as an API service" guide was missing Step 2: Deploy the integration component. The steps jumped from Step 1 (Create) directly to Step 2 (Test), skipping the deployment step entirely. Additionally, the step numbering jumped from Step 2 directly to Step 4 with no Step 3.

Changes made:
- Added missing Step 2: Deploy the integration component with all sub-steps
- Renamed the existing Step 2 (Test the integration) to Step 3
@CLAassistant

CLAassistant commented May 26, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented May 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@anuruddhal, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 56f4a50b-7258-47c2-a5ce-488b417872e9

📥 Commits

Reviewing files that changed from the base of the PR and between a31e766 and 7e0169e.

📒 Files selected for processing (1)
  • en/developer-docs/docs/develop-components/develop-integrations/develop-an-integration-as-an-api-service.md
📝 Walkthrough

Walkthrough

The API service integration development guide adds a new Step 2 section for deploying the integration component before the testing instructions. It also renumbers the “Observe the integration” heading from Step 4 to Step 3.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title names the updated document, which is directly related to the documentation-only change.
Description check ✅ Passed The description follows the template and explains the missing step and numbering fix.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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/developer-docs/docs/develop-components/develop-integrations/develop-an-integration-as-an-api-service.md`:
- Around line 45-55: The doc currently contradicts itself: Step 1 says "Create
and Deploy" performs deployment, while "Step 2: Deploy the integration
component" repeats deployment. Choose one clear workflow and update the text
accordingly: either change the Step 1 action text "Click Create and Deploy" to
"Click Create" (or "Create") and leave Step 2 as the single deploy flow, or keep
Step 1 as "Create and Deploy" and reword Step 2 to "Verify deployment / Redeploy
if needed" and change the bullets under "Step 2: Deploy the integration
component" to verification steps (e.g., open Deploy, view Build Area, confirm
Development card shows Deployment Status: Active). Apply the same resolution to
the repeated instance referenced in lines 60-62.
🪄 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: 177b6091-a68f-47af-8a43-f8d3985e18fa

📥 Commits

Reviewing files that changed from the base of the PR and between 905e96d and 4ea2a05.

📒 Files selected for processing (1)
  • en/developer-docs/docs/develop-components/develop-integrations/develop-an-integration-as-an-api-service.md

Removed redundant Step 2 deploy section since Step 1 already deploys via Create and Deploy. Renumbered remaining steps from 2 to 4
@anuruddhal

Copy link
Copy Markdown
Member

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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.

3 participants