Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to OpenApi Java extension about apiContextIdListing limitations #3082

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.

3 changes: 3 additions & 0 deletions extensions/openapi-java/runtime/src/main/doc/limitations.adoc
Original file line number Diff line number Diff line change
@@ -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.