From d570a8d1ed6eadfc65e737b69a980ed4adf75440 Mon Sep 17 00:00:00 2001 From: Yuriy Belenko Date: Thu, 24 Oct 2019 22:49:44 +0500 Subject: [PATCH 1/2] Mark Slim3 server generator as deprecated --- docs/generators.md | 2 +- .../codegen/languages/PhpSlim4ServerCodegen.java | 6 ++++++ .../codegen/languages/PhpSlimServerCodegen.java | 6 ++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/generators.md b/docs/generators.md index 91b859ca707e..5e86040ab7d3 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -103,7 +103,7 @@ The following generators are available: * [php-laravel](generators/php-laravel.md) * [php-lumen](generators/php-lumen.md) * [php-silex](generators/php-silex.md) -* [php-slim](generators/php-slim.md) +* [php-slim (deprecated)](generators/php-slim.md) * [php-slim4](generators/php-slim4.md) * [php-symfony](generators/php-symfony.md) * [php-ze-ph](generators/php-ze-ph.md) diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlim4ServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlim4ServerCodegen.java index c5d07d07eb25..c286e9e97324 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlim4ServerCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlim4ServerCodegen.java @@ -22,6 +22,8 @@ import org.apache.commons.lang3.StringEscapeUtils; import org.apache.commons.lang3.StringUtils; import org.openapitools.codegen.*; +import org.openapitools.codegen.meta.GeneratorMetadata; +import org.openapitools.codegen.meta.Stability; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -44,6 +46,10 @@ public class PhpSlim4ServerCodegen extends PhpSlimServerCodegen { public PhpSlim4ServerCodegen() { super(); + generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata) + .stability(Stability.STABLE) + .build(); + outputFolder = "generated-code" + File.separator + "slim4"; embeddedTemplateDir = templateDir = "php-slim4-server"; diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java index d63d0a30e0c8..fbed475d7d36 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java @@ -23,6 +23,8 @@ import org.apache.commons.lang3.StringEscapeUtils; import org.apache.commons.lang3.StringUtils; import org.openapitools.codegen.*; +import org.openapitools.codegen.meta.GeneratorMetadata; +import org.openapitools.codegen.meta.Stability; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -46,6 +48,10 @@ public class PhpSlimServerCodegen extends AbstractPhpCodegen { public PhpSlimServerCodegen() { super(); + generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata) + .stability(Stability.DEPRECATED) + .build(); + // clear import mapping (from default generator) as slim does not use it // at the moment importMapping.clear(); From 2049842ee6aada2a2062d1831f8e384a6c6d0943 Mon Sep 17 00:00:00 2001 From: Yuriy Belenko Date: Fri, 25 Oct 2019 12:28:22 +0500 Subject: [PATCH 2/2] Add deprecated suffix --- bin/ci/php-slim-server-petstore.json | 2 +- bin/openapi3/php-slim-server-petstore.sh | 2 +- bin/php-slim-server-petstore.sh | 2 +- bin/windows/php-slim-server-petstore.bat | 2 +- docs/generators.md | 2 +- docs/generators/php-slim-deprecated.md | 18 ++++++++++++++++++ .../languages/PhpSlimServerCodegen.java | 4 ++-- 7 files changed, 25 insertions(+), 7 deletions(-) create mode 100644 docs/generators/php-slim-deprecated.md diff --git a/bin/ci/php-slim-server-petstore.json b/bin/ci/php-slim-server-petstore.json index c189ba439c38..4341586b3306 100644 --- a/bin/ci/php-slim-server-petstore.json +++ b/bin/ci/php-slim-server-petstore.json @@ -1,5 +1,5 @@ { - "generatorName": "php-slim", + "generatorName": "php-slim-deprecated", "inputSpec": "modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml", "outputDir": "samples/server/petstore/php-slim", "templateDir": "modules/openapi-generator/src/main/resources/php-slim-server" diff --git a/bin/openapi3/php-slim-server-petstore.sh b/bin/openapi3/php-slim-server-petstore.sh index 814645929e6a..e497f4f027f3 100755 --- a/bin/openapi3/php-slim-server-petstore.sh +++ b/bin/openapi3/php-slim-server-petstore.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/php-slim-server -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g php-slim -o samples/server/petstore/php-slim $@" +ags="generate -t modules/openapi-generator/src/main/resources/php-slim-server -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g php-slim-deprecated -o samples/server/petstore/php-slim $@" java $JAVA_OPTS -jar $executable $ags diff --git a/bin/php-slim-server-petstore.sh b/bin/php-slim-server-petstore.sh index 437258709177..b26b05895957 100755 --- a/bin/php-slim-server-petstore.sh +++ b/bin/php-slim-server-petstore.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/php-slim-server -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g php-slim -o samples/server/petstore/php-slim $@" +ags="generate -t modules/openapi-generator/src/main/resources/php-slim-server -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g php-slim-deprecated -o samples/server/petstore/php-slim $@" java $JAVA_OPTS -jar $executable $ags diff --git a/bin/windows/php-slim-server-petstore.bat b/bin/windows/php-slim-server-petstore.bat index 395804560b31..4e896f0184e1 100755 --- a/bin/windows/php-slim-server-petstore.bat +++ b/bin/windows/php-slim-server-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-with-fake-endpoints-models-for-testing.yaml -g php-slim -o samples\server\petstore\php-slim +set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -g php-slim-deprecated -o samples\server\petstore\php-slim java %JAVA_OPTS% -jar %executable% %ags% diff --git a/docs/generators.md b/docs/generators.md index 5e86040ab7d3..604c6ed302db 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -103,7 +103,7 @@ The following generators are available: * [php-laravel](generators/php-laravel.md) * [php-lumen](generators/php-lumen.md) * [php-silex](generators/php-silex.md) -* [php-slim (deprecated)](generators/php-slim.md) +* [php-slim-deprecated (deprecated)](generators/php-slim-deprecated.md) * [php-slim4](generators/php-slim4.md) * [php-symfony](generators/php-symfony.md) * [php-ze-ph](generators/php-ze-ph.md) diff --git a/docs/generators/php-slim-deprecated.md b/docs/generators/php-slim-deprecated.md new file mode 100644 index 000000000000..47784d3e934d --- /dev/null +++ b/docs/generators/php-slim-deprecated.md @@ -0,0 +1,18 @@ +--- +title: Config Options for php-slim-deprecated +sidebar_label: php-slim-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| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java index fbed475d7d36..dac4cd5774df 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlimServerCodegen.java @@ -91,12 +91,12 @@ public CodegenType getTag() { @Override public String getName() { - return "php-slim"; + return "php-slim-deprecated"; } @Override public String getHelp() { - return "Generates a PHP Slim Framework server library."; + return "Generates a PHP Slim Framework server library. IMPORTANT NOTE: this generator (Slim 3.x) is no longer actively maintained so please use 'php-slim4' generator instead."; } @Override