also flatten when there is a single option

Author: millotp

generators/src/main/java/com/algolia/codegen/AlgoliaGoGenerator.java

@@ -152,106 +152,16 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
       String[] lines = ope.unescapedNotes.split("\n");
       ope.notes = (lines[0] + "\n" + Arrays.stream(lines).skip(1).map(line -> "// " + line).collect(Collectors.joining("\n"))).trim();
 
+      // enrich the params
       for (CodegenParameter param : ope.optionalParams) {
         param.nameInPascalCase = Helpers.capitalize(param.baseName);
       }
 
       CodegenParameter bodyParam = ope.bodyParam;
-      if (bodyParam == null) {
-        continue;
-      }
-      bodyParam.nameInPascalCase = Helpers.capitalize(bodyParam.baseName);
-      if (!bodyParam.isModel) {
-        continue;
-      }
-
-      // check for colision with other params
-      boolean hasCollision = false;
-      for (CodegenProperty prop : bodyParam.getVars()) {
-        for (CodegenParameter param : ope.allParams) {
-          if (param.paramName.equals(prop.baseName)) {
-            hasCollision = true;
-            break;
-          }
-        }
-      }
-      if (hasCollision) {
-        System.out.println("Operation " + ope.operationId + " has a body param with the same name as another param, skipping flattening");
-        continue;
-      }
-
-      if (ope.operationId.equals("Browse")) {
-        System.out.println(
-          ope.allParams.size() +
-          " params   " +
-          ope.requiredParams.size() +
-          " required params " +
-          ope.optionalParams.size() +
-          " optional params"
-        );
-      }
-
-      bodyParam.vendorExtensions.put("x-flat-body", bodyParam.getVars().size() > 0);
-
-      if (bodyParam.getVars().size() > 0) {
-        ope.allParams.removeIf(param -> param.isBodyParam);
-        ope.requiredParams.removeIf(param -> param.isBodyParam);
-        ope.optionalParams.removeIf(param -> param.isBodyParam);
-      }
-
-      for (CodegenProperty prop : bodyParam.getVars()) {
-        // there is no easy way to convert a prop to a param, we need to copy all the fields
-        CodegenParameter param = new CodegenParameter();
-
-        prop.nameInLowerCase = toParamName(prop.baseName);
-        param.nameInPascalCase = Helpers.capitalize(prop.baseName);
-        param.paramName = toParamName(prop.baseName);
-        param.baseName = prop.baseName;
-        param.baseType = prop.baseType;
-        param.dataType = prop.dataType;
-        param.datatypeWithEnum = prop.datatypeWithEnum;
-        param.description = prop.description;
-        param.example = prop.example;
-        param.isModel = prop.isModel;
-        param.isArray = prop.isArray;
-        param.isContainer = prop.isContainer;
-        param.isMap = prop.isMap;
-        param.isEnum = prop.isEnum;
-        param.isEnumRef = prop.isEnumRef;
-        param.isPrimitiveType = prop.isPrimitiveType;
-        param.isString = prop.isString;
-        param.isNumeric = prop.isNumeric;
-        param.isBoolean = prop.isBoolean;
-        param.isDate = prop.isDate;
-        param.isDateTime = prop.isDateTime;
-        param.isFreeFormObject = prop.isFreeFormObject;
-        param.isNullable = prop.isNullable;
-        param.jsonSchema = prop.jsonSchema;
-        param.required = prop.required;
-        param.vendorExtensions = prop.vendorExtensions;
-        param.allowableValues = prop.allowableValues;
-
-        if (prop.required) {
-          ope.requiredParams.add(param);
-          ope.hasRequiredParams = true;
-        } else {
-          ope.optionalParams.add(param);
-          ope.hasOptionalParams = true;
-        }
-        ope.allParams.add(param);
+      if (bodyParam != null) {
+        flattenBody(ope);
       }
 
-      System.out.println(
-        ope.operationId +
-        "  has " +
-        ope.requiredParams.size() +
-        " required params and " +
-        ope.optionalParams.size() +
-        " optional params   " +
-        bodyParam.getVars().size() +
-        " body params  "
-      );
-
       // If the optional param struct only has 1 param, we can remove the wrapper
       if (ope.optionalParams.size() == 1) {
         CodegenParameter param = ope.optionalParams.get(0);
@@ -270,4 +180,80 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
     GenericPropagator.propagateGenericsToOperations(operations, models);
     return operations;
   }
+
+  private void flattenBody(CodegenOperation ope) {
+    CodegenParameter bodyParam = ope.bodyParam;
+    bodyParam.nameInPascalCase = Helpers.capitalize(bodyParam.baseName);
+    if (!bodyParam.isModel) {
+      return;
+    }
+
+    // check for colision with other params
+    for (CodegenProperty prop : bodyParam.getVars()) {
+      for (CodegenParameter param : ope.allParams) {
+        if (param.paramName.equals(prop.baseName)) {
+          System.out.println(
+            "Operation " +
+            ope.operationId +
+            " has body param " +
+            bodyParam.paramName +
+            " in colision with param " +
+            param.paramName +
+            ", skipping flattening"
+          );
+          return;
+        }
+      }
+    }
+
+    bodyParam.vendorExtensions.put("x-flat-body", bodyParam.getVars().size() > 0);
+
+    if (bodyParam.getVars().size() > 0) {
+      ope.allParams.removeIf(param -> param.isBodyParam);
+      ope.requiredParams.removeIf(param -> param.isBodyParam);
+      ope.optionalParams.removeIf(param -> param.isBodyParam);
+    }
+
+    for (CodegenProperty prop : bodyParam.getVars()) {
+      // there is no easy way to convert a prop to a param, we need to copy all the fields
+      CodegenParameter param = new CodegenParameter();
+
+      prop.nameInLowerCase = toParamName(prop.baseName);
+      param.nameInPascalCase = Helpers.capitalize(prop.baseName);
+      param.paramName = toParamName(prop.baseName);
+      param.baseName = prop.baseName;
+      param.baseType = prop.baseType;
+      param.dataType = prop.dataType;
+      param.datatypeWithEnum = prop.datatypeWithEnum;
+      param.description = prop.description;
+      param.example = prop.example;
+      param.isModel = prop.isModel;
+      param.isArray = prop.isArray;
+      param.isContainer = prop.isContainer;
+      param.isMap = prop.isMap;
+      param.isEnum = prop.isEnum;
+      param.isEnumRef = prop.isEnumRef;
+      param.isPrimitiveType = prop.isPrimitiveType;
+      param.isString = prop.isString;
+      param.isNumeric = prop.isNumeric;
+      param.isBoolean = prop.isBoolean;
+      param.isDate = prop.isDate;
+      param.isDateTime = prop.isDateTime;
+      param.isFreeFormObject = prop.isFreeFormObject;
+      param.isNullable = prop.isNullable;
+      param.jsonSchema = prop.jsonSchema;
+      param.required = prop.required;
+      param.vendorExtensions = prop.vendorExtensions;
+      param.allowableValues = prop.allowableValues;
+
+      if (prop.required) {
+        ope.requiredParams.add(param);
+        ope.hasRequiredParams = true;
+      } else {
+        ope.optionalParams.add(param);
+        ope.hasOptionalParams = true;
+      }
+      ope.allParams.add(param);
+    }
+  }
 }

generators/src/main/java/com/algolia/codegen/cts/tests/TestsGenerator.java

@@ -150,6 +150,21 @@ public static void setOptionalParameters(CodegenOperation ope, Map<String, Objec
       }
     }
 
+    System.out.println(
+      ope.operationId +
+      " has " +
+      ope.allParams.size() +
+      " params   " +
+      ope.requiredParams.size() +
+      " required params " +
+      ope.optionalParams.size() +
+      " optional params " +
+      bodyPropsOptional +
+      " bodyPropsOptional " +
+      (ope.optionalParams.size() + bodyPropsOptional > 1) +
+      " hasOptionalWrapper "
+    );
+
     // hasOptionalWrapper if there is more that one optional param, after the body has been
     // flattened, only relevant for go
     test.put("hasOptionalWrapper", ope.optionalParams.size() + bodyPropsOptional > 1);

templates/go/api.mustache

@@ -360,7 +360,7 @@ func (o *{{operationId}}Options) With{{#lambda.titlecase}}{{baseName}}{{/lambda.
 //
 // Deprecated: {{operationId}} is deprecated
   {{/isDeprecated}}
-func (c *APIClient) {{nickname}}({{#requiredParams}}{{paramName}} {{#required}}{{#isModel}}*{{/isModel}}{{/required}}{{^required}}*{{/required}}{{{dataType}}}, {{/requiredParams}}{{#hasOptionalParams}}optionalParams *{{operationId}}Options, {{/hasOptionalParams}}opts ...RequestOption) ({{#returnType}}{{^isArray}}{{^returnTypeIsPrimitive}}*{{/returnTypeIsPrimitive}}{{/isArray}}{{{.}}}, {{/returnType}}error) {
+func (c *APIClient) {{nickname}}({{#requiredParams}}{{paramName}} {{#required}}{{#isModel}}*{{/isModel}}{{/required}}{{^required}}{{^isMap}}*{{/isMap}}{{/required}}{{{dataType}}}, {{/requiredParams}}{{#hasOptionalParams}}optionalParams *{{operationId}}Options, {{/hasOptionalParams}}opts ...RequestOption) ({{#returnType}}{{^isArray}}{{^returnTypeIsPrimitive}}*{{/returnTypeIsPrimitive}}{{/isArray}}{{{.}}}, {{/returnType}}error) {
   {{#returnType}}
   var returnValue {{^isArray}}{{^returnTypeIsPrimitive}}*{{/returnTypeIsPrimitive}}{{/isArray}}{{{.}}}
   {{/returnType}}
@@ -411,7 +411,7 @@ func (c *APIClient) {{nickname}}({{#requiredParams}}{{paramName}} {{#required}}{
 //
 // Deprecated: {{operationId}} is deprecated
   {{/isDeprecated}}
-func (c *APIClient) {{nickname}}WithHTTPInfo({{#requiredParams}}{{paramName}} {{#required}}{{#isModel}}*{{/isModel}}{{/required}}{{^required}}*{{/required}}{{{dataType}}}, {{/requiredParams}}{{#hasOptionalParams}}optionalParams *{{operationId}}Options, {{/hasOptionalParams}}opts ...RequestOption) (*http.Response, []byte, error) {
+func (c *APIClient) {{nickname}}WithHTTPInfo({{#requiredParams}}{{paramName}} {{#required}}{{#isModel}}*{{/isModel}}{{/required}}{{^required}}{{^isMap}}*{{/isMap}}{{/required}}{{{dataType}}}, {{/requiredParams}}{{#hasOptionalParams}}optionalParams *{{operationId}}Options, {{/hasOptionalParams}}opts ...RequestOption) (*http.Response, []byte, error) {
   {{#vendorExtensions}}
   requestPath := "{{{path}}}"{{#pathParams}}
   requestPath = strings.ReplaceAll(requestPath, {{=<% %>=}}"{<%baseName%>}"<%={{ }}=%>, {{#x-is-custom-request}}utils.ParameterToString({{paramName}}){{/x-is-custom-request}}{{^x-is-custom-request}}url.PathEscape(utils.ParameterToString({{paramName}})){{/x-is-custom-request}}){{/pathParams}}