Update and fix yaml documentation

[christiangoerdes]

Summary by CodeRabbit

• Documentation

  • Added or expanded YAML configuration examples across multiple interceptors and API proxy docs.
  • Simplified API key header extractor examples to a more concise single-line format.

• Chores

  • Updated form validation element to adjust envelope handling behavior in configuration.

[christiangoerdes]

/ok-to-test

[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 86464bd and a51e1df.

📒 Files selected for processing (1)

• core/src/main/java/com/predic8/membrane/core/interceptor/RegExReplaceInterceptor.java

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

• core/src/main/java/com/predic8/membrane/core/interceptor/RegExReplaceInterceptor.java

---

📝 Walkthrough

Walkthrough

This PR updates Javadoc and README configuration examples across multiple interceptors, standardizes API key header extractor syntax from nested mapping to flat scalar form, and adds noEnvelope = true to the @MCElement annotation of FormValidationInterceptor.

Changes

Cohort / File(s)	Summary
README Documentation README.md, distribution/examples/security/api-key/rbac/README.md	Changed API key header extractor syntax from nested mapping (header: {name: X-Api-Key}) to flat scalar format (header: X-Api-Key).
ApiKeys & Examples core/src/main/java/com/predic8/membrane/core/interceptor/apikey/ApiKeysInterceptor.java	Updated Javadoc YAML example to use flattened header: X-Api-Key form (documentation-only change).
Interceptor Javadoc Examples core/src/main/java/com/predic8/membrane/core/interceptor/CountInterceptor.java, .../RegExReplaceInterceptor.java, .../AdminConsoleInterceptor.java, .../BasicAuthenticationInterceptor.java, .../ResponseInterceptor.java, .../HeaderFilterInterceptor.java, .../XMLContentFilterInterceptor.java, core/src/main/java/com/predic8/membrane/core/openapi/serviceproxy/APIProxy.java	Added or expanded YAML configuration examples in class Javadocs; documentation-only edits, no runtime behavior changes.
FormValidation Configuration core/src/main/java/com/predic8/membrane/core/interceptor/formvalidation/FormValidationInterceptor.java	Added noEnvelope = true to @MCElement annotation and inserted a Javadoc YAML example (annotation change affects element metadata).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

• Simplify API Key YAML configuration and JavaDoc; add collapsed attr… #2808: Applies the same API key extractor YAML shape change (nested -> flattened) across docs and examples.
• Improve yaml syntax: Use collapsed for suitable classes (Breaking Change) #2776: Performs YAML-syntax collapsing for examples, matching the flattened extractor format used here.
• added @MCElement(noEnvelope=true) modus #2181: Introduces/relates to noEnvelope support for @MCElement, which this PR applies to FormValidationInterceptor.

Suggested reviewers

• predic8

Poem

🐰 A rabbit hopped through docs so neat,
Flattening headers with nimble feet.
Examples trimmed, annotations true,
Configs now tidy, clean, and new.
Hooray — a patch of clarity for you! 🌿

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Update and fix yaml documentation' directly aligns with the main changes, which involve updating YAML documentation examples across multiple files and fixing their formatting.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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 fix-doc

---

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

🤖 Prompt for all review comments with AI agents

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

Inline comments:
In
`@core/src/main/java/com/predic8/membrane/core/interceptor/flow/ResponseInterceptor.java`:
- Around line 26-34: The YAML example is misleading because listing "response:"
before "return: {}" obscures execution order; update the example so it's clearer
by either swapping the sequence to place "return: {}" before "response:" or add
a concise inline comment explaining that flow plugins under "response:" run in
the response phase and that response-phase steps execute in reverse list order,
and mention that "static: src: Hello!" is handled on the response while "return:
{}" short-circuits the request; adjust the example block around the "response",
"static", and "return" entries accordingly.

In
`@core/src/main/java/com/predic8/membrane/core/interceptor/RegExReplaceInterceptor.java`:
- Around line 28-35: In the Javadoc for RegExReplaceInterceptor replace the
incorrect HTML tag pair "<per>...</per>" with the correct preformatted block
tags "<pre>...</pre>" so the YAML example is rendered as preformatted text;
update both the opening and closing tags in the Javadoc block (and search for
any other occurrences in RegExReplaceInterceptor) to ensure the example displays
correctly.

---

ℹ️ 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 861d534 and 86464bd.

📒 Files selected for processing (12)

• README.md
• core/src/main/java/com/predic8/membrane/core/interceptor/CountInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/RegExReplaceInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/administration/AdminConsoleInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/apikey/ApiKeysInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/authentication/BasicAuthenticationInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/flow/ResponseInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/formvalidation/FormValidationInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/headerfilter/HeaderFilterInterceptor.java
• core/src/main/java/com/predic8/membrane/core/interceptor/xmlcontentfilter/XMLContentFilterInterceptor.java
• core/src/main/java/com/predic8/membrane/core/openapi/serviceproxy/APIProxy.java
• distribution/examples/security/api-key/rbac/README.md