Rework @ConfigDocSections in Hibernate Search extension documentation

Remove unnecessary delimitations for the persistence unit sections (almost everything is per-persistence unit anyway), and add sections for more exotic use cases (per-index config).
quarkusio · Jun 29, 2023 · 21f56c4 · 21f56c4
1 parent dc06074
commit 21f56c4
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 11 deletions.
diff --git a/...rch/orm/coordination/outboxpolling/runtime/HibernateSearchOutboxPollingRuntimeConfig.java b/...rch/orm/coordination/outboxpolling/runtime/HibernateSearchOutboxPollingRuntimeConfig.java
@@ -4,7 +4,6 @@
 
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
-import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.smallrye.config.ConfigMapping;
@@ -18,7 +17,6 @@ public interface HibernateSearchOutboxPollingRuntimeConfig {
     /**
      * Configuration for persistence units.
      */
-    @ConfigDocSection
     @WithParentName
     @WithUnnamedKey(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME)
     @ConfigDocMapKey("persistence-unit-name")

diff --git a/...ation/outboxpolling/runtime/HibernateSearchOutboxPollingRuntimeConfigPersistenceUnit.java b/...ation/outboxpolling/runtime/HibernateSearchOutboxPollingRuntimeConfigPersistenceUnit.java
@@ -24,14 +24,13 @@ public interface HibernateSearchOutboxPollingRuntimeConfigPersistenceUnit {
     interface CoordinationConfig {
 
         /**
-         * Default config
+         * Default configuration.
          */
-        @ConfigDocSection
         @WithParentName
         AgentsConfig defaults();
 
         /**
-         * Per-tenant config
+         * Per-tenant configuration overrides.
          */
         @ConfigDocSection
         @ConfigDocMapKey("tenant-id")

diff --git a/...bernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchBuildTimeConfig.java b/...bernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchBuildTimeConfig.java
@@ -4,7 +4,6 @@
 
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
-import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.smallrye.config.ConfigMapping;
@@ -31,7 +30,6 @@ public interface HibernateSearchElasticsearchBuildTimeConfig {
     /**
      * Configuration for persistence units.
      */
-    @ConfigDocSection
     @WithParentName
     @WithUnnamedKey(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME)
     @ConfigDocMapKey("persistence-unit-name")

diff --git a/...orm/elasticsearch/runtime/HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.java b/...orm/elasticsearch/runtime/HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit.java
@@ -80,8 +80,9 @@ interface ElasticsearchBackendBuildTimeConfig {
         ElasticsearchIndexBuildTimeConfig indexDefaults();
 
         /**
-         * Per-index specific configuration.
+         * Per-index configuration overrides.
          */
+        @ConfigDocSection
         @ConfigDocMapKey("index-name")
         Map<String, ElasticsearchIndexBuildTimeConfig> indexes();
     }

diff --git a/...hibernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchRuntimeConfig.java b/...hibernate/search/orm/elasticsearch/runtime/HibernateSearchElasticsearchRuntimeConfig.java
@@ -5,7 +5,6 @@
 
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
-import io.quarkus.runtime.annotations.ConfigDocSection;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.smallrye.config.ConfigMapping;
@@ -19,7 +18,6 @@ public interface HibernateSearchElasticsearchRuntimeConfig {
     /**
      * Configuration for persistence units.
      */
-    @ConfigDocSection
     @WithParentName
     @WithUnnamedKey(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME)
     @ConfigDocMapKey("persistence-unit-name")

diff --git a/...h/orm/elasticsearch/runtime/HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.java b/...h/orm/elasticsearch/runtime/HibernateSearchElasticsearchRuntimeConfigPersistenceUnit.java
@@ -166,8 +166,9 @@ interface ElasticsearchBackendRuntimeConfig {
         ElasticsearchIndexRuntimeConfig indexDefaults();
 
         /**
-         * Per-index specific configuration.
+         * Per-index configuration overrides.
          */
+        @ConfigDocSection
         @ConfigDocMapKey("index-name")
         Map<String, ElasticsearchIndexRuntimeConfig> indexes();
     }