update interceptor documentation

[russelmrcl]

Summary by CodeRabbit

• Documentation
  • Clarified usage scope of the load balancing interceptor and fixed capitalization/terminology.
  • Improved conditional interceptor docs: clarified behavior, added a SpEL example, updated default language and phrasing for test conditions.
  • Polished return interceptor docs: tightened wording for status code and content type and emphasized key parameters.
  • No functional changes or public API modifications.

[coderabbitai]

Walkthrough

Documentation-only updates to Javadocs in three interceptors: wording and capitalization tweaks, plus an SpEL example and clarified parameter descriptions. No code, control-flow, or public API signature changes.

Changes

Cohort / File(s)	Summary of Changes
Load balancer Javadoc tweaks core/src/main/java/com/predic8/membrane/core/interceptor/balancer/LoadBalancingInterceptor.java	Updated Javadoc wording to allow “serviceProxy or api” and adjusted capitalization (“load balancer”); no logic or signature changes.
If interceptor Javadoc expansion core/src/main/java/com/predic8/membrane/core/interceptor/flow/IfInterceptor.java	Reworded class and method Javadocs to reference nested interceptors, added a SpEL usage example, and changed default language note; no code or API changes.
Return interceptor Javadoc tweaks core/src/main/java/com/predic8/membrane/core/interceptor/flow/ReturnInterceptor.java	Minor phrasing and capitalization adjustments, plus inline emphasis for parameters (statusCode, contentType); no logic or signature changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• t-burch
• rrayst

Poem

I nibble at Javadocs, tidy and bright,
Hop through small words by soft moonlight.
No bugs to chase, no threads to unwind,
Just cleaner notes left for humankind. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% 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	The title succinctly and accurately describes the PR's primary change: documentation updates to interceptor classes (IfInterceptor, ReturnInterceptor, LoadBalancingInterceptor). It is concise, clear, and directly related to the provided changeset.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch improve-docs

---

📜 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 ced4f3e and a1819c4.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

• core/src/main/java/com/predic8/membrane/core/interceptor/flow/IfInterceptor.java

⏰ 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)

---

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 (4)

core/src/main/java/com/predic8/membrane/core/interceptor/flow/ReturnInterceptor.java (2)

42-43: Clarify “messages” and tighten phrasing.

“messages” is ambiguous (request vs. response). Recommend explicitly stating which message(s) are overridden.

- * The options <i>statusCode</i> and <i>contentType</i> will overwrite the values from the messages.
+ * Options <i>statusCode</i> and <i>contentType</i> override values from the existing request/response messages.

---

138-141: Prefer “Content-Type” for header naming consistency.

Small editorial improvement for precision and consistency with HTTP terminology.

- * @description Content type of the response. If not set, the content type of the request (if available) or no content type will be used.
+ * @description Content-Type of the response. If not set, the request's Content-Type (if available) is used; otherwise, no Content-Type is set.

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

38-39: Use code styling for element names and consistent casing.

Minor readability polish: mark element names as code and use “an interceptor”.

- * @explanation May only be used as interceptor in a serviceProxy or api.
+ * @explanation May only be used as an interceptor in a <code>serviceProxy</code> or <code>api</code>.

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

116-118: Optional: add period and code styling for identifiers.

Minor editorial polish.

- * @description Condition to be tested
- * @example <ul><li>request.isJSON()</li><li>params['limit'] >= 0</li><li>statusCode matches '[45]\d\d'</li></ul>
+ * @description Condition to be tested.
+ * @example <ul><li><code>request.isJSON()</code></li><li><code>params['limit'] >= 0</code></li><li><code>statusCode matches '[45]\d\d'</code></li></ul>

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2c6b54 and e7b7379.

📒 Files selected for processing (3)

• core/src/main/java/com/predic8/membrane/core/interceptor/balancer/LoadBalancingInterceptor.java (2 hunks)
• core/src/main/java/com/predic8/membrane/core/interceptor/flow/IfInterceptor.java (3 hunks)
• core/src/main/java/com/predic8/membrane/core/interceptor/flow/ReturnInterceptor.java (3 hunks)

⏰ 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 (2)

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

124-127: LGTM on statusCode description.

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

191-195: LGTM on improved wording (“load balancer”).