[camel] branch main updated: Add note to doc about need for a platform http provider/engine

[da...@apache.org]

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 87b8d36  Add note to doc about need for a platform http provider/engine
87b8d36 is described below

commit 87b8d36c3ba9bbb2bd9244a930661206ccabbba9
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Nov 3 10:00:30 2021 +0100

    Add note to doc about need for a platform http provider/engine
---
 .../src/main/docs/platform-http-component.adoc     | 23 +++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/components/camel-platform-http/src/main/docs/platform-http-component.adoc b/components/camel-platform-http/src/main/docs/platform-http-component.adoc
index 00f8dfa..9be0725 100644
--- a/components/camel-platform-http/src/main/docs/platform-http-component.adoc
+++ b/components/camel-platform-http/src/main/docs/platform-http-component.adoc
@@ -14,12 +14,10 @@ include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/platform-h
 
 *{component-header}*
 
-
 The Platform HTTP is used to allow Camel to use the existing HTTP server from the runtime.
 For example when running Camel on Spring Boot, Quarkus, or other runtimes.
 
-Maven users will need to add the following dependency to their `pom.xml`
-for this component:
+Maven users will need to add the following dependency to their `pom.xml` for this component:
 
 [source,xml]
 ----
@@ -31,6 +29,25 @@ for this component:
 </dependency>
 ----
 
+== Platform HTTP Provider
+
+To use Platform HTTP a provider (engine) is required to be available on the classpath.
+The purpose is to have drivers for different runtimes such as Quarkus, VertX, or Spring Boot.
+
+At this moment there is only support for Quarkus and VertX by `camel-platform-http-vertx`.
+This JAR must be on the classpath otherwise the Platform HTTP component cannot be used and an
+exception will be thrown on startup.
+
+[source,xml]
+----
+<dependency>
+    <groupId>org.apache.camel</groupId>
+    <artifactId>camel-platform-http-vertx</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+----
+
 // component-configure options: START
 
 // component-configure options: END