Skip to content

Updated SOAPProxy documentation and annotations#3038

Merged
rrayst merged 2 commits into
masterfrom
docs-soap-proxy
Jul 4, 2026
Merged

Updated SOAPProxy documentation and annotations#3038
rrayst merged 2 commits into
masterfrom
docs-soap-proxy

Conversation

@predic8

@predic8 predic8 commented Jul 4, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Expanded and refined API documentation for SOAP proxy configuration options, including clearer explanations and updated examples for fields like WSDL details, target/service naming, host/path handling, backend target usage, TLS settings, and template/language/escaping behavior.
    • Clarified that the * method matches any HTTP method.
  • Chores

    • Cleaned up import usage across proxy components to improve source readability and maintainability.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1fa23903-c59a-4aa3-852d-4f431deb7675

📥 Commits

Reviewing files that changed from the base of the PR and between 8ffba0f and 0c7b961.

📒 Files selected for processing (4)
  • core/src/main/java/com/predic8/membrane/core/proxies/AbstractServiceProxy.java
  • core/src/main/java/com/predic8/membrane/core/proxies/SOAPProxy.java
  • core/src/main/java/com/predic8/membrane/core/proxies/ServiceProxy.java
  • core/src/main/java/com/predic8/membrane/core/proxies/Target.java
✅ Files skipped from review due to trivial changes (3)
  • core/src/main/java/com/predic8/membrane/core/proxies/AbstractServiceProxy.java
  • core/src/main/java/com/predic8/membrane/core/proxies/ServiceProxy.java
  • core/src/main/java/com/predic8/membrane/core/proxies/Target.java
🚧 Files skipped from review as they are similar to previous changes (1)
  • core/src/main/java/com/predic8/membrane/core/proxies/SOAPProxy.java

📝 Walkthrough

Walkthrough

This change updates proxy classes by replacing wildcard imports with explicit imports and revising Javadoc text for configuration fields and rule descriptions. No runtime behavior, signatures, or control flow changed.

Changes

Proxy documentation and import cleanup

Layer / File(s) Summary
Abstract service proxy docs
core/src/main/java/com/predic8/membrane/core/proxies/AbstractServiceProxy.java
Explicit imports replace wildcard imports, and Javadoc for host matching, path matching, and backend target text is updated.
Service proxy docs
core/src/main/java/com/predic8/membrane/core/proxies/ServiceProxy.java
Explicit annotation imports and updated class and method Javadoc are added for the service proxy.
SOAP proxy docs
core/src/main/java/com/predic8/membrane/core/proxies/SOAPProxy.java
Explicit imports and class Javadoc are updated, and new or revised Javadoc blocks are added for wsdl, portName, wsdlHttpClientConfig, and serviceName.
Target docs
core/src/main/java/com/predic8/membrane/core/proxies/Target.java
Explicit imports replace wildcard imports, and Javadoc is updated for host, port, url, sslParser, adjustHostHeader, method, language, and escaping.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

I hopped through docs with tidy paws,
Replaced the wild imports and all their claws,
Fields and paths now speak more clear,
A rabbit nods: “good notes this year!” 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is relevant and concise, though it names only SOAPProxy while the PR also updates documentation and annotations in other proxy classes.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-soap-proxy

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.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@core/src/main/java/com/predic8/membrane/core/proxies/SOAPProxy.java`:
- Around line 320-323: Update the Javadoc for SOAPProxy’s serviceName setting to
match the actual selection logic in getService(defs): it should describe
serviceName as an optional selector for a specific WSDL service, with the first
service used as the default when omitted, rather than saying it is required only
when multiple services exist. Keep the wording aligned with the behavior in
SOAPProxy and the getService(defs) fallback.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7ca14e18-4c05-40e9-a8a8-105b627762f3

📥 Commits

Reviewing files that changed from the base of the PR and between b71f1fc and 8ffba0f.

📒 Files selected for processing (1)
  • core/src/main/java/com/predic8/membrane/core/proxies/SOAPProxy.java

Comment thread core/src/main/java/com/predic8/membrane/core/proxies/SOAPProxy.java
@rrayst

rrayst commented Jul 4, 2026

Copy link
Copy Markdown
Member

/ok-to-test

@rrayst rrayst merged commit 449af21 into master Jul 4, 2026
5 checks passed
@rrayst rrayst deleted the docs-soap-proxy branch July 4, 2026 13:19
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.

2 participants