README.md YAML URL Template #2118
Conversation
WalkthroughDocumentation updates add URI-template path rewriting and a beta YAML configuration example to the root README; the YAML example README gets heading/style and step edits; and a new example API resource "log" (port 2000) with a log interceptor targeting https://api.predic8.de is added to the example proxies.yaml. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Client
participant G as API Gateway (example)
participant I as Log Interceptor
participant T as Target (api.predic8.de)
C->>G: HTTP request (port 2000)
G->>I: Invoke log interceptor
Note right of I: Log message: "Header ${header}"
I-->>G: Continue
G->>T: Forward request
T-->>G: Response
G-->>C: Response
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ 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). (2)
✨ Finishing Touches🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
README.md (1)
34-47: Minor consistency: align example name case with proxies.yaml.In this README the YAML example uses
metadata.name: log(lowercase), whiledistribution/examples/yaml-configuration/proxies.yamlusesLog. Pick one (prefer lowercase) to avoid confusion.Apply:
- name: log + name: log…and in proxies.yaml (see separate comment) use
logas well.distribution/examples/yaml-configuration/README.md (1)
1-1: Avoid strikethrough in headings; use a beta label instead.Strikethrough in headings hurts readability and can confuse anchors. Prefer “YAML Configuration (beta)” with the existing note below.
Apply:
-# ~~YAML Configuration~~ +# YAML Configuration (beta)distribution/examples/yaml-configuration/proxies.yaml (2)
24-34: Name/style consistency and port overlap intent.
- Consider using lowercase
metadata.name: logto match the README example.- Both
fruitshop-demoandLog/loglisten on port 2000; assuming first-match routing, confirm this ordering is intended (OpenAPI first, log as fallback).Apply:
- name: Log + name: logTo confirm intent, please indicate that
logis meant as a catch-all after the OpenAPI routes.
34-34: Add trailing newline.YAML lints typically require a newline at EOF.
Apply:
- url: https://api.predic8.de + url: https://api.predic8.de +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
README.md(1 hunks)distribution/examples/yaml-configuration/README.md(1 hunks)distribution/examples/yaml-configuration/proxies.yaml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
distribution/examples/yaml-configuration/proxies.yaml
[error] 34-34: no new line character at the end of file
(new-line-at-end-of-file)
🪛 LanguageTool
distribution/examples/yaml-configuration/README.md
[grammar] ~7-~7: Ensure spelling is correct
Context: ... is still experimental. ## Running the Eample 1. Start Membrane from this directory: ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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). (2)
- GitHub Check: Automated tests
- GitHub Check: Analyze (java)
🔇 Additional comments (5)
README.md (2)
49-49: Anchor/link robustness check.The link targets a heading changed to a strikethrough in the example README. It likely still resolves, but please double-check in GitHub’s preview. Optionally point directly at the file for stability.
You can switch to:
-See: [YAML configuration](distribution/examples/yaml-configuration#YAML-Configuration) +See: [YAML configuration](distribution/examples/yaml-configuration/README.md#yaml-configuration)
19-25: Change “an URI” to “a URI” in README.md-**Path Rewriting with an URI Template:** +**Path Rewriting with a URI Template:**Placeholder
${pathParam.id}is correct.distribution/examples/yaml-configuration/README.md (1)
11-20: Verified CLI invocation: Theyaml -l proxies.yamlcommand matches the default usage in membrane.sh (line 11), membrane.cmd (line 88), and the ProxiesYAMLExampleTest.java (line 37).distribution/examples/yaml-configuration/proxies.yaml (2)
18-21: LGTM on admin-console section.The separator and
serviceProxyblock look correct.
1-10: Verifyspecskey against Membrane CRD schema.
- Confirmed fruitshop-api.yml exists at
distribution/examples/yaml-configuration/../../conf/fruitshop-api.yml.- Please cross-check that the nesting (
spec → specs → - openapi → location) matches the official Membrane API CRD schema.
2 participants
Summary by CodeRabbit