You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/06/24 08:41:19 UTC

[camel] 01/02: CAMEL-16753: camel-main docs polish group descriptions

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git

commit c893c4912887bbb87a2756e52def328e4ba9399d
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Jun 24 10:20:32 2021 +0200

    CAMEL-16753: camel-main docs polish group descriptions
---
 .../camel-main-configuration-metadata.json         | 16 ++++++------
 .../maven/packaging/PrepareCamelMainMojo.java      | 30 ++++++++++++----------
 2 files changed, 25 insertions(+), 21 deletions(-)

diff --git a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
index 2b11917..169abd9 100644
--- a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
+++ b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -1,13 +1,13 @@
 {
   "groups": [
-    { "name": "camel.main", "description": "camel-main configurations.", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties" },
-    { "name": "camel.faulttolerance", "description": "camel-fault-tolerance configurations.", "sourceType": "org.apache.camel.main.FaultToleranceConfigurationProperties" },
-    { "name": "camel.hystrix", "description": "camel-hystrix configurations.", "sourceType": "org.apache.camel.main.HystrixConfigurationProperties" },
-    { "name": "camel.resilience4j", "description": "camel-resilience4j configurations.", "sourceType": "org.apache.camel.main.Resilience4jConfigurationProperties" },
-    { "name": "camel.rest", "description": "camel-rest configurations.", "sourceType": "org.apache.camel.spi.RestConfiguration" },
-    { "name": "camel.health", "description": "camel-health configurations.", "sourceType": "org.apache.camel.main.HealthConfigurationProperties" },
-    { "name": "camel.lra", "description": "camel-lra configurations.", "sourceType": "org.apache.camel.main.LraConfigurationProperties" },
-    { "name": "camel.threadpool", "description": "camel-threadpool configurations.", "sourceType": "org.apache.camel.main.ThreadPoolConfigurationProperties" }
+    { "name": "camel.main", "description": "General Camel configurations", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties" },
+    { "name": "camel.threadpool", "description": "Camel thread pool configurations", "sourceType": "org.apache.camel.main.ThreadPoolConfigurationProperties" },
+    { "name": "camel.health", "description": "Camel Health Check configurations", "sourceType": "org.apache.camel.main.HealthConfigurationProperties" },
+    { "name": "camel.rest", "description": "Camel Rest-DSL configurations", "sourceType": "org.apache.camel.spi.RestConfiguration" },
+    { "name": "camel.faulttolerance", "description": "Fault Tolerance circuit breaker configurations", "sourceType": "org.apache.camel.main.FaultToleranceConfigurationProperties" },
+    { "name": "camel.resilience4j", "description": "Resilience4j circuit breaker configurations", "sourceType": "org.apache.camel.main.Resilience4jConfigurationProperties" },
+    { "name": "camel.hystrix", "description": "Hystrix (deprecated) circuit breaker configurations", "sourceType": "org.apache.camel.main.HystrixConfigurationProperties" },
+    { "name": "camel.lra", "description": "Camel Saga EIP (Long Running Actions) configurations", "sourceType": "org.apache.camel.main.LraConfigurationProperties" }
   ],
   "properties": [
     { "name": "camel.main.allowUseOriginalMessage", "description": "Sets whether to allow access to the original message from Camel's error handler, or from org.apache.camel.spi.UnitOfWork.getOriginalInMessage(). Turning this off can optimize performance, as defensive copy of the original message is not needed. Default is false.", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelMainMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelMainMojo.java
index 9e57b8c..42d7c95 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelMainMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelMainMojo.java
@@ -241,27 +241,31 @@ public class PrepareCamelMainMojo extends AbstractGeneratorMojo {
             MainModel model = new MainModel();
             model.getOptions().addAll(data);
             model.getGroups().add(new MainGroupModel(
-                    "camel.main", "camel-main configurations.", "org.apache.camel.main.DefaultConfigurationProperties"));
+                    "camel.main", "General Camel configurations", "org.apache.camel.main.DefaultConfigurationProperties"));
             model.getGroups()
                     .add(new MainGroupModel(
-                            "camel.faulttolerance", "camel-fault-tolerance configurations.",
-                            "org.apache.camel.main.FaultToleranceConfigurationProperties"));
+                            "camel.threadpool", "Camel thread pool configurations",
+                            "org.apache.camel.main.ThreadPoolConfigurationProperties"));
             model.getGroups().add(new MainGroupModel(
-                    "camel.hystrix", "camel-hystrix configurations.", "org.apache.camel.main.HystrixConfigurationProperties"));
+                    "camel.health", "Camel Health Check configurations",
+                    "org.apache.camel.main.HealthConfigurationProperties"));
+            model.getGroups().add(
+                    new MainGroupModel(
+                            "camel.rest", "Camel Rest-DSL configurations", "org.apache.camel.spi.RestConfiguration"));
+            model.getGroups()
+                    .add(new MainGroupModel(
+                            "camel.faulttolerance", "Fault Tolerance circuit breaker configurations",
+                            "org.apache.camel.main.FaultToleranceConfigurationProperties"));
             model.getGroups()
                     .add(new MainGroupModel(
-                            "camel.resilience4j", "camel-resilience4j configurations.",
+                            "camel.resilience4j", "Resilience4j circuit breaker configurations",
                             "org.apache.camel.main.Resilience4jConfigurationProperties"));
-            model.getGroups().add(
-                    new MainGroupModel("camel.rest", "camel-rest configurations.", "org.apache.camel.spi.RestConfiguration"));
             model.getGroups().add(new MainGroupModel(
-                    "camel.health", "camel-health configurations.", "org.apache.camel.main.HealthConfigurationProperties"));
+                    "camel.hystrix", "Hystrix (deprecated) circuit breaker configurations",
+                    "org.apache.camel.main.HystrixConfigurationProperties"));
             model.getGroups().add(new MainGroupModel(
-                    "camel.lra", "camel-lra configurations.", "org.apache.camel.main.LraConfigurationProperties"));
-            model.getGroups()
-                    .add(new MainGroupModel(
-                            "camel.threadpool", "camel-threadpool configurations.",
-                            "org.apache.camel.main.ThreadPoolConfigurationProperties"));
+                    "camel.lra", "Camel Saga EIP (Long Running Actions) configurations",
+                    "org.apache.camel.main.LraConfigurationProperties"));
 
             String json = JsonMapper.createJsonSchema(model);