Merge branch 'OpenAPITools:master' into master

Author: rainmenzhao

.github/workflows/samples-crystal.yaml

@@ -0,0 +1,37 @@
+name: Samples Crystal clients
+
+on:
+  push:
+    paths:
+      - samples/client/petstore/crystal/**
+  pull_request:
+    paths:
+      - samples/client/petstore/crystal/**
+jobs:
+  build:
+    name: Build Crystal projects
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sample:
+          # clients
+          - samples/client/petstore/crystal/
+    services:
+      petstore-api:
+        image: swaggerapi/petstore
+        ports:
+          - 80:8080
+        env:
+          SWAGGER_HOST: http://petstore.swagger.io
+          SWAGGER_BASE_PATH: /v2
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install Crystal
+        uses: crystal-lang/install-crystal@v1
+      - name: Shards Install
+        run: shards install
+        working-directory: ${{ matrix.sample }}
+      - name: Run tests
+        run: crystal spec
+        working-directory: ${{ matrix.sample }}

.github/workflows/samples-swift5.yaml

@@ -35,7 +35,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - uses: swift-actions/setup-swift@v2
+      - uses: swift-actions/setup-swift@v3
         if: ${{ matrix.os == 'ubuntu-latest' }}
         with:
           swift-version: '5'

bin/configs/crystal.yaml

@@ -6,6 +6,7 @@ additionalProperties:
   shardVersion: 1.0.0
   moduleName: Petstore
   shardName: petstore
+  #paramsEncoder: Crest::EnumeratedFlatParamsEncoder
 strictSpecBehavior: false
 modelNameMappings:
   PropertyNameMapping: AnotherPropertyNameMapping

docs/generators/crystal.md

@@ -25,6 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
 |legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
 |moduleName|module name (e.g. TwitterClient| |OpenAPIClient|
+|paramsEncoder|params_encoder setting (e.g. Crest::NestedParamsEncoder, Crest::EnumeratedFlatParamsEncoder, Crest::ZeroEnumeratedFlatParamsEncoder| |Crest::NestedParamsEncoder|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
 |shardAuthor|shard author (only one is supported).| |null|
 |shardAuthorEmail|shard author email (only one is supported).| |null|

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

@@ -191,6 +191,7 @@ public CppPistacheServerCodegen() {
     private void setupSupportingFiles() {
         supportingFiles.clear();
         supportingFiles.add(new SupportingFile("api-base-header.mustache", "api", "ApiBase.h"));
+        supportingFiles.add(new SupportingFile("api-base-source.mustache", "api", "ApiBase.cpp"));
         supportingFiles.add(new SupportingFile("helpers-header.mustache", "model", modelNamePrefix + "Helpers.h"));
         supportingFiles.add(new SupportingFile("helpers-source.mustache", "model", modelNamePrefix + "Helpers.cpp"));
         supportingFiles.add(new SupportingFile("main-api-server.mustache", "", modelNamePrefix + "main-api-server.cpp"));

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

@@ -57,6 +57,7 @@ public class CrystalClientCodegen extends DefaultCodegen {
     @Setter protected String shardDescription = "This shard maps to a REST API";
     @Setter protected String shardAuthor = "";
     @Setter protected String shardAuthorEmail = "";
+    @Setter protected String paramsEncoder = "Crest::NestedParamsEncoder";
     protected String apiDocPath = "docs/";
     protected String modelDocPath = "docs/";
     protected List<String> primitiveTypes = new ArrayList<String>();
@@ -70,6 +71,7 @@ public class CrystalClientCodegen extends DefaultCodegen {
     public static final String SHARD_DESCRIPTION = "shardDescription";
     public static final String SHARD_AUTHOR = "shardAuthor";
     public static final String SHARD_AUTHOR_EMAIL = "shardAuthorEmail";
+    public static final String PARAMS_ENCODER = "paramsEncoder";
 
     public CrystalClientCodegen() {
         super();
@@ -197,15 +199,18 @@ public CrystalClientCodegen() {
 
         cliOptions.add(new CliOption(SHARD_HOMEPAGE, "shard homepage.").defaultValue("http://org.openapitools"));
 
-        cliOptions.add(
-                new CliOption(SHARD_DESCRIPTION, "shard description.").defaultValue("This shard maps to a REST API"));
+        cliOptions.add(new CliOption(SHARD_DESCRIPTION, "shard description.").defaultValue("This shard maps to a REST API"));
 
         cliOptions.add(new CliOption(SHARD_AUTHOR, "shard author (only one is supported)."));
 
         cliOptions.add(new CliOption(SHARD_AUTHOR_EMAIL, "shard author email (only one is supported)."));
 
         cliOptions.add(new CliOption(CodegenConstants.HIDE_GENERATION_TIMESTAMP,
                 CodegenConstants.HIDE_GENERATION_TIMESTAMP_DESC).defaultValue(Boolean.TRUE.toString()));
+
+        cliOptions.add(new CliOption(PARAMS_ENCODER,
+                "params_encoder setting (e.g. Crest::NestedParamsEncoder, Crest::EnumeratedFlatParamsEncoder, Crest::ZeroEnumeratedFlatParamsEncoder").
+                defaultValue("Crest::NestedParamsEncoder"));
     }
 
     @Override
@@ -260,6 +265,12 @@ public void processOpts() {
             setShardAuthorEmail((String) additionalProperties.get(SHARD_AUTHOR_EMAIL));
         }
 
+        if (additionalProperties.containsKey(PARAMS_ENCODER)) {
+            setParamsEncoder((String) additionalProperties.get(PARAMS_ENCODER));
+        } else {
+            additionalProperties.put(PARAMS_ENCODER, paramsEncoder);
+        }
+
         // make api and model doc path available in mustache template
         additionalProperties.put("apiDocPath", apiDocPath);
         additionalProperties.put("modelDocPath", modelDocPath);

modules/openapi-generator/src/main/resources/cpp-oatpp-server/main-api-server.mustache

@@ -22,7 +22,7 @@ public:
    *  Create ConnectionProvider component which listens on the port
    */
   OATPP_CREATE_COMPONENT(std::shared_ptr<oatpp::network::ServerConnectionProvider>, serverConnectionProvider)([] {
-    return oatpp::network::tcp::server::ConnectionProvider::createShared({"localhost", {{serverPort}}{{^serverPort}}8080{{/serverPort}}, oatpp::network::Address::IP_4});
+    return oatpp::network::tcp::server::ConnectionProvider::createShared({"0.0.0.0", {{serverPort}}{{^serverPort}}8080{{/serverPort}}, oatpp::network::Address::IP_4});
   }());
 
   /**

modules/openapi-generator/src/main/resources/cpp-pistache-server/api-base-header.mustache

@@ -14,14 +14,47 @@
 namespace {{apiNamespace}}
 {
 
+
+    {{#authMethods}}{{#isBasicBasic}}
+    typedef struct
+    {
+        std::string user;
+        std::string password;
+        std::unique_ptr<void, std::function<void(void*)>> userdata;
+    } HttpBasicCredentials;
+
+    typedef std::function<bool(HttpBasicCredentials &)> BasicCredentialsAuthenticator;
+    {{/isBasicBasic}}
+
+    {{#isBasicBearer}}
+    typedef struct
+    {
+        std::string token;
+        std::unique_ptr<void, std::function<void(void*)>> userdata;
+    } HttpBearerToken;
+
+    typedef std::function<bool(HttpBearerToken &)> BearerTokenAuthenticator;
+    {{/isBasicBearer}}
+    {{/authMethods}}
+
+
+
 class ApiBase {
 public:
-    explicit ApiBase(const std::shared_ptr<Pistache::Rest::Router>& rtr) : router(rtr) {};
+    explicit ApiBase(const std::shared_ptr<Pistache::Rest::Router>& rtr);
     virtual ~ApiBase() = default;
     virtual void init() = 0;
 
+    {{#authMethods}}{{#isBasicBasic}}void setBasicCredentialsAuthenticator( const BasicCredentialsAuthenticator &newBasicCredentialsAuthenticator);{{/isBasicBasic}}{{/authMethods}}
+    {{#authMethods}}{{#isBasicBearer}}void setBearerTokenAuthenticator( const BearerTokenAuthenticator &newbearerTokenAuthenticator);{{/isBasicBearer}}{{/authMethods}}
+
+
 protected:
     const std::shared_ptr<Pistache::Rest::Router> router;
+    {{#authMethods}}{{#isBasicBasic}}std::optional<BasicCredentialsAuthenticator> basicCredentialsAuthenticator;{{/isBasicBasic}}{{/authMethods}}
+    {{#authMethods}}{{#isBasicBearer}}std::optional<BearerTokenAuthenticator> bearerTokenAuthenticator;{{/isBasicBearer}}{{/authMethods}}
+
+
 };
 
 } // namespace {{apiNamespace}}

modules/openapi-generator/src/main/resources/cpp-pistache-server/api-base-source.mustache

@@ -0,0 +1,25 @@
+{{>licenseInfo}}
+#include "ApiBase.h"
+
+namespace {{apiNamespace}}
+{
+
+ApiBase::ApiBase(const std::shared_ptr<Pistache::Rest::Router>& rtr) : router(rtr)
+{
+}
+
+{{#authMethods}}{{#isBasicBasic}}
+void ApiBase::setBasicCredentialsAuthenticator( const BasicCredentialsAuthenticator &newBasicCredentialsAuthenticator)
+{
+    basicCredentialsAuthenticator = newBasicCredentialsAuthenticator;
+}
+{{/isBasicBasic}}
+{{#isBasicBearer}}
+void ApiBase::setBearerTokenAuthenticator( const BearerTokenAuthenticator &newbearerTokenAuthenticator)
+{
+    bearerTokenAuthenticator = newbearerTokenAuthenticator;
+}
+{{/isBasicBearer}}
+{{/authMethods}}
+
+} // Namespace {{apiNamespace}}

modules/openapi-generator/src/main/resources/cpp-pistache-server/api-header.mustache

@@ -79,7 +79,7 @@ private:
     {{#allParams}}
     /// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}</param>
     {{/allParams}}
-    virtual void {{operationIdSnakeCase}}({{#allParams}}const {{#isModel}}{{^isOptional}}{{modelNamespace}}::{{/isOptional}}{{/isModel}}{{{dataType}}} &{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#hasParams}}, {{/hasParams}}Pistache::Http::ResponseWriter &response) = 0;
+    virtual void {{operationIdSnakeCase}}({{#authMethods}}{{#isBasicBasic}}const HttpBasicCredentials &credentials, {{/isBasicBasic}}{{#isBasicBearer}}const HttpBearerToken &accessToken, {{/isBasicBearer}}{{/authMethods}} {{#allParams}}const {{#isModel}}{{^isOptional}}{{modelNamespace}}::{{/isOptional}}{{/isModel}}{{{dataType}}} &{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#hasParams}}, {{/hasParams}}Pistache::Http::ResponseWriter &response) = 0;
     {{/vendorExtensions.x-codegen-pistache-is-parsing-supported}}
     {{^vendorExtensions.x-codegen-pistache-is-parsing-supported}}
     virtual void {{operationIdSnakeCase}}(const Pistache::Rest::Request &request, Pistache::Http::ResponseWriter &response) = 0;