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
The following commit(s) were added to refs/heads/main by this push:
new 2b088d37475 doc: Improve CoAP component description (#14420)
2b088d37475 is described below
commit 2b088d37475c9af9223806da203eaab3f1e6f586
Author: Aurélien Pupier <[email protected]>
AuthorDate: Tue Jun 11 13:21:41 2024 +0200
doc: Improve CoAP component description (#14420)
Signed-off-by: Aurélien Pupier <[email protected]>
---
.../apache/camel/catalog/components/coap+tcp.json | 2 +-
.../org/apache/camel/catalog/components/coap.json | 2 +-
.../apache/camel/catalog/components/coaps+tcp.json | 2 +-
.../org/apache/camel/catalog/components/coaps.json | 2 +-
.../META-INF/org/apache/camel/coap/coap+tcp.json | 2 +-
.../META-INF/org/apache/camel/coap/coap.json | 2 +-
.../META-INF/org/apache/camel/coap/coaps+tcp.json | 2 +-
.../META-INF/org/apache/camel/coap/coaps.json | 2 +-
.../camel-coap/src/main/docs/coap-component.adoc | 2 +-
.../java/org/apache/camel/coap/CoAPEndpoint.java | 2 +-
.../builder/component/ComponentsBuilderFactory.java | 12 ++++++++----
.../component/dsl/CoapComponentBuilderFactory.java | 6 ++++--
.../dsl/CoapTcpComponentBuilderFactory.java | 6 ++++--
.../component/dsl/CoapsComponentBuilderFactory.java | 6 ++++--
.../dsl/CoapsTcpComponentBuilderFactory.java | 6 ++++--
.../builder/endpoint/StaticEndpointBuilders.java | 15 ++++++++++-----
.../endpoint/dsl/CoAPEndpointBuilderFactory.java | 21 ++++++++++++++-------
.../apache/camel/kotlin/components/CoapUriDsl.kt | 2 +-
18 files changed, 59 insertions(+), 35 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap+tcp.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap+tcp.json
index d31065b6fd9..d8c62342a45 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap+tcp.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap+tcp.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coap+tcp",
"title": "CoAP",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap.json
index b047b5b9578..43519f789bf 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coap.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coap",
"title": "CoAP",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps+tcp.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps+tcp.json
index 7694aff1e7f..a3f18c78073 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps+tcp.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps+tcp.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coaps+tcp",
"title": "CoAP",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps.json
index 9d81d63d579..27019fe41f9 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/coaps.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coaps",
"title": "CoAP (Secure)",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap+tcp.json
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap+tcp.json
index d31065b6fd9..d8c62342a45 100644
---
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap+tcp.json
+++
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap+tcp.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coap+tcp",
"title": "CoAP",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap.json
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap.json
index b047b5b9578..43519f789bf 100644
---
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap.json
+++
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coap.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coap",
"title": "CoAP",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps+tcp.json
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps+tcp.json
index 7694aff1e7f..a3f18c78073 100644
---
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps+tcp.json
+++
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps+tcp.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coaps+tcp",
"title": "CoAP",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps.json
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps.json
index 9d81d63d579..27019fe41f9 100644
---
a/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps.json
+++
b/components/camel-coap/src/generated/resources/META-INF/org/apache/camel/coap/coaps.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "coaps",
"title": "CoAP (Secure)",
- "description": "Send and receive messages to\/from COAP capable devices.",
+ "description": "Send and receive messages to\/from CoAP (Constrained
Application Protocol) capable devices.",
"deprecated": false,
"firstVersion": "2.16.0",
"label": "iot",
diff --git a/components/camel-coap/src/main/docs/coap-component.adoc
b/components/camel-coap/src/main/docs/coap-component.adoc
index 00a386750f0..21b10b53a2f 100644
--- a/components/camel-coap/src/main/docs/coap-component.adoc
+++ b/components/camel-coap/src/main/docs/coap-component.adoc
@@ -2,7 +2,7 @@
:doctitle: CoAP
:shortname: coap
:artifactid: camel-coap
-:description: Send and receive messages to/from COAP capable devices.
+:description: Send and receive messages to/from CoAP (Constrained Application
Protocol) capable devices.
:since: 2.16
:supportlevel: Stable
:tabs-sync-option:
diff --git
a/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
b/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
index 3ff695554e2..3024d4d4009 100644
---
a/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
+++
b/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java
@@ -72,7 +72,7 @@ import static
org.eclipse.californium.scandium.config.DtlsConfig.DTLS_CLIENT_AUT
import static
org.eclipse.californium.scandium.config.DtlsConfig.DTLS_RECOMMENDED_CIPHER_SUITES_ONLY;
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
capable devices.
*/
@UriEndpoint(firstVersion = "2.16.0", scheme =
"coap,coaps,coap+tcp,coaps+tcp", title = "CoAP", syntax = "coap:uri",
category = { Category.IOT }, headersClass = CoAPConstants.class)
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
index 2800a975d0d..2c23f0d80dd 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
@@ -820,7 +820,8 @@ public interface ComponentsBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -833,7 +834,8 @@ public interface ComponentsBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -846,7 +848,8 @@ public interface ComponentsBuilderFactory {
}
/**
* CoAP (Secure) (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -859,7 +862,8 @@ public interface ComponentsBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapComponentBuilderFactory.java
index e36e84962d7..8fd1902e1b6 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapComponentBuilderFactory.java
@@ -24,7 +24,8 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.coap.CoAPComponent;
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
+ * capable devices.
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -33,7 +34,8 @@ public interface CoapComponentBuilderFactory {
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapTcpComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapTcpComponentBuilderFactory.java
index 9dcb10c8cb4..01c311ded81 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapTcpComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapTcpComponentBuilderFactory.java
@@ -24,7 +24,8 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.coap.CoAPComponent;
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
+ * capable devices.
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -33,7 +34,8 @@ public interface CoapTcpComponentBuilderFactory {
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsComponentBuilderFactory.java
index 1234f370e5a..c16bda967f6 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsComponentBuilderFactory.java
@@ -24,7 +24,8 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.coap.CoAPComponent;
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
+ * capable devices.
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -33,7 +34,8 @@ public interface CoapsComponentBuilderFactory {
/**
* CoAP (Secure) (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsTcpComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsTcpComponentBuilderFactory.java
index 0030d53e7a9..fd326e3096d 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsTcpComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/CoapsTcpComponentBuilderFactory.java
@@ -24,7 +24,8 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.coap.CoAPComponent;
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
+ * capable devices.
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -33,7 +34,8 @@ public interface CoapsTcpComponentBuilderFactory {
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index 6df28f8a170..db653f9da77 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -2604,7 +2604,8 @@ public class StaticEndpointBuilders {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -2623,7 +2624,8 @@ public class StaticEndpointBuilders {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -2644,7 +2646,8 @@ public class StaticEndpointBuilders {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -2663,7 +2666,8 @@ public class StaticEndpointBuilders {
}
/**
* CoAP (Secure) (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
@@ -2682,7 +2686,8 @@ public class StaticEndpointBuilders {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
Protocol)
+ * capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CoAPEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CoAPEndpointBuilderFactory.java
index 72d85bc0ce6..722636996c7 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CoAPEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/CoAPEndpointBuilderFactory.java
@@ -27,7 +27,8 @@ import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
+ * capable devices.
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -1168,7 +1169,8 @@ public interface CoAPEndpointBuilderFactory {
public interface CoAPBuilders {
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
+ * Protocol) capable devices.
*
* Category: iot
* Since: 2.16
@@ -1181,7 +1183,8 @@ public interface CoAPEndpointBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
+ * Protocol) capable devices.
*
* Category: iot
* Since: 2.16
@@ -1200,7 +1203,8 @@ public interface CoAPEndpointBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
+ * Protocol) capable devices.
*
* Category: iot
* Since: 2.16
@@ -1221,7 +1225,8 @@ public interface CoAPEndpointBuilderFactory {
}
/**
* CoAP (Secure) (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
+ * Protocol) capable devices.
*
* Category: iot
* Since: 2.16
@@ -1240,7 +1245,8 @@ public interface CoAPEndpointBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
+ * Protocol) capable devices.
*
* Category: iot
* Since: 2.16
@@ -1259,7 +1265,8 @@ public interface CoAPEndpointBuilderFactory {
}
/**
* CoAP (camel-coap)
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application
+ * Protocol) capable devices.
*
* Category: iot
* Since: 2.16
diff --git
a/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/CoapUriDsl.kt
b/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/CoapUriDsl.kt
index 342d4e9171f..f502cb2b570 100644
---
a/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/CoapUriDsl.kt
+++
b/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/CoapUriDsl.kt
@@ -23,7 +23,7 @@ import org.apache.camel.kotlin.CamelDslMarker
import org.apache.camel.kotlin.UriDsl
/**
- * Send and receive messages to/from COAP capable devices.
+ * Send and receive messages to/from CoAP (Constrained Application Protocol)
capable devices.
*/
public fun UriDsl.coap(i: CoapUriDsl.() -> Unit) {
CoapUriDsl(this).apply(i)
