Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Never create inline model for allOf with single $ref #18945

Merged
merged 1 commit into from
Jun 19, 2024

Conversation

ReneZeidler
Copy link
Contributor

@ReneZeidler ReneZeidler commented Jun 17, 2024

Fixes #15077

The previous fix for this in #16096 is incomplete because it still generates unnecessary inline models when readOnly or nullable is used in conjunction with other properties like description.
This commit fixes the logic error and adds testcases.

Schema (full schema is included issue_15077.yaml):

    Limits:
      type: object
      properties:
        allOfRef:
          allOf:
            - $ref: '#/components/schemas/NumberRange'
        allOfRefWithDescription:
          description: |
            Description for this property
          allOf:
            - $ref: '#/components/schemas/NumberRange'
        allOfRefWithReadonly:
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/NumberRange'
        allOfRefWithDescriptionAndReadonly:
          description: |
            Description for this readonly property
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/NumberRange'
      required:
        - allOfRef
        - allOfRefWithDescription
        - allOfRefWithReadonly
        - allOfRefWithDescriptionAndReadonly

Previous output (excerpt from output using typescript-angular generator, but the issue is independent of any language-specific generator):

export interface Limits { 
    allOfRef: NumberRange;
    /**
     * Description for this property 
     */
    allOfRefWithDescription: NumberRange;
    readonly allOfRefWithReadonly: NumberRange;
    allOfRefWithDescriptionAndReadonly: LimitsAllOfRefWithDescriptionAndReadonly;
}

The property allOfRefWithDescriptionAndReadonly generates an unnecessary inline schema that is a copy of NumberRange. The description is also missing from the property (and is instead applied to the generated inline model). The readOnly property is completely ignored.

Output with PR:

export interface Limits { 
    allOfRef: NumberRange;
    /**
     * Description for this property 
     */
    allOfRefWithDescription: NumberRange;
    readonly allOfRefWithReadonly: NumberRange;
    /**
     * Description for this readonly property 
     */
    readonly allOfRefWithDescriptionAndReadonly: NumberRange;
}

No unnecessary inline schema is created in all cases. The allOfRefWithDescriptionAndReadonly correctly has its description included as a comment and has the readonly modifier set.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Jun 19, 2024

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328 wing328 added Issue: Bug Inline Schema Handling Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf labels Jun 19, 2024
@wing328 wing328 added this to the 7.7.0 milestone Jun 19, 2024
Fixes OpenAPITools#15077

The previous fix for this in OpenAPITools#16096 is incomplete because it still
generates unnecessary inline models when readOnly or
nullable is used in conjunction with other properties like
description.
This commit fixes the logic error and adds testcases.
@ReneZeidler
Copy link
Contributor Author

your commit (as shown in the Commits tab) is not linked to your Github account

Thanks for the note, I fixed the commit

@wing328
Copy link
Member

wing328 commented Jun 19, 2024

tested locally to confirm the fix.

--- a/.openapi-generator/FILES
+++ b/.openapi-generator/FILES
@@ -7,7 +7,6 @@ build.gradle
 build.sbt
 docs/DefaultApi.md
 docs/Limits.md
-docs/LimitsAllOfRefWithDescriptionAndReadonly.md
 docs/NumberRange.md
 git_push.sh
 gradle.properties
@@ -38,5 +37,4 @@ src/main/java/org/openapitools/client/auth/HttpBasicAuth.java
 src/main/java/org/openapitools/client/auth/HttpBearerAuth.java
 src/main/java/org/openapitools/client/model/AbstractOpenApiSchema.java
 src/main/java/org/openapitools/client/model/Limits.java
-src/main/java/org/openapitools/client/model/LimitsAllOfRefWithDescriptionAndReadonly.java
 src/main/java/org/openapitools/client/model/NumberRange.java

@wing328 wing328 merged commit 5bc7aa3 into OpenAPITools:master Jun 19, 2024
70 checks passed
@NikDevPHP
Copy link

@wing328 Hello, when will it be possible to get an update with this fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Inline Schema Handling Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf Issue: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][TypeScript - axios] Redundant models - the same type is generated multiple times
3 participants