update interceptor documentation

[russelmrcl]

Summary by CodeRabbit

• Documentation
  • Improved Javadoc formatting for Beautifier and If interceptors to enhance readability of supported formats and example blocks.
• Style
  • Minor annotation spacing cleanup in HTTP client configuration.

No functional or behavioral changes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This PR updates documentation and formatting only: Javadoc text tweaks in BeautifierInterceptor and IfInterceptor, and whitespace normalization in an annotation on HttpClientConfiguration. No code logic, behavior, control flow, or public API changes.

Changes

Cohort / File(s)	Summary
Javadoc formatting updates core/src/main/java/.../interceptor/beautifier/BeautifierInterceptor.java, core/src/main/java/.../interceptor/flow/IfInterceptor.java	Adjusted Javadoc formatting (added HTML bold tags and adjusted example indentation). No code or behavior changes.
Annotation whitespace normalization core/src/main/java/.../transport/http/client/HttpClientConfiguration.java	Spaced annotation parameters: @MCElement(name="httpClientConfig") → @MCElement(name = "httpClientConfig"). No functional impact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• update interceptor documentation #2172 — Also updates Javadoc for IfInterceptor; likely part of coordinated documentation cleanup.

Suggested reviewers

• predic8
• bridgerdier

Poem

A nibble of docs, a whisker of style,
I hop through comments, tidy the file.
No flows disturbed, no bytes askew—
Just polished words, crisp and new.
Thump-thump! approves this rabbit crew. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 36.36% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	Title is a concise, single-sentence description that accurately highlights the main change: documentation updates to interceptors. The raw_summary shows Javadoc formatting edits in BeautifierInterceptor and IfInterceptor which align with the title, with only a minor unrelated whitespace change in HttpClientConfiguration. It is clear and specific enough for a teammate scanning history to understand the primary change.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 20d13cf and b57f961.

📒 Files selected for processing (1)

• core/src/main/java/com/predic8/membrane/core/interceptor/flow/IfInterceptor.java (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[membrane-ci-server]

This pull request needs "/ok-to-test" from an authorized committer.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

core/src/main/java/com/predic8/membrane/core/interceptor/beautifier/BeautifierInterceptor.java (1)

31-31: Polish wording and casing for supported formats.

Align with getShortDescription and avoid shouting “TEXT”.

- * @description Beautifies request and response bodies. Supported are the Formats: <b>JSON</b>, <b>JSON5</b>, <b>XML</b>, <b>TEXT</b>
+ * @description Beautifies request and response bodies. Supported formats: <b>JSON</b>, <b>JSON5</b>, <b>XML</b>, <b>text</b>.

core/src/main/java/com/predic8/membrane/core/transport/http/client/HttpClientConfiguration.java (1)

27-47: Clarify YAML example: maxRetries semantics.

Add a brief note so users understand it’s “additional retries,” not total attempts.

- * <pre><code>httpClientConfig:
- *   maxRetries: 5
+ * <pre><code>httpClientConfig:
+ *   maxRetries: 5   # additional retries (total attempts = 6)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e052e93 and 20d13cf.

📒 Files selected for processing (3)

• core/src/main/java/com/predic8/membrane/core/interceptor/beautifier/BeautifierInterceptor.java (1 hunks)
• core/src/main/java/com/predic8/membrane/core/interceptor/flow/IfInterceptor.java (1 hunks)
• core/src/main/java/com/predic8/membrane/core/transport/http/client/HttpClientConfiguration.java (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

core/src/main/java/com/predic8/membrane/core/transport/http/client/HttpClientConfiguration.java (3)

core/src/main/java/com/predic8/membrane/core/interceptor/HTTPClientInterceptor.java (1)

• MCElement (43-225)

core/src/main/java/com/predic8/membrane/core/transport/http/client/RetryHandler.java (1)

• MCElement (51-320)

core/src/main/java/com/predic8/membrane/core/interceptor/oauth2/authorizationservice/DynamicRegistration.java (1)

• MCElement (34-128)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (1)

core/src/main/java/com/predic8/membrane/core/transport/http/client/HttpClientConfiguration.java (1)

50-50: Annotation whitespace tweak looks good.