This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/main by this push:
new f82c0ea Add documentation to OpenApi Java extension about
apiContextIdListing limitations
f82c0ea is described below
commit f82c0ea737e91050f4187c2cb8dd35c5848903e2
Author: James Netherton <[email protected]>
AuthorDate: Thu Sep 9 09:25:43 2021 +0100
Add documentation to OpenApi Java extension about apiContextIdListing
limitations
---
docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc | 7 +++++++
extensions/openapi-java/runtime/src/main/doc/limitations.adoc | 3 +++
2 files changed, 10 insertions(+)
diff --git a/docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
b/docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
index a9df44a..c579bbd 100644
--- a/docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
@@ -38,3 +38,10 @@ Or add the coordinates to your existing project:
----
Check the xref:user-guide/index.adoc[User guide] for more information about
writing Camel Quarkus applications.
+
+== Camel Quarkus limitations
+
+The `apiContextIdListing` configuration option is not supported. Since
multiple `CamelContext`s are not supported and Quarkus applications run
standalone, there
+is no scenario where attempting to resolve OpenApi specifications for a
specific `CamelContext` would be useful. It also introduces some additional
overhead of
+requiring JMX (which is not supported in native mode) & additional Camel
Quarkus extensions for processing XML.
+
diff --git a/extensions/openapi-java/runtime/src/main/doc/limitations.adoc
b/extensions/openapi-java/runtime/src/main/doc/limitations.adoc
new file mode 100644
index 0000000..c63c443
--- /dev/null
+++ b/extensions/openapi-java/runtime/src/main/doc/limitations.adoc
@@ -0,0 +1,3 @@
+The `apiContextIdListing` configuration option is not supported. Since
multiple `CamelContext`s are not supported and Quarkus applications run
standalone, there
+is no scenario where attempting to resolve OpenApi specifications for a
specific `CamelContext` would be useful. It also introduces some additional
overhead of
+requiring JMX (which is not supported in native mode) & additional Camel
Quarkus extensions for processing XML.