fix duplicated opeationId with new rule in normalizer

Author: wing328

bin/configs/java-okhttp-gson-3.1.yaml

@@ -3,6 +3,7 @@ outputDir: samples/client/petstore/java/okhttp-gson-3.1
 library: okhttp-gson
 inputSpec: modules/openapi-generator/src/test/resources/3_1/java/petstore.yaml
 templateDir: modules/openapi-generator/src/main/resources/Java
+validateSpec: false
 nameMappings:
   _type: underscoreType
   type_: typeWithUnderscore
@@ -14,3 +15,5 @@ additionalProperties:
   hideGenerationTimestamp: "true"
   useOneOfDiscriminatorLookup: "true"
   disallowAdditionalPropertiesIfNotPresent: false
+openapiNormalizer:
+  FIX_DUPLICATED_OPERATIONID: true

docs/customization.md

@@ -614,3 +614,10 @@ Example:
 ```
 java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_PRIMITIVE_TYPES_TO_NULLABLE="integer|number"
 ```
+
+- `FIX_DUPLICATED_OPERATIONID`: When set to true, an integer suffix will be added to duplicated operationId(s), e.g. getName => getName_0, getName_1, etc
+
+Example:
+```
+java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_1/java/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer FIX_DUPLICATED_OPERATIONID=true
+```

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

@@ -34,6 +34,9 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
+import static org.openapitools.codegen.utils.StringUtils.getUniqueString;
+import static org.openapitools.codegen.utils.StringUtils.underscore;
+
 public class OpenAPINormalizer {
     private OpenAPI openAPI;
     private Map<String, String> inputRules = new HashMap<>();
@@ -88,6 +91,12 @@ public class OpenAPINormalizer {
     final String SET_TAGS_TO_OPERATIONID = "SET_TAGS_TO_OPERATIONID";
     String setTagsToOperationId;
 
+    // when set to true, tags in all operations will be set to operationId or "default" if operationId
+    // is empty
+    final String FIX_DUPLICATED_OPERATIONID = "FIX_DUPLICATED_OPERATIONID";
+    String fixDuplicatedOperationId;
+    HashSet<String> operationIdSet = new HashSet<>();
+
     // when set to true, auto fix integer with maximum value 4294967295 (2^32-1) or long with 18446744073709551615 (2^64-1)
     // by adding x-unsigned to the schema
     final String ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE = "ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE";
@@ -149,6 +158,7 @@ public OpenAPINormalizer(OpenAPI openAPI, Map<String, String> inputRules) {
         ruleNames.add(KEEP_ONLY_FIRST_TAG_IN_OPERATION);
         ruleNames.add(SET_TAGS_FOR_ALL_OPERATIONS);
         ruleNames.add(SET_TAGS_TO_OPERATIONID);
+        ruleNames.add(FIX_DUPLICATED_OPERATIONID);
         ruleNames.add(ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE);
         ruleNames.add(REFACTOR_ALLOF_WITH_PROPERTIES_ONLY);
         ruleNames.add(NORMALIZE_31SPEC);
@@ -360,6 +370,8 @@ private void normalizeOperation(Operation operation) {
         processSetTagsForAllOperations(operation);
 
         processSetTagsToOperationId(operation);
+
+        processFixDuplicatedOperationId(operation);
     }
 
     /**
@@ -876,6 +888,26 @@ private void processSetTagsToOperationId(Operation operation) {
         }
     }
 
+    private void processFixDuplicatedOperationId(Operation operation) {
+        if (!getRule(FIX_DUPLICATED_OPERATIONID)) {
+            return;
+        }
+
+        // skip null as default codegen will automatically generate one using path, http verb, etc
+        if (operation.getOperationId() == null) {
+            return;
+        }
+
+        String uniqueName = getUniqueString(operationIdSet, operation.getOperationId());
+
+        if (!uniqueName.equals(operation.getOperationId())) {
+            LOGGER.info("operationId {} renamed to {} to ensure uniqueness (enabled by openapi normalizer rule `FIX_DUPLICATED_OPERATIONID`)", operation.getOperationId(), uniqueName);
+            operation.setOperationId(uniqueName);
+        }
+    }
+
+
+
     /**
      * If the schema contains anyOf/oneOf and properties, remove oneOf/anyOf as these serve as rules to
      * ensure inter-dependency between properties. It's a workaround as such validation is not supported at the moment.

modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/StringUtils.java

@@ -283,4 +283,32 @@ public static String escape(final String name, final Map<String, String> replace
             throw new RuntimeException("Word '" + name + "' could not be escaped.");
         });
     }
+
+    /**
+     * Return a unique string based on a set of processed strings.
+     *
+     * @param processedStrings a set of strings that have been processed
+     * @param input            input to be checked for uniqueness
+     * @return a unique string
+     */
+    public static String getUniqueString(Set<String> processedStrings, String input) {
+        if (input == null) {
+            return null;
+        }
+
+        String uniqueName = input;
+        // check for input uniqueness
+        int counter = 0;
+
+        if (processedStrings.contains(uniqueName)) {
+            // look for next unique next, e.g. getName_7
+            while (processedStrings.contains(uniqueName)) {
+                uniqueName = uniqueName + "_" + counter;
+                counter++;
+            }
+        }
+
+        processedStrings.add(uniqueName);
+        return uniqueName;
+    }
 }

modules/openapi-generator/src/test/resources/3_1/java/petstore.yaml

@@ -728,6 +728,20 @@ paths:
                     items:
                       "$ref": "#/components/schemas/myObject"
                   - type: 'null'
+  "/fake/duplicated/operationId":
+    get:
+      tags:
+        - fake
+      operationId: getPetById
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                anyOf:
+                  - type: 'null'
+                  - "$ref": "#/components/schemas/myObject"
 externalDocs:
   description: Find out more about Swagger
   url: 'http://swagger.io'

samples/client/petstore/java/okhttp-gson-3.1/README.md

@@ -116,6 +116,7 @@ Class | Method | HTTP request | Description
 *FakeApi* | [**fakeInlineSchemaAnyofPath1Get**](docs/FakeApi.md#fakeInlineSchemaAnyofPath1Get) | **GET** /fake/inline/schema/anyof/path1 | 
 *FakeApi* | [**fakeInlineSchemaAnyofPath2Get**](docs/FakeApi.md#fakeInlineSchemaAnyofPath2Get) | **GET** /fake/inline/schema/anyof/path2 | 
 *FakeApi* | [**fakeInlineSchemaAnyofPath3Get**](docs/FakeApi.md#fakeInlineSchemaAnyofPath3Get) | **GET** /fake/inline/schema/anyof/path3 | 
+*FakeApi* | [**getPetById0**](docs/FakeApi.md#getPetById0) | **GET** /fake/duplicated/operationId | 
 *FakeApi* | [**op1**](docs/FakeApi.md#op1) | **POST** /fake/api/changeowner | op1
 *FakeApi* | [**op2**](docs/FakeApi.md#op2) | **POST** /fake/api/changename | op2
 *FakeApi* | [**op3**](docs/FakeApi.md#op3) | **POST** /fake/api/query/enum | op3

samples/client/petstore/java/okhttp-gson-3.1/api/openapi.yaml

@@ -821,6 +821,20 @@ paths:
       - fake
       x-accepts:
       - application/json
+  /fake/duplicated/operationId:
+    get:
+      operationId: getPetById_0
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/myObject'
+          description: ""
+      tags:
+      - fake
+      x-accepts:
+      - application/json
 components:
   parameters:
     ref_to_uuid:

samples/client/petstore/java/okhttp-gson-3.1/docs/FakeApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://petstore.swagger.io/v2*
 | [**fakeInlineSchemaAnyofPath1Get**](FakeApi.md#fakeInlineSchemaAnyofPath1Get) | **GET** /fake/inline/schema/anyof/path1 |  |
 | [**fakeInlineSchemaAnyofPath2Get**](FakeApi.md#fakeInlineSchemaAnyofPath2Get) | **GET** /fake/inline/schema/anyof/path2 |  |
 | [**fakeInlineSchemaAnyofPath3Get**](FakeApi.md#fakeInlineSchemaAnyofPath3Get) | **GET** /fake/inline/schema/anyof/path3 |  |
+| [**getPetById0**](FakeApi.md#getPetById0) | **GET** /fake/duplicated/operationId |  |
 | [**op1**](FakeApi.md#op1) | **POST** /fake/api/changeowner | op1 |
 | [**op2**](FakeApi.md#op2) | **POST** /fake/api/changename | op2 |
 | [**op3**](FakeApi.md#op3) | **POST** /fake/api/query/enum | op3 |
@@ -186,6 +187,62 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** |  |  -  |
 
+<a id="getPetById0"></a>
+# **getPetById0**
+> Object getPetById0()
+
+
+
+### Example
+```java
+// Import classes:
+import org.openapitools.client.ApiClient;
+import org.openapitools.client.ApiException;
+import org.openapitools.client.Configuration;
+import org.openapitools.client.models.*;
+import org.openapitools.client.api.FakeApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = Configuration.getDefaultApiClient();
+    defaultClient.setBasePath("http://petstore.swagger.io/v2");
+
+    FakeApi apiInstance = new FakeApi(defaultClient);
+    try {
+      Object result = apiInstance.getPetById0();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling FakeApi#getPetById0");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
 <a id="op1"></a>
 # **op1**
 > Object op1()

samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/api/FakeApi.java

@@ -414,6 +414,119 @@ public okhttp3.Call fakeInlineSchemaAnyofPath3GetAsync(final ApiCallback<List<Ob
         localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
         return localVarCall;
     }
+    /**
+     * Build call for getPetById0
+     * @param _callback Callback for upload/download progress
+     * @return Call to execute
+     * @throws ApiException If fail to serialize the request body object
+     * @http.response.details
+     <table summary="Response Details" border="1">
+        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
+        <tr><td> 200 </td><td>  </td><td>  -  </td></tr>
+     </table>
+     */
+    public okhttp3.Call getPetById0Call(final ApiCallback _callback) throws ApiException {
+        String basePath = null;
+        // Operation Servers
+        String[] localBasePaths = new String[] {  };
+
+        // Determine Base Path to Use
+        if (localCustomBaseUrl != null){
+            basePath = localCustomBaseUrl;
+        } else if ( localBasePaths.length > 0 ) {
+            basePath = localBasePaths[localHostIndex];
+        } else {
+            basePath = null;
+        }
+
+        Object localVarPostBody = null;
+
+        // create path and map variables
+        String localVarPath = "/fake/duplicated/operationId";
+
+        List<Pair> localVarQueryParams = new ArrayList<Pair>();
+        List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
+        Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+        Map<String, String> localVarCookieParams = new HashMap<String, String>();
+        Map<String, Object> localVarFormParams = new HashMap<String, Object>();
+
+        final String[] localVarAccepts = {
+            "application/json"
+        };
+        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
+        if (localVarAccept != null) {
+            localVarHeaderParams.put("Accept", localVarAccept);
+        }
+
+        final String[] localVarContentTypes = {
+        };
+        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
+        if (localVarContentType != null) {
+            localVarHeaderParams.put("Content-Type", localVarContentType);
+        }
+
+        String[] localVarAuthNames = new String[] {  };
+        return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+    }
+
+    @SuppressWarnings("rawtypes")
+    private okhttp3.Call getPetById0ValidateBeforeCall(final ApiCallback _callback) throws ApiException {
+        return getPetById0Call(_callback);
+
+    }
+
+    /**
+     * 
+     * 
+     * @return Object
+     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+     * @http.response.details
+     <table summary="Response Details" border="1">
+        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
+        <tr><td> 200 </td><td>  </td><td>  -  </td></tr>
+     </table>
+     */
+    public Object getPetById0() throws ApiException {
+        ApiResponse<Object> localVarResp = getPetById0WithHttpInfo();
+        return localVarResp.getData();
+    }
+
+    /**
+     * 
+     * 
+     * @return ApiResponse&lt;Object&gt;
+     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
+     * @http.response.details
+     <table summary="Response Details" border="1">
+        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
+        <tr><td> 200 </td><td>  </td><td>  -  </td></tr>
+     </table>
+     */
+    public ApiResponse<Object> getPetById0WithHttpInfo() throws ApiException {
+        okhttp3.Call localVarCall = getPetById0ValidateBeforeCall(null);
+        Type localVarReturnType = new TypeToken<Object>(){}.getType();
+        return localVarApiClient.execute(localVarCall, localVarReturnType);
+    }
+
+    /**
+     *  (asynchronously)
+     * 
+     * @param _callback The callback to be executed when the API call finishes
+     * @return The request call
+     * @throws ApiException If fail to process the API call, e.g. serializing the request body object
+     * @http.response.details
+     <table summary="Response Details" border="1">
+        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
+        <tr><td> 200 </td><td>  </td><td>  -  </td></tr>
+     </table>
+     */
+    public okhttp3.Call getPetById0Async(final ApiCallback<Object> _callback) throws ApiException {
+
+        okhttp3.Call localVarCall = getPetById0ValidateBeforeCall(_callback);
+        Type localVarReturnType = new TypeToken<Object>(){}.getType();
+        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
+        return localVarCall;
+    }
     /**
      * Build call for op1
      * @param _callback Callback for upload/download progress