Enhance error message for multiple key detection

[predic8]

• Updated ConfigurationParsingException message to provide clearer guidance on separating APIs and configuration using ---.

Summary by CodeRabbit

• Bug Fixes
  • Updated validation error messages to explicitly advise separating APIs and configuration using ---, making it easier to identify and fix misformatted input.
  • Tightened message formatting for clearer, more consistent diagnostic output.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e732cb0 and dfe0c1d.

📒 Files selected for processing (2)

• annot/src/main/java/com/predic8/membrane/annot/beanregistry/BeanRegistryImplementation.java
• annot/src/main/java/com/predic8/membrane/annot/yaml/GenericYamlParser.java

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

• annot/src/main/java/com/predic8/membrane/annot/beanregistry/BeanRegistryImplementation.java
• annot/src/main/java/com/predic8/membrane/annot/yaml/GenericYamlParser.java

---

📝 Walkthrough

Walkthrough

Updated an error message in YAML validation and made small import/static-import and formatting edits across bean registry and YAML parser files. No public APIs or control flow changes detected.

Changes

Cohort / File(s)	Summary
YAML validation message annot/src/main/java/com/predic8/membrane/annot/yaml/NodeValidationUtils.java	Changed ensureSingleKey error text to append guidance: "Separate APIs and configuration by ---".
Bean registry imports annot/src/main/java/com/predic8/membrane/annot/beanregistry/BeanRegistryImplementation.java	Added Spring XML and general IO/reflection imports; replaced a specific static import with a wildcard static import. No API signature changes.
YAML parser formatting annot/src/main/java/com/predic8/membrane/annot/yaml/GenericYamlParser.java	Whitespace, formatting, and minor message/exception formatting adjustments; no behavioral or API changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• split BeanRegistry interface #2488: Modifies BeanRegistryImplementation.java and may overlap with import/static-import changes.

Suggested reviewers

• christiangoerdes

Poem

I nibble on code with careful paws,
A dash inserted to fix the cause.
"Separate with ---," I softly declare,
Bugs hop away on the open air. 🐰✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 38.89% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ 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 directly matches the main change: enhancing the error message for multiple key detection in NodeValidationUtils.java by appending guidance about separating APIs and configuration with ---.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch tripple-dash-message

---

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

[coderabbitai]

🧹 Nitpick comments (1)

annot/src/main/java/com/predic8/membrane/annot/yaml/NodeValidationUtils.java (1)

30-30: Minor wording nits: quote the --- token and add a trailing period.

The appended sentence is missing a period, and the --- separator is undelimited — users reading the exception message in logs may not immediately recognize it as a literal token to type.

✏️ Suggested wording improvement

-            var e = new ConfigurationParsingException("Expected exactly one key but there are %d. Separate APIs and configuration by ---".formatted(node.size()));
+            var e = new ConfigurationParsingException("Expected exactly one key but there are %d. Separate APIs and configuration using '---'.".formatted(node.size()));

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@annot/src/main/java/com/predic8/membrane/annot/yaml/NodeValidationUtils.java`
at line 30, The exception message constructed in the
ConfigurationParsingException instantiation (the var e = new
ConfigurationParsingException(...) line) should quote the separator and end with
a period; update the message string to read something like "Expected exactly one
key but there are %d. Separate APIs and configuration by '---'." so the '---'
token is delimited and the sentence is properly terminated.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In
`@annot/src/main/java/com/predic8/membrane/annot/yaml/NodeValidationUtils.java`:
- Line 30: The exception message constructed in the
ConfigurationParsingException instantiation (the var e = new
ConfigurationParsingException(...) line) should quote the separator and end with
a period; update the message string to read something like "Expected exactly one
key but there are %d. Separate APIs and configuration by '---'." so the '---'
token is delimited and the sentence is properly terminated.

---

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 934c76d and e732cb0.

📒 Files selected for processing (1)

• annot/src/main/java/com/predic8/membrane/annot/yaml/NodeValidationUtils.java