Skip to content

Port RabbitMQ URL placeholder description and custom builders/formatters doc to 4.4.0 - #2349

Open
ChaninduImanjith wants to merge 3 commits into
wso2:4.4.0from
ChaninduImanjith:fixing-issue-1884-4.4.0
Open

Port RabbitMQ URL placeholder description and custom builders/formatters doc to 4.4.0#2349
ChaninduImanjith wants to merge 3 commits into
wso2:4.4.0from
ChaninduImanjith:fixing-issue-1884-4.4.0

Conversation

@ChaninduImanjith

Copy link
Copy Markdown
Contributor

Purpose

Resolves #1884

Goals

Port the RabbitMQ URL placeholder description and custom builders/formatters documentation updates from PR #1870 to the 4.4.0 branch.

Approach

  1. Added the placeholder parameter row to the RabbitMQ transport parameters table in the sending messages section.
  2. Added a new "Configuring custom builders/formatters in blocking mode" section to the message builders and formatters documentation.

User stories

As a WSO2 MI developer, I want to understand the RabbitMQ URL placeholder parameter and how to configure custom message builders/formatters in blocking mode so that I can properly configure my integration.

Release note

Documentation updated to include the RabbitMQ URL placeholder parameter description and custom builders/formatters configuration for blocking mode transport.

Documentation

  • en/docs/install-and-setup/setup/message-builders-formatters/message-builders-and-formatters.md
  • en/docs/reference/synapse-properties/transport-parameters/rabbitmq-transport-parameters.md

Training

N/A

Certification

N/A - Documentation-only update.

Marketing

N/A

Automation tests

N/A - No code changes introduced.

Security checks

  • Followed secure coding standards? Yes
  • Ran FindSecurityBugs plugin? N/A
  • No keys, passwords, or secrets committed? Yes

Samples

N/A

Related PRs

#1870

Migrations

N/A

Test environment

Tested on Fedora OS (local documentation verification).

Learning

N/A

Copilot AI review requested due to automatic review settings July 5, 2026 10:06
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 12c58f76-5bf6-404e-9f27-fa92c0436a01

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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.

Copilot AI 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.

Pull request overview

Ports documentation updates to the 4.4.0 branch to clarify RabbitMQ URL placeholder behavior and explain how to configure custom message builders/formatters when running in blocking mode.

Changes:

  • Added a placeholder entry to the RabbitMQ send transport parameters table.
  • Added a new section describing [[blocking.custom_message_builders]] and [[blocking.custom_message_formatters]] TOML configuration.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
en/docs/reference/synapse-properties/transport-parameters/rabbitmq-transport-parameters.md Documents the RabbitMQ URL placeholder behavior in the send-parameters table.
en/docs/install-and-setup/setup/message-builders-formatters/message-builders-and-formatters.md Adds blocking-mode configuration guidance for custom message builders and formatters.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


The `custom_message_builders` and `custom_message_formatters` configurations shown above apply to non-blocking transports.

When the WSO2 Integrator: MI runs in blocking mode, use the following configurations instead.
class = "<message_formatter_class>"
```

These configurations function similarly to their non-blocking equivalents, but are applied only when the WSO2 Integrator: MI uses blocking transport. No newline at end of file
@ChaninduImanjith
ChaninduImanjith force-pushed the fixing-issue-1884-4.4.0 branch from 471da5e to 17dc969 Compare July 5, 2026 10:32
@SanojPunchihewa

Copy link
Copy Markdown
Contributor

@ChaninduImanjith Thanks for the contribution! We may also need to port the changes from baed986, as that's the PR where we added the placeholder attribute for the RabbitMQ parameters.

@ChaninduImanjith

Copy link
Copy Markdown
Contributor Author

@ChaninduImanjith Thanks for the contribution! We may also need to port the changes from baed986, as that's the PR where we added the placeholder attribute for the RabbitMQ parameters.
Thanks @SanojPunchihewa! I've ported the changes from baed986 (Format of the Address URL section) to this PR as well.

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