Skip to content

Fix issues in MQTT Event Integration documentation#150

Open
Dilhasha wants to merge 3 commits intowso2:mainfrom
Dilhasha:mqtt-events
Open

Fix issues in MQTT Event Integration documentation#150
Dilhasha wants to merge 3 commits intowso2:mainfrom
Dilhasha:mqtt-events

Conversation

@Dilhasha
Copy link
Copy Markdown
Contributor

@Dilhasha Dilhasha commented Apr 21, 2026

Purpose

$subject.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 21, 2026

Warning

Rate limit exceeded

@Dilhasha has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 53 minutes and 25 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 53 minutes and 25 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 49f53f8e-bb7f-4b59-864d-40043b7a90db

📥 Commits

Reviewing files that changed from the base of the PR and between 8d99c25 and a75077f.

📒 Files selected for processing (1)
  • en/docs/develop/integration-artifacts/event/mqtt.md
📝 Walkthrough

Walkthrough

Documentation for the MQTT integration artifact was updated to reflect multiple API and example changes: broker URIs in examples now use the tcp:// scheme instead of mqtt://; Ballerina examples were updated from ballerinax/mqtt to ballerina/mqtt and show listener construction with subscription/topic arguments and the new service mqtt:Service on mqttListener declaration; onMessage examples use message.payload with string:fromBytes; the mqtt:Message shape, QoS descriptions, and related example tables were revised. No exported/public API declarations were added or removed.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete. While the Purpose section identifies the key change (updating service URI protocol to tcp) and references a related issue, most other required sections are left as template placeholders without substantive content. Complete the Goals, Approach, User stories, Release note, Documentation, Training, Certification, Marketing, Automation tests, Security checks, Samples, Related PRs, Migrations, Test environment, and Learning sections with relevant information or explicit 'N/A' statements with justification where not applicable.
Title check ❓ Inconclusive The title 'Fix issues in MQTT Event Integration documentation' is vague and generic, using a non-specific term ('issues') without clarifying what was fixed or why. Revise the title to be more specific, such as 'Update MQTT Event Integration documentation to use tcp:// protocol URIs' to clearly indicate the primary change.
✅ Passed checks (3 passed)
Check name Status Explanation
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 and usage tips.

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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@en/docs/develop/integration-artifacts/event/mqtt.md`:
- Line 84: Update the table header label "Server Uri" to use consistent acronym
casing by changing it to "Server URI" wherever the exact string "Server Uri"
appears in this document (specifically in the table row that currently reads |
**Server Uri** | URI of the remote MQTT server (...)). Ensure it matches other
headings like "Service URI" on the page.
🪄 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: a9238938-354b-47f9-aba5-85585af16096

📥 Commits

Reviewing files that changed from the base of the PR and between 449ae7a and fe14e83.

📒 Files selected for processing (1)
  • en/docs/develop/integration-artifacts/event/mqtt.md

Comment thread en/docs/develop/integration-artifacts/event/mqtt.md Outdated
samithkavishke
samithkavishke previously approved these changes Apr 22, 2026
@Dilhasha Dilhasha changed the title Update default value for Service URI in MQTT Event Integration Fix issues in MQTT Event Integration documentation Apr 22, 2026
@Dilhasha Dilhasha requested a review from samithkavishke April 22, 2026 05:06
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.

Actionable comments posted: 1

🧹 Nitpick comments (1)
en/docs/develop/integration-artifacts/event/mqtt.md (1)

165-165: Simplify phrasing for clarity.

Consider changing "whether or not" to "whether" for conciseness, unless the phrase is intended to mean "regardless of whether."

📝 Suggested wording
-| `duplicate` | `boolean` | Indicates whether or not this message might be a duplicate |
+| `duplicate` | `boolean` | Indicates whether this message might be a duplicate |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/develop/integration-artifacts/event/mqtt.md` at line 165, Update the
`duplicate` field description to use concise phrasing: replace "Indicates
whether or not this message might be a duplicate" with "Indicates whether this
message might be a duplicate" by editing the table row for the `duplicate`
property in the MQTT event docs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@en/docs/develop/integration-artifacts/event/mqtt.md`:
- Line 142: The MQTT listener URI uses the wrong scheme; update the constructor
call for mqtt:Listener (the mqttListener instance) to use "tcp://localhost:1883"
instead of "mqtt://localhost:1883" so it matches the PR objective and other
examples—locate the line instantiating mqtt:Listener (mqttListener) and replace
the URI scheme accordingly.

---

Nitpick comments:
In `@en/docs/develop/integration-artifacts/event/mqtt.md`:
- Line 165: Update the `duplicate` field description to use concise phrasing:
replace "Indicates whether or not this message might be a duplicate" with
"Indicates whether this message might be a duplicate" by editing the table row
for the `duplicate` property in the MQTT event docs.
🪄 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: 5dad9776-744f-47b1-baa9-e77efcce61a8

📥 Commits

Reviewing files that changed from the base of the PR and between fe14e83 and 8d99c25.

📒 Files selected for processing (1)
  • en/docs/develop/integration-artifacts/event/mqtt.md

Comment thread en/docs/develop/integration-artifacts/event/mqtt.md Outdated
@Dilhasha Dilhasha requested a review from ayeshLK April 23, 2026 04:55
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