Mark nodejs-server as deprecated (#3083)

* mark nodejs-server as deprecated * update opeanpi3 script * add new file
OpenAPITools · Jun 4, 2019 · c6207c0 · c6207c0
1 parent 89d0c01
commit c6207c0
Show file tree

Hide file tree

Showing 15 changed files with 600 additions and 437 deletions.
diff --git a/bin/nodejs-petstore-google-cloud-functions.sh b/bin/nodejs-petstore-google-cloud-functions.sh
@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g nodejs-server --additional-properties=googleCloudFunctions=true -o samples/server/petstore/nodejs-google-cloud-functions -Dservice $@"
+ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g nodejs-server-deprecated --additional-properties=googleCloudFunctions=true -o samples/server/petstore/nodejs-google-cloud-functions -Dservice $@"
 
 java $JAVA_OPTS -jar $executable $ags
diff --git a/bin/nodejs-petstore-server.sh b/bin/nodejs-petstore-server.sh
@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -t modules/openapi-generator/src/main/resources/nodejs -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g nodejs-server -o samples/server/petstore/nodejs -Dservice $@"
+ags="generate -t modules/openapi-generator/src/main/resources/nodejs -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g nodejs-server-deprecated -o samples/server/petstore/nodejs -Dservice $@"
 
 java $JAVA_OPTS -jar $executable $ags
diff --git a/bin/openapi3/nodejs-petstore-google-cloud-functions.sh b/bin/openapi3/nodejs-petstore-google-cloud-functions.sh
@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g nodejs-server --additional-properties=googleCloudFunctions=true -o samples/server/petstore/nodejs-google-cloud-functions -Dservice $@"
+ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g nodejs-server-deprecated --additional-properties=googleCloudFunctions=true -o samples/server/petstore/nodejs-google-cloud-functions -Dservice $@"
 
 java $JAVA_OPTS -jar $executable $ags
diff --git a/bin/openapi3/nodejs-petstore-server.sh b/bin/openapi3/nodejs-petstore-server.sh
@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -t modules/openapi-generator/src/main/resources/nodejs -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g nodejs-server -o samples/server/petstore/nodejs -Dservice $@"
+ags="generate -t modules/openapi-generator/src/main/resources/nodejs -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g nodejs-server-deprecated -o samples/server/petstore/nodejs -Dservice $@"
 
 java $JAVA_OPTS -jar $executable $ags
diff --git a/docs/generators.md b/docs/generators.md
@@ -91,7 +91,7 @@ The following generators are available:
     - [jaxrs-spec](generators/jaxrs-spec.md)
     - [kotlin-server](generators/kotlin-server.md)
     - [kotlin-spring](generators/kotlin-spring.md)
-    - [nodejs-server](generators/nodejs-server.md)
+    - [nodejs-server-deprecated](generators/nodejs-server-deprecated.md) (deprecated)
     - [php-laravel](generators/php-laravel.md)
     - [php-lumen](generators/php-lumen.md)
     - [php-silex](generators/php-silex.md)

diff --git a/docs/generators/nodejs-server-deprecated.md b/docs/generators/nodejs-server-deprecated.md
@@ -0,0 +1,16 @@
+
+---
+id: generator-opts-server-nodejs-server-deprecated
+title: Config Options for nodejs-server-deprecated
+sidebar_label: nodejs-server-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|
+|googleCloudFunctions|When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.| |false|
+|exportedName|When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code.| |null|
+|serverPort|TCP port to listen on.| |null|
diff --git a/...enapi-generator/src/main/java/org/openapitools/codegen/languages/NodeJSServerCodegen.java b/...enapi-generator/src/main/java/org/openapitools/codegen/languages/NodeJSServerCodegen.java
@@ -28,6 +28,8 @@
 import io.swagger.v3.oas.models.info.Info;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.config.GeneratorProperties;
+import org.openapitools.codegen.meta.GeneratorMetadata;
+import org.openapitools.codegen.meta.Stability;
 import org.openapitools.codegen.utils.URLPathUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -58,6 +60,11 @@ public class NodeJSServerCodegen extends DefaultCodegen implements CodegenConfig
     public NodeJSServerCodegen() {
         super();
 
+        // mark the generator as deprecated in the documentation
+        generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
+                .stability(Stability.DEPRECATED)
+                .build();
+
         // set the output folder here
         outputFolder = "generated-code/nodejs";
 
@@ -142,7 +149,7 @@ public CodegenType getTag() {
      */
     @Override
     public String getName() {
-        return "nodejs-server";
+        return "nodejs-server-deprecated";
     }
 
     /**
@@ -153,7 +160,7 @@ public String getName() {
      */
     @Override
     public String getHelp() {
-        return "Generates a nodejs server library using the swagger-tools project.  By default, " +
+        return "[DEPRECATED] Generates a nodejs server library using the swagger-tools project.  By default, " +
                 "it will also generate service classes--which you can disable with the `-Dnoservice` environment variable.";
     }
 
@@ -303,6 +310,8 @@ public void processOpts() {
         message.append(System.lineSeparator()).append(System.lineSeparator())
                 .append("=======================================================================================")
                 .append(System.lineSeparator())
+                .append("IMPORTANT: The nodejs-server generator has been deprecated.")
+                .append(System.lineSeparator())
                 .append("Currently, Node.js server doesn't work as its dependency doesn't support OpenAPI Spec3.")
                 .append(System.lineSeparator())
                 .append("For further details, see https://github.com/OpenAPITools/openapi-generator/issues/34")

diff --git a/samples/server/petstore/nodejs-google-cloud-functions/.openapi-generator/VERSION b/samples/server/petstore/nodejs-google-cloud-functions/.openapi-generator/VERSION
@@ -1 +1 @@
-3.0.0-SNAPSHOT
+4.0.2-SNAPSHOT