You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by dj...@apache.org on 2021/11/03 21:14:56 UTC
[camel-spring-boot] branch main updated (fee0a0d -> 05d2461)
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git.
from fee0a0d [create-pull-request] automated change
new b73f8e5 remove unused unneeded formerly generated .adoc files
new 05d2461 add explanation of what to do to the error list section
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../src/main/docs/openapi-java-starter.adoc | 29 ----------------------
.../src/main/docs/springdoc-starter.adoc | 29 ----------------------
.../spring-boot/partials/openapi-java-starter.adoc | 29 ----------------------
docs/spring-boot/modules/ROOT/pages/list.adoc | 9 +++++++
4 files changed, 9 insertions(+), 87 deletions(-)
delete mode 100644 components-starter/camel-openapi-java-starter/src/main/docs/openapi-java-starter.adoc
delete mode 100644 components-starter/camel-springdoc-starter/src/main/docs/springdoc-starter.adoc
delete mode 100644 docs/components/modules/spring-boot/partials/openapi-java-starter.adoc
[camel-spring-boot] 01/02: remove unused unneeded formerly
generated .adoc files
Posted by dj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit b73f8e54a93052a6c6976fe56cf11755b20f4f52
Author: David Jencks <dj...@apache.org>
AuthorDate: Wed Nov 3 13:57:26 2021 -0700
remove unused unneeded formerly generated .adoc files
---
.../src/main/docs/openapi-java-starter.adoc | 29 ----------------------
.../src/main/docs/springdoc-starter.adoc | 29 ----------------------
.../spring-boot/partials/openapi-java-starter.adoc | 29 ----------------------
3 files changed, 87 deletions(-)
diff --git a/components-starter/camel-openapi-java-starter/src/main/docs/openapi-java-starter.adoc b/components-starter/camel-openapi-java-starter/src/main/docs/openapi-java-starter.adoc
deleted file mode 100644
index 4306df8..0000000
--- a/components-starter/camel-openapi-java-starter/src/main/docs/openapi-java-starter.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-// spring-boot-auto-configure options: START
-:page-partial:
-:doctitle: Camel Spring Boot Starter for openapi-java
-
-== Spring Boot Auto-Configuration
-
-When using openapi-java with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
-
-[source,xml]
-----
-<dependency>
- <groupId>org.apache.camel.springboot</groupId>
- <artifactId>camel-openapi-java-starter</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-----
-
-
-The component supports 1 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *camel.openapi.enabled* | Enables Camel Rest DSL to automatic register its OpenAPI (eg swagger doc) in Spring Boot which allows tooling such as SpringDoc to integrate with Camel. | true | Boolean
-|===
-// spring-boot-auto-configure options: END
diff --git a/components-starter/camel-springdoc-starter/src/main/docs/springdoc-starter.adoc b/components-starter/camel-springdoc-starter/src/main/docs/springdoc-starter.adoc
deleted file mode 100644
index fb8c136..0000000
--- a/components-starter/camel-springdoc-starter/src/main/docs/springdoc-starter.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-// spring-boot-auto-configure options: START
-:page-partial:
-:doctitle: Camel Spring Boot Starter for extending openapi-java with the Springdoc UI
-
-== Spring Boot Auto-Configuration
-
-When using openapi-java with Spring Boot, if you want to use the Springdoc Swagger UI, make sure to use the following Maven dependency to have support for auto-configuration:
-
-[source,xml]
-----
-<dependency>
- <groupId>org.apache.camel.springboot</groupId>
- <artifactId>camel-springdoc-starter</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-----
-
-
-The component supports 1 option, which is listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *camel.springdoc.enabled* | Enables Camel Rest DSL to automatic register its OpenAPI (eg swagger doc) in Spring Boot which allows tooling such as SpringDoc to integrate with Camel. | true | Boolean
-|===
-// spring-boot-auto-configure options: END
diff --git a/docs/components/modules/spring-boot/partials/openapi-java-starter.adoc b/docs/components/modules/spring-boot/partials/openapi-java-starter.adoc
deleted file mode 100644
index 4306df8..0000000
--- a/docs/components/modules/spring-boot/partials/openapi-java-starter.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-// spring-boot-auto-configure options: START
-:page-partial:
-:doctitle: Camel Spring Boot Starter for openapi-java
-
-== Spring Boot Auto-Configuration
-
-When using openapi-java with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
-
-[source,xml]
-----
-<dependency>
- <groupId>org.apache.camel.springboot</groupId>
- <artifactId>camel-openapi-java-starter</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-----
-
-
-The component supports 1 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *camel.openapi.enabled* | Enables Camel Rest DSL to automatic register its OpenAPI (eg swagger doc) in Spring Boot which allows tooling such as SpringDoc to integrate with Camel. | true | Boolean
-|===
-// spring-boot-auto-configure options: END
[camel-spring-boot] 02/02: add explanation of what to do to the
error list section
Posted by dj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit 05d246166837a454f19a9e4a3a737077f53845c9
Author: David Jencks <dj...@apache.org>
AuthorDate: Wed Nov 3 14:13:01 2021 -0700
add explanation of what to do to the error list section
---
docs/spring-boot/modules/ROOT/pages/list.adoc | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/spring-boot/modules/ROOT/pages/list.adoc b/docs/spring-boot/modules/ROOT/pages/list.adoc
index d001f08..afe70a0 100644
--- a/docs/spring-boot/modules/ROOT/pages/list.adoc
+++ b/docs/spring-boot/modules/ROOT/pages/list.adoc
@@ -18,6 +18,15 @@ ifdef::sb-statistics[]
include::Error-unused-starter-json.adoc[]
+If this section appears in the (failed) website build, there is a mismatch between the camel spring boot starter json files, which are used to generate the spring-boot section of main camel component documentation, and the names used in those main camel component documentation pages.
+The names of the unused spring boot starter json files are listed below.
+Each of these needs to be used in a component doc page as the `camel-spring-boot-name` header attribute, like this:
+
+[source,adoc]
+----
+:camel-spring-boot-name: springdoc
+----
+
There are {existing} spring boot starter json files.
Of these {used} are used in components, dataformats, etc.