Skip to content

Conversation

nandorholozsnyak
Copy link
Member

Fix: "Unknown group" When Using additional-spring-configuration-metadata.json for Custom Groups

Summary

This PR addresses an issue where custom groups defined in additional-spring-configuration-metadata.json were not recognized correctly, resulting in properties being assigned to an "Unknown group" in the generated documentation. The fix ensures that groups and properties are properly linked when the type and sourceType fields are set consistently.

Details

  • Added a regression test to cover the scenario where a group and its properties are defined in additional-spring-configuration-metadata.json with matching type and sourceType fields.
  • Updated the test to verify that properties are assigned to the correct group and not to "Unknown group".
  • Documentation and test resources were updated to clarify the correct usage of type and sourceType fields.

How to Use

To ensure your custom groups and properties are recognized:

  • Always specify both type and sourceType for your group.
  • Add the same sourceType to each property belonging to the group.
  • Prefix property names with the group name.

Example:

{
  "groups": [
    {
      "name": "audit.javers",
      "type": "audit.JaversProperties",
      "sourceType": "audit.JaversProperties"
    }
  ],
  "properties": [
    {
      "name": "audit.javers.enabled",
      "type": "java.lang.Boolean",
      "defaultValue": true,
      "description": "Whether Javers audit logging is enabled.",
      "sourceType": "audit.JaversProperties"
    }
  ]
}

@nandorholozsnyak nandorholozsnyak merged commit c7ceb76 into master Aug 20, 2025
2 checks passed
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.

Unknown group when using additional-spring-configuration-metadata.json
1 participant