docs: add Connector Tool documentation under Integration Tools by vishwajayawickrama · Pull Request #552 · wso2/docs-integrator

vishwajayawickrama · 2026-06-23T02:49:36Z

Purpose

Document the bal connector tool to help developers discover and learn how to use it for automating production-ready Ballerina connector generation from OpenAPI specifications.

Approach

Created a new documentation page following the pattern of existing integration tools:

New doc: en/docs/develop/tools/integration-tools/connector-tool.md covering the 5-stage pipeline, command reference, and workflow examples
Updated sidebar navigation in en/sidebars.ts
Added entry to tools overview in en/docs/develop/tools/tools.md
Marked as pre-release with inline badge

Release note

Added comprehensive documentation for the Connector Tool (bal connector), enabling developers to generate production-ready Ballerina connectors from OpenAPI specifications using an AI-assisted pipeline.

Documentation

Documentation added: en/docs/develop/tools/integration-tools/connector-tool.md

Screenshots

localhost_3000_develop_tools_integration-tools_connector-tool

localhost_3000_develop_tools_integration-tools_connector-tool (1)

Summary by CodeRabbit

Documentation
- Added a new guide for the bal connector tool, including prerequisites, invocation, interactive and stage-skipping options, and connector update workflow.
- Documented the AI-assisted generation process (from OpenAPI sanitization to generated client, tests, examples, and README).
- Updated the Tools overview and Docusaurus navigation/sidebar to include the new Connector Tool entry alongside other integration tools.

Add comprehensive documentation for the `bal connector` tool, an AI-assisted CLI tool that automates connector generation from OpenAPI specifications. The documentation covers: - Full OpenAPI workflow with 5-stage pipeline (sanitize, client, tests, examples, docs) - Command reference with all flags and options - Practical workflow examples (full pipeline, filtered generation, remote methods) - Support for API spec updates with sanitation reapplication Changes: - New doc: en/docs/develop/tools/integration-tools/connector-tool.md with pre-release badge - Updated en/docs/develop/tools/tools.md to list Connector Tool in Integration Tools section and Quick Reference table - Updated en/sidebars.ts to add connector-tool to Integration Tools sidebar navigation

coderabbitai · 2026-06-23T02:50:13Z

Warning

Review limit reached

@vishwajayawickrama, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 43 minutes and 29 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

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

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

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, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f02a3fec-e0e0-40e6-854c-9582ac3a4605

📥 Commits

Reviewing files that changed from the base of the PR and between 778cf0d and 52eacb1.

📒 Files selected for processing (1)

en/docs/develop/tools/integration-tools/connector-tool.md

📝 Walkthrough

Walkthrough

Adds a new connector-tool.md documentation page for the bal connector CLI tool, covering its AI-assisted pipeline, prerequisites, flags, usage examples, and update workflow. The tools overview page gains a bullet and Quick Reference row for the new tool, and the Docusaurus sidebar is updated to include the new entry.

Changes

Connector Tool Documentation

Layer / File(s)	Summary
Connector Tool doc page `en/docs/develop/tools/integration-tools/connector-tool.md`	New 119-line page documenting the `bal connector` pipeline (spec sanitization, client generation, test generation, examples, README), prerequisites (`ANTHROPIC_API_KEY`), stage-skip (`-x`) and interactive flags, connector update workflow using `sanitations.md`, usage examples with tag/operation filtering and `--remote`, and full command/flag reference.
Tools index and sidebar wiring `en/docs/develop/tools/tools.md`, `en/sidebars.ts`	Adds the Connector Tool bullet to the Integration Tools list and a `bal connector` row to the Quick Reference table in `tools.md`; registers `develop/tools/integration-tools/connector-tool` in the sidebar's Integration Tools items list.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 A new tool hops into the docs today,
bal connector shows the AI-assisted way!
Five pipeline stages, from spec to README,
Sanitize, generate, test — hip-hip-hooray!
The sidebar now lists it, the table complete,
Another connector made tidy and neat. ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title accurately summarizes the main change: adding documentation for the Connector Tool under Integration Tools.
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.
Description check	✅ Passed	The PR description covers the key required sections: Purpose, Approach, Release note, and Documentation link, addressing the primary intent of documenting the bal connector tool.

_{✏️ 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.}

github-actions · 2026-06-23T03:06:01Z

Broken links, images & orphan pages

✅ Passing — no broken links or images found.

Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by sidebars.ts.

Summary

Broken links & images — total 0 · 🆕 introduced 0 · 📄 already on main 0
Orphan pages — total 8 · 🆕 introduced 0 · 📄 already on main 8

Broken links & images

Introduced by this PR

No new broken link(s)/image(s) introduced by this PR. ✅

Already on `main` — 0 total

None.

Orphan pages

Introduced by this PR

No new orphan page(s) introduced by this PR. ✅

Already on `main` — 8 total

Already present on the base branch (not caused by this PR):

Show 8

docs/deploy-operate/observe/datadog-integration
docs/deploy-operate/observe/elastic-stack-elk
docs/deploy-operate/observe/metrics-prometheus-grafana
docs/deploy-operate/observe/opensearch-integration
docs/deploy-operate/observe/recipe-elk-stack
docs/deploy-operate/observe/recipe-kubernetes-production
docs/deploy-operate/observe/recipe-local-development
docs/deploy-operate/observe/recipe-opensearch-setup

vishwajayawickrama requested review from KavinduZoysa, NipunaRanasinghe, anupama-pathirage and rosensilva as code owners June 23, 2026 02:49

vishwajayawickrama added 2 commits June 23, 2026 09:53

fix sentece case isse in pre-Release -> pre-release

778cf0d

fix: replace invalid JSX badge in H1 with pre-release admonition

52eacb1

iamvirul approved these changes Jun 25, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add Connector Tool documentation under Integration Tools#552

docs: add Connector Tool documentation under Integration Tools#552
vishwajayawickrama wants to merge 3 commits into
wso2:mainfrom
vishwajayawickrama:connector-tool

vishwajayawickrama commented Jun 23, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 23, 2026 •

edited

Loading

Review limit reached

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

github-actions Bot commented Jun 23, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

vishwajayawickrama commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Approach

Release note

Documentation

Screenshots

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

github-actions Bot commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Broken links, images & orphan pages

Summary

Broken links & images

Introduced by this PR

Already on main — 0 total

Orphan pages

Introduced by this PR

Already on main — 8 total

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vishwajayawickrama commented Jun 23, 2026 •

edited

Loading

coderabbitai Bot commented Jun 23, 2026 •

edited

Loading

github-actions Bot commented Jun 23, 2026 •

edited

Loading

Already on `main` — 0 total

Already on `main` — 8 total