Docs: APIProxy

[predic8]

Summary by CodeRabbit

• Documentation

  • Updated API proxy documentation with clearer guidance on how multiple APIs are selected and probed.
  • Expanded OpenAPI auto-wiring and configuration examples to improve understanding of request routing and evaluation order.

• Style

  • Improved readability by replacing wildcard imports with explicit imports for the involved configuration, interceptor, and expression types.

[coderabbitai]

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: 43539e08-9ed9-456f-9c00-39d00fbcc2ca

📥 Commits

Reviewing files that changed from the base of the PR and between cf0e373 and 6266c2b.

📒 Files selected for processing (1)

• core/src/main/java/com/predic8/membrane/core/openapi/serviceproxy/APIProxy.java

✅ Files skipped from review due to trivial changes (1)

• core/src/main/java/com/predic8/membrane/core/openapi/serviceproxy/APIProxy.java

---

📝 Walkthrough

Walkthrough

This PR updates APIProxy.java by replacing wildcard imports with explicit class imports and expanding the class-level Javadoc with revised routing/discrimination narrative and YAML examples. No functional or public API changes are made.

Changes

APIProxy Documentation and Imports

Layer / File(s)	Summary
Explicit imports and updated class documentation core/src/main/java/com/predic8/membrane/core/openapi/serviceproxy/APIProxy.java	Wildcard imports are replaced with explicit imports; the Javadoc description and YAML examples are expanded to document routing/discrimination and OpenAPI auto-wiring.

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

Poem

A rabbit hopped through code so neat,
Tidying imports, making them complete,
Docs now shine with routing lore,
Explicit paths forevermore,
Hop hop hooray, this PR's a treat! 🐰📜

🚥 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 concise and clearly related to the APIProxy documentation update.
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-api

---

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.}

[coderabbitai]

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/openapi/serviceproxy/APIProxy.java`:
- Around line 51-54: Update the OpenAPI Javadoc in APIProxy so it documents the
canonical publisher endpoints instead of the compatibility alias: change the
description near the OpenAPI Support text to reference /api-docs and
/api-docs/ui, and mention that /api-doc is only a legacy alias handled by
APIProxyKey. Keep the rest of the tutorial references intact so generated docs
point readers to the correct URL.

🪄 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: c27db1fa-48c6-4a79-8958-27bb85d549f6

📥 Commits

Reviewing files that changed from the base of the PR and between ad3142e and cf0e373.

📒 Files selected for processing (1)

• core/src/main/java/com/predic8/membrane/core/openapi/serviceproxy/APIProxy.java

[rrayst]

/ok-to-test