You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by GitBox <gi...@apache.org> on 2022/02/07 09:16:45 UTC
[GitHub] [camel-quarkus] jamesnetherton commented on a change in pull request #3481: Fix #3251 expose REST DSL services to quarkus openapis
jamesnetherton commented on a change in pull request #3481:
URL: https://github.com/apache/camel-quarkus/pull/3481#discussion_r800446355
##########
File path: docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
##########
@@ -39,6 +39,26 @@ 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.
+== Usage
+
+You can use this extension to expose REST DSL services to quarkus openapi. With
Review comment:
```suggestion
You can use this extension to expose REST DSL services to Quarkus OpenAPI. With
```
##########
File path: docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
##########
@@ -39,6 +39,26 @@ 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.
+== Usage
Review comment:
You can move the usage content into `usage.adoc` and there's some [smart logic](https://camel.apache.org/camel-quarkus/2.7.x/contributor-guide/extension-documentation.html) in one of the maven plugins which will combine it into the extension docs.
##########
File path: docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
##########
@@ -39,6 +39,26 @@ 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.
+== Usage
+
+You can use this extension to expose REST DSL services to quarkus openapi. With
+the `quarkus-smallrye-openapi`, you can access them by `/q/openapi?format=json`.
+
+Refer to the https://quarkus.io/guides/openapi-swaggerui[Quarkus OpenAPI guide] for further information.
+
+By default, this experimental feature disable. You can enable it by
Review comment:
```suggestion
This is an experimental feature disable. You can enable it by
```
##########
File path: docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
##########
@@ -39,6 +39,26 @@ 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.
+== Usage
+
+You can use this extension to expose REST DSL services to quarkus openapi. With
+the `quarkus-smallrye-openapi`, you can access them by `/q/openapi?format=json`.
+
+Refer to the https://quarkus.io/guides/openapi-swaggerui[Quarkus OpenAPI guide] for further information.
+
+By default, this experimental feature disable. You can enable it by
+[source, properties]
+----
+quarkus.camel.openapi.expose.enabled=true
+----
+
+[WARNING]
+====
+It doesn't support the rests services used in `org.apache.camel.builder.LambdaRouteBuilder` right now.
+Also, it can not use CDI injection in the RouteBuilder `configure()` since we get the rest definitions at build time while the CDI is unavailable.
Review comment:
```suggestion
Also, it can not use CDI injection in the RouteBuilder `configure()` since we get the rest definitions at build time while CDI is unavailable.
```
##########
File path: docs/modules/ROOT/pages/reference/extensions/openapi-java.adoc
##########
@@ -39,6 +39,26 @@ 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.
+== Usage
+
+You can use this extension to expose REST DSL services to quarkus openapi. With
+the `quarkus-smallrye-openapi`, you can access them by `/q/openapi?format=json`.
Review comment:
```suggestion
`quarkus-smallrye-openapi`, you can access them by `/q/openapi?format=json`.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org