Skip to content

Fix: Update connector import documentation [main]#2083

Open
wso2-engineering-bot wants to merge 1 commit intomainfrom
fixing-issue-2081-main-1773676872
Open

Fix: Update connector import documentation [main]#2083
wso2-engineering-bot wants to merge 1 commit intomainfrom
fixing-issue-2081-main-1773676872

Conversation

@wso2-engineering-bot
Copy link
Copy Markdown

@wso2-engineering-bot wso2-engineering-bot commented Mar 16, 2026

This PR was automatically generated by Claude AI.

  • Issue: Port add connector documentation updates #2081
  • Type: Documentation
  • Summary: Ports the connector import documentation updates from PR Update import connector documentation #2076 to the main branch. Updates Method 2 to describe importing connectors via mediation flow, and creates Method 3 for importing connections using OpenAPI/gRPC definitions.
  • Image Verification: All referenced images have been copied from the 4.5.0 branch and are accessible in the repository.
  • Verification: mkdocs build passed (pre-existing warnings unrelated to these changes)

Summary by CodeRabbit

  • Documentation
    • Updated connector import workflow to use mediation-flow-centric approach
    • Added enhanced visual guides (GIF format) for importing connectors and connections
    • Clarified connector storage location information
    • Streamlined UI steps and paths for improved clarity

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 16, 2026

Walkthrough

Documentation update to the connector import workflow in WSO2 Integration Studio. The guide shifts from a Connector Store-based approach to a mediation-flow-centric workflow, introduces a new import connections method, updates visual assets to GIF format, and removes references to legacy import options.

Changes

Cohort / File(s) Summary
Documentation Update
en/docs/develop/creating-artifacts/adding-connectors.md
Restructured connector import methods: replaced Method 2 flow with mediation-flow-based approach, introduced Method 3 for importing connections, updated visuals to GIF format, removed legacy OpenAPI and ZIP import options, and added clarifications on connector storage location.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hop along to flows anew,
Where mediators dance on through,
Connectors import with a spring,
GIFs now show the wondrous thing!
Docs refreshed, the path is clear,
Integration magic draws so near!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete, missing most required template sections including Purpose, Goals, Approach, User stories, Release note, and other sections from the template. Complete the PR description by filling out required sections from the template: Purpose with linked issue, Goals explaining the solution, Approach with UI impacts, and other applicable sections like Documentation, Testing, and Environment details.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: updating connector import documentation with specific focus on documentation fixes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fixing-issue-2081-main-1773676872
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

Tip

CodeRabbit can generate a title for your PR based on the changes.

Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the reviews.auto_title_placeholder setting.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
en/docs/develop/creating-artifacts/adding-connectors.md (1)

38-46: Consider adding clarifying text to distinguish Methods 2 and 3.

Method 2 is titled "Import connectors" while Method 3 is "Import connections". The distinction between importing a "connector" versus a "connection" may not be immediately clear to users. Consider adding a brief introductory sentence to Method 3 explaining when to use this method versus Method 2.

📝 Suggested clarification

Add a brief explanation before step 1, for example:

 #### Method 3: Import connections
+
+Use this method to generate connection artifacts from API definitions.
 
 1. Navigate to the **Project Overview** page.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/develop/creating-artifacts/adding-connectors.md` around lines 38 -
46, Add a short clarifying sentence before the numbered steps for "Method 3:
Import connections" that explicitly distinguishes it from "Method 2: Import
connectors" — mention that Method 2 imports prebuilt connector packages
(connectors) from the connector catalog while Method 3 imports individual
connection definitions (OpenAPI or gRPC/Proto files) to create a new connection;
reference the headings "Method 2: Import connectors" and "Method 3: Import
connections" so the user knows when to choose each method.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@en/docs/develop/creating-artifacts/adding-connectors.md`:
- Around line 38-46: Add a short clarifying sentence before the numbered steps
for "Method 3: Import connections" that explicitly distinguishes it from "Method
2: Import connectors" — mention that Method 2 imports prebuilt connector
packages (connectors) from the connector catalog while Method 3 imports
individual connection definitions (OpenAPI or gRPC/Proto files) to create a new
connection; reference the headings "Method 2: Import connectors" and "Method 3:
Import connections" so the user knows when to choose each method.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ffefb726-c6cd-4502-801b-3ae3a78b6181

📥 Commits

Reviewing files that changed from the base of the PR and between 01cd38c and 47d353c.

⛔ Files ignored due to path filters (2)
  • en/docs/assets/img/integrate/connectors/import-connection.png is excluded by !**/*.png
  • en/docs/assets/img/integrate/connectors/import-connector.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • en/docs/develop/creating-artifacts/adding-connectors.md

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.

1 participant