Add documentation to OpenApi Java extension about apiContextIdListing…

… limitations
apache · Sep 9, 2021 · f82c0ea · f82c0ea
1 parent 8382127
commit f82c0ea
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git 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
@@ -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.