You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2023/01/03 08:47:12 UTC
[camel] branch main updated: CAMEL-18853: camel-swagger-java - Deprecate
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 80b35743c4a CAMEL-18853: camel-swagger-java - Deprecate
80b35743c4a is described below
commit 80b35743c4aeff3a03caaa6b05a0d1851a268262
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Jan 3 09:47:00 2023 +0100
CAMEL-18853: camel-swagger-java - Deprecate
---
.../resources/org/apache/camel/catalog/others/swagger-java.json | 2 +-
components/camel-swagger-java/pom.xml | 2 +-
.../resources/META-INF/services/org/apache/camel/other.properties | 2 +-
.../camel-swagger-java/src/generated/resources/swagger-java.json | 2 +-
components/camel-swagger-java/src/main/docs/swagger-java.adoc | 5 +++--
.../org/apache/camel/swagger/ExchangeRestApiResponseAdapter.java | 1 +
.../main/java/org/apache/camel/swagger/RestApiResponseAdapter.java | 1 +
.../src/main/java/org/apache/camel/swagger/RestModelConverters.java | 1 +
.../src/main/java/org/apache/camel/swagger/RestSwaggerProcessor.java | 1 +
.../src/main/java/org/apache/camel/swagger/RestSwaggerReader.java | 1 +
.../src/main/java/org/apache/camel/swagger/RestSwaggerSupport.java | 1 +
.../src/main/java/org/apache/camel/swagger/SwaggerHelper.java | 1 +
.../org/apache/camel/swagger/SwaggerRestApiProcessorFactory.java | 1 +
.../java/org/apache/camel/swagger/SwaggerRestProducerFactory.java | 1 +
tooling/maven/camel-restdsl-swagger-plugin/pom.xml | 2 +-
.../src/main/docs/camel-restdsl-swagger-plugin.adoc | 4 +++-
.../apache/camel/maven/generator/swagger/AbstractGenerateMojo.java | 1 +
.../java/org/apache/camel/maven/generator/swagger/GenerateMojo.java | 1 +
.../apache/camel/maven/generator/swagger/GenerateWithDtoMojo.java | 1 +
.../org/apache/camel/maven/generator/swagger/GenerateXmlMojo.java | 1 +
.../apache/camel/maven/generator/swagger/GenerateXmlWithDtoMojo.java | 1 +
21 files changed, 25 insertions(+), 8 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/swagger-java.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/swagger-java.json
index 70de5701671..b62f15f5780 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/swagger-java.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/swagger-java.json
@@ -4,7 +4,7 @@
"name": "swagger-java",
"title": "Swagger Java",
"description": "Rest-dsl support for using swagger api-doc",
- "deprecated": false,
+ "deprecated": true,
"firstVersion": "2.16.0",
"label": "rest,api",
"supportLevel": "Stable",
diff --git a/components/camel-swagger-java/pom.xml b/components/camel-swagger-java/pom.xml
index 2d617698518..c01d407eff8 100644
--- a/components/camel-swagger-java/pom.xml
+++ b/components/camel-swagger-java/pom.xml
@@ -29,7 +29,7 @@
<artifactId>camel-swagger-java</artifactId>
<packaging>jar</packaging>
- <name>Camel :: Swagger Java</name>
+ <name>Camel :: Swagger Java (deprecated)</name>
<description>Rest-dsl support for using swagger api-doc</description>
<properties>
diff --git a/components/camel-swagger-java/src/generated/resources/META-INF/services/org/apache/camel/other.properties b/components/camel-swagger-java/src/generated/resources/META-INF/services/org/apache/camel/other.properties
index c74e271fe2b..6d5cadc881b 100644
--- a/components/camel-swagger-java/src/generated/resources/META-INF/services/org/apache/camel/other.properties
+++ b/components/camel-swagger-java/src/generated/resources/META-INF/services/org/apache/camel/other.properties
@@ -3,5 +3,5 @@ name=swagger-java
groupId=org.apache.camel
artifactId=camel-swagger-java
version=3.21.0-SNAPSHOT
-projectName=Camel :: Swagger Java
+projectName=Camel :: Swagger Java (deprecated)
projectDescription=Rest-dsl support for using swagger api-doc
diff --git a/components/camel-swagger-java/src/generated/resources/swagger-java.json b/components/camel-swagger-java/src/generated/resources/swagger-java.json
index 70de5701671..b62f15f5780 100644
--- a/components/camel-swagger-java/src/generated/resources/swagger-java.json
+++ b/components/camel-swagger-java/src/generated/resources/swagger-java.json
@@ -4,7 +4,7 @@
"name": "swagger-java",
"title": "Swagger Java",
"description": "Rest-dsl support for using swagger api-doc",
- "deprecated": false,
+ "deprecated": true,
"firstVersion": "2.16.0",
"label": "rest,api",
"supportLevel": "Stable",
diff --git a/components/camel-swagger-java/src/main/docs/swagger-java.adoc b/components/camel-swagger-java/src/main/docs/swagger-java.adoc
index 870b97df4e9..0d0d022dfcf 100644
--- a/components/camel-swagger-java/src/main/docs/swagger-java.adoc
+++ b/components/camel-swagger-java/src/main/docs/swagger-java.adoc
@@ -1,10 +1,11 @@
-= Swagger Java Component
+= Swagger Java Component (deprecated)
:doctitle: Swagger Java
:shortname: swagger-java
:artifactid: camel-swagger-java
:description: Rest-dsl support for using swagger api-doc
:since: 2.16
-:supportlevel: Stable
+:supportlevel: Stable-deprecated
+:deprecated: *deprecated*
//Manually maintained attributes
:camel-spring-boot-name: swagger-java
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/ExchangeRestApiResponseAdapter.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/ExchangeRestApiResponseAdapter.java
index 5ef03e016a5..f4d7fa79801 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/ExchangeRestApiResponseAdapter.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/ExchangeRestApiResponseAdapter.java
@@ -20,6 +20,7 @@ import java.io.IOException;
import org.apache.camel.Exchange;
+@Deprecated
public class ExchangeRestApiResponseAdapter implements RestApiResponseAdapter {
private final Exchange exchange;
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestApiResponseAdapter.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestApiResponseAdapter.java
index 4ffb44479c6..a2160515c80 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestApiResponseAdapter.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestApiResponseAdapter.java
@@ -18,6 +18,7 @@ package org.apache.camel.swagger;
import java.io.IOException;
+@Deprecated
public interface RestApiResponseAdapter {
void setHeader(String name, String value);
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java
index a59accf5c22..c3b3a50db64 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java
@@ -25,6 +25,7 @@ import io.swagger.models.properties.StringProperty;
/**
* A ModelConverter appends vendor extensions to include the java class name of the model classes.
*/
+@Deprecated
public class RestModelConverters {
public Map<String, Model> readClass(Class clazz) {
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerProcessor.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerProcessor.java
index 12bdecfdd66..258ff3ac536 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerProcessor.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerProcessor.java
@@ -27,6 +27,7 @@ import org.apache.camel.spi.RestConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+@Deprecated
public class RestSwaggerProcessor implements Processor {
private static final Logger LOG = LoggerFactory.getLogger(RestSwaggerProcessor.class);
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
index 3ec642686aa..5237742a02a 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
@@ -85,6 +85,7 @@ import static java.lang.invoke.MethodHandles.publicLookup;
* <p/>
* This reader supports the <a href="http://swagger.io/specification/">Swagger Specification 2.0</a>
*/
+@Deprecated
public class RestSwaggerReader {
/**
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerSupport.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerSupport.java
index 50e55062c44..ba5c1d03510 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerSupport.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerSupport.java
@@ -53,6 +53,7 @@ import static org.apache.camel.swagger.SwaggerHelper.clearVendorExtensions;
* A support class for that allows SPI to plugin and offer Swagger API service listings as part of the Camel component.
* This allows rest-dsl components such as servlet/jetty/netty-http to offer Swagger API listings with minimal effort.
*/
+@Deprecated
public class RestSwaggerSupport {
static final String HEADER_X_FORWARDED_PREFIX = "X-Forwarded-Prefix";
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java
index 6c7a0cc41c3..790a9f488e0 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java
@@ -22,6 +22,7 @@ import io.swagger.models.Path;
import io.swagger.models.Swagger;
import org.apache.camel.util.FileUtil;
+@Deprecated
public final class SwaggerHelper {
private SwaggerHelper() {
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestApiProcessorFactory.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestApiProcessorFactory.java
index 57125213d37..d7f578beb07 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestApiProcessorFactory.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestApiProcessorFactory.java
@@ -24,6 +24,7 @@ import org.apache.camel.Processor;
import org.apache.camel.spi.RestApiProcessorFactory;
import org.apache.camel.spi.RestConfiguration;
+@Deprecated
public class SwaggerRestApiProcessorFactory implements RestApiProcessorFactory {
@Override
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestProducerFactory.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestProducerFactory.java
index 1494ef7bb0f..5ee60679202 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestProducerFactory.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerRestProducerFactory.java
@@ -37,6 +37,7 @@ import org.slf4j.LoggerFactory;
import static org.apache.camel.support.ResourceHelper.resolveMandatoryResourceAsInputStream;
+@Deprecated
public class SwaggerRestProducerFactory implements RestProducerFactory {
private static final Logger LOG = LoggerFactory.getLogger(SwaggerRestProducerFactory.class);
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/pom.xml b/tooling/maven/camel-restdsl-swagger-plugin/pom.xml
index d3bb6e7a1da..51f07f6763b 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/pom.xml
+++ b/tooling/maven/camel-restdsl-swagger-plugin/pom.xml
@@ -29,7 +29,7 @@
<artifactId>camel-restdsl-swagger-plugin</artifactId>
<packaging>maven-plugin</packaging>
- <name>Camel :: Maven Plugins :: Swagger REST DSL Generator Maven plugin</name>
+ <name>Camel :: Maven Plugins :: Swagger REST DSL Generator Maven plugin (deprecated)</name>
<description>Maven plugin that generates REST DSL RouteBuilder from Swagger specification</description>
<dependencyManagement>
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc b/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc
index ca3783408f8..2bf769a6645 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc
+++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/docs/camel-restdsl-swagger-plugin.adoc
@@ -1,4 +1,6 @@
-= Camel REST DSL Swagger Maven Plugin
+= Camel REST DSL Swagger Maven Plugin (deprecated)
+
+IMPORTANT: This plugin is deprecated, use camel-restdsl-openapi-plugin instead.
The Camel REST DSL Swagger Maven Plugin supports the following goals
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/AbstractGenerateMojo.java b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/AbstractGenerateMojo.java
index 3d7c504e7f9..6c712753fea 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/AbstractGenerateMojo.java
+++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/AbstractGenerateMojo.java
@@ -51,6 +51,7 @@ import static org.twdata.maven.mojoexecutor.MojoExecutor.groupId;
import static org.twdata.maven.mojoexecutor.MojoExecutor.plugin;
import static org.twdata.maven.mojoexecutor.MojoExecutor.version;
+@Deprecated
abstract class AbstractGenerateMojo extends AbstractMojo {
// this list should be in priority order
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateMojo.java b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateMojo.java
index 4e1c5313800..23092f79f39 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateMojo.java
+++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateMojo.java
@@ -35,6 +35,7 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
@Mojo(name = "generate", inheritByDefault = false, defaultPhase = LifecyclePhase.GENERATE_SOURCES,
requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
+@Deprecated
public class GenerateMojo extends AbstractGenerateMojo {
@Parameter
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateWithDtoMojo.java b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateWithDtoMojo.java
index ba59722f1d4..f628c6db4c8 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateWithDtoMojo.java
+++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateWithDtoMojo.java
@@ -23,6 +23,7 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
@Mojo(name = "generate-with-dto", inheritByDefault = false, defaultPhase = LifecyclePhase.GENERATE_SOURCES,
requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
+@Deprecated
public class GenerateWithDtoMojo extends GenerateMojo {
@Override
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlMojo.java b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlMojo.java
index c5dfc4ef3ed..dbe55a266da 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlMojo.java
+++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlMojo.java
@@ -35,6 +35,7 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
@Mojo(name = "generate-xml", inheritByDefault = false, defaultPhase = LifecyclePhase.GENERATE_SOURCES,
requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
+@Deprecated
public class GenerateXmlMojo extends AbstractGenerateMojo {
@Parameter(defaultValue = "false")
diff --git a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlWithDtoMojo.java b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlWithDtoMojo.java
index 7860c6732a0..a328fadb320 100644
--- a/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlWithDtoMojo.java
+++ b/tooling/maven/camel-restdsl-swagger-plugin/src/main/java/org/apache/camel/maven/generator/swagger/GenerateXmlWithDtoMojo.java
@@ -23,6 +23,7 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
@Mojo(name = "generate-xml-with-dto", inheritByDefault = false, defaultPhase = LifecyclePhase.GENERATE_SOURCES,
requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
+@Deprecated
public class GenerateXmlWithDtoMojo extends GenerateXmlMojo {
@Override