Do not generate new models for readonly schema references (#13303)

* Add example of nested schema issue

* Add failing test case

* Special case properties with a single allOf and readonly

* Remove rogue file from FILES

Author: mrginglymus

bin/configs/typescript-fetch-allOf-readonly.yaml

@@ -0,0 +1,4 @@
+generatorName: typescript-fetch
+outputDir: samples/client/petstore/typescript-fetch/builds/allOf-readonly
+inputSpec: modules/openapi-generator/src/test/resources/3_0/allOf-readonly.yaml
+templateDir: modules/openapi-generator/src/main/resources/typescript-fetch

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

@@ -189,6 +189,17 @@ private boolean isModelNeeded(Schema schema, Set<Schema> visitedSchemas) {
         if (schema instanceof ComposedSchema) {
             // allOf, anyOf, oneOf
             ComposedSchema m = (ComposedSchema) schema;
+
+            if (m.getAllOf() != null && m.getAllOf().size() == 1 && m.getReadOnly() != null && m.getReadOnly()) {
+                // Check if this composed schema only contains an allOf and a readOnly.
+                ComposedSchema c = new ComposedSchema();
+                c.setAllOf(m.getAllOf());
+                c.setReadOnly(true);
+                if (m.equals(c)) {
+                    return isModelNeeded(m.getAllOf().get(0), visitedSchemas);
+                }
+            }
+
             if (m.getAllOf() != null && !m.getAllOf().isEmpty()) {
                 // check to ensure at least of the allOf item is model
                 for (Schema inner : m.getAllOf()) {

modules/openapi-generator/src/test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchModelTest.java

@@ -36,9 +36,11 @@
 import java.time.OffsetDateTime;
 import java.time.ZoneOffset;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Locale;
+import java.util.Map;
 
 /*
 import static io.swagger.codegen.CodegenConstants.IS_ENUM_EXT_NAME;
@@ -458,4 +460,14 @@ public void testWithoutNullSafeAdditionalProps() {
 
         Assert.assertEquals(codegen.getTypeDeclaration(model), "{ [key: string]: string; }");
     }
+
+    @Test(description = "Don't generate new schemas for readonly references")
+    public void testNestedReadonlySchemas() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/allOf-readonly.yaml");
+        final DefaultCodegen codegen = new TypeScriptFetchClientCodegen();
+        codegen.processOpts();
+        codegen.setOpenAPI(openAPI);
+        final Map<String, Schema> schemaBefore = openAPI.getComponents().getSchemas();
+        Assert.assertEquals(schemaBefore.keySet(), Sets.newHashSet("club", "owner"));
+    }
 }

modules/openapi-generator/src/test/resources/3_0/allOf-readonly.yaml

@@ -0,0 +1,40 @@
+openapi: 3.0.1
+info:
+  version: 1.0.0
+  title: Example
+  license:
+    name: MIT
+servers:
+  - url: http://api.example.xyz/v1
+paths:
+  /person/display/{personId}:
+    get:
+      parameters:
+        - name: personId
+          in: path
+          required: true
+          description: The id of the person to retrieve
+          schema:
+            type: string
+      operationId: list
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/club"
+components:
+  schemas:
+    club:
+      properties:
+        owner:
+          allOf:
+            - $ref: '#/components/schemas/owner'
+          readOnly: true
+
+    owner:
+      properties:
+        name:
+          type: string
+          maxLength: 255

samples/client/petstore/typescript-fetch/builds/allOf-readonly/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/client/petstore/typescript-fetch/builds/allOf-readonly/.openapi-generator/FILES

@@ -0,0 +1,7 @@
+apis/DefaultApi.ts
+apis/index.ts
+index.ts
+models/Club.ts
+models/Owner.ts
+models/index.ts
+runtime.ts

samples/client/petstore/typescript-fetch/builds/allOf-readonly/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.1.0-SNAPSHOT

samples/client/petstore/typescript-fetch/builds/allOf-readonly/apis/DefaultApi.ts

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Example
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  Club,
+} from '../models';
+import {
+    ClubFromJSON,
+    ClubToJSON,
+} from '../models';
+
+export interface ListRequest {
+    personId: string;
+}
+
+/**
+ * 
+ */
+export class DefaultApi extends runtime.BaseAPI {
+
+    /**
+     */
+    async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
+        if (requestParameters.personId === null || requestParameters.personId === undefined) {
+            throw new runtime.RequiredError('personId','Required parameter requestParameters.personId was null or undefined when calling list.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/person/display/{personId}`.replace(`{${"personId"}}`, encodeURIComponent(String(requestParameters.personId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClubFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async list(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Club> {
+        const response = await this.listRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

samples/client/petstore/typescript-fetch/builds/allOf-readonly/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './DefaultApi';

samples/client/petstore/typescript-fetch/builds/allOf-readonly/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis';
+export * from './models';