[scala-httpclient] mark the generator as deprecated (#2357)

* deprecate scala-httpclient * update doc

Author: wing328

bin/scala-httpclient-petstore.sh

@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -t modules/openapi-generator/src/main/resources/scala-httpclient -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g scala-httpclient -o samples/client/petstore/scala-httpclient $@"
+ags="generate -t modules/openapi-generator/src/main/resources/scala-httpclient -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g scala-httpclient-deprecated -o samples/client/petstore/scala-httpclient $@"
 
 java $JAVA_OPTS -jar $executable $ags

bin/windows/scala-httpclient-petstore.bat

@@ -5,6 +5,6 @@ If Not Exist %executable% (
 )
 
 REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M
-set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g scala-httpclient -o samples\client\petstore\scala-httpclient
+set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g scala-httpclient-deprecated -o samples\client\petstore\scala-httpclient
 
 java %JAVA_OPTS% -jar %executable% %ags%

docs/generators.md

@@ -47,7 +47,7 @@ The following generators are available:
  - [rust](generators/rust.md)
  - [scala-akka](generators/scala-akka.md)
  - [scala-gatling](generators/scala-gatling.md)
- - [scala-httpclient](generators/scala-httpclient.md)
+ - [scala-httpclient-deprecated](generators/scala-httpclient-deprecated.md)
  - [scalaz](generators/scalaz.md)
  - [swift2-deprecated](generators/swift2-deprecated.md)
  - [swift3-deprecated](generators/swift3-deprecated.md)

docs/generators/scala-httpclient-deprecated.md

@@ -0,0 +1,17 @@
+
+---
+id: generator-opts-client-scala-httpclient-deprecated
+title: Config Options for scala-httpclient-deprecated
+sidebar_label: scala-httpclient-deprecated
+---
+
+| Option | Description | Values | Default |
+| ------ | ----------- | ------ | ------- |
+|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
+|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
+|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|modelPackage|package for generated models| |null|
+|apiPackage|package for generated api classes| |null|
+|sourceFolder|source folder for generated code| |null|
+|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaHttpClientCodegen.java

@@ -29,6 +29,9 @@
 import static org.openapitools.codegen.utils.StringUtils.camelize;
 import static org.openapitools.codegen.utils.StringUtils.underscore;
 
+/*
+ * This generator has been deprecated. Please use scala-akka instead.
+ */
 public class ScalaHttpClientCodegen extends AbstractScalaCodegen implements CodegenConfig {
  private static final Logger LOGGER = LoggerFactory.getLogger(ScalaHttpClientCodegen.class);
 
@@ -131,6 +134,9 @@ public ScalaHttpClientCodegen() {
 
  @Override
  public void processOpts() {
+ LOGGER.warn("IMPORTANT: This generator (scala-http-client-deprecated) is no longer actively maintained and will be deprecated. " +
+ "PLease use 'scala-akka' generator instead.");
+
  super.processOpts();
  if (additionalProperties.containsKey(CodegenConstants.MODEL_PROPERTY_NAMING)) {
  setModelPropertyNaming((String) additionalProperties.get(CodegenConstants.MODEL_PROPERTY_NAMING));
@@ -207,7 +213,7 @@ public CodegenType getTag() {
 
  @Override
  public String getName() {
- return "scala-httpclient";
+ return "scala-httpclient-deprecated";
  }
 
  @Override