Skip to content

inline list items with otherAttributeInfo#2777

Merged
christiangoerdes merged 2 commits intomasterfrom
list-inline-oai
Feb 12, 2026
Merged

inline list items with otherAttributeInfo#2777
christiangoerdes merged 2 commits intomasterfrom
list-inline-oai

Conversation

@christiangoerdes
Copy link
Copy Markdown
Collaborator

@christiangoerdes christiangoerdes commented Feb 12, 2026

Summary by CodeRabbit

  • Bug Fixes

    • List items that are plain strings are now handled correctly.
    • More properties are recognized as configurable, improving configuration coverage.
  • Documentation

    • Example configuration files updated: user entries in authentication examples are now flat (username/password/email defined at the same level) instead of wrapped in an extra nesting.

@christiangoerdes
Copy link
Copy Markdown
Collaborator Author

/ok-to-test

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 12, 2026

📝 Walkthrough

Walkthrough

Process string-typed list items inline in JsonSchemaGenerator and treat non-null OAI entries as configurable; several example YAMLs and README updated to flatten user entries from user: { ... } to top-level username/password/email mappings.

Changes

Cohort / File(s) Summary
JSON Schema Generation Logic
annot/src/main/java/com/predic8/membrane/annot/generator/JsonSchemaGenerator.java
Removed guard that skipped string-typed list items so they can be processed as inline list items. Expanded hasAnyConfigurableProperty to count ei.getOai() != null as configurable.
Documentation / Examples (flatten user entries)
README.md, distribution/examples/security/basic-auth/simple/apis.yaml, distribution/examples/security/login/apis.yaml, distribution/examples/security/oauth2/api/authorization_server/apis.yaml, distribution/examples/security/oauth2/credentials/authorization_server/apis.yaml, distribution/examples/security/oauth2/implicit/authorization_server/apis.yaml, distribution/examples/security/oauth2/membrane/authorization_server/apis.yaml, distribution/examples/websockets/websocket-stomp/apis.yaml, distribution/router/conf/apis.yaml, distribution/tutorials/getting-started/45-Admin-Web-Console.yaml
Rewrote sample user lists to remove the nested user: wrapper; each user list item is now a flat mapping (username, password, optional email/secret) instead of { user: { ... } }. No other behavioral changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • predic8
  • rrayst

Poem

🐰 A tiny tweak, a gentle hop,
Strings now mingle, no more stop,
OAI wakes and joins the song,
Configs grow tidy, neat, and strong,
Hooray — the schema hops along! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% 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 'inline list items with otherAttributeInfo' accurately captures the main technical change—enabling inline processing of list items by relaxing guard conditions and expanding configurability logic in JsonSchemaGenerator.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch list-inline-oai

No actionable comments were generated in the recent review. 🎉


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 and usage tips.

@membrane-ci-server
Copy link
Copy Markdown

This pull request needs "/ok-to-test" from an authorized committer.

@christiangoerdes christiangoerdes merged commit 86be3d7 into master Feb 12, 2026
5 checks passed
@christiangoerdes christiangoerdes deleted the list-inline-oai branch February 12, 2026 10:05
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