Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #5171
Closed
Open
Issue created Jan 31, 2020 by Administrator@rootContributor5 of 5 checklist items completed5/5 checklist items

[BUG][typescript-angular] allOf without discriminator results in unnecessary imports

Created by: amakhrov

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
Description

When a model uses allOf, where some of the referenced models do not have a discriminator (hence, do not denote any hierarchy), the target interface just gets all properties copied from the referenced models, no interface inheritance/extending involved.

However, the base interfaces are still imported into the file with the target model - despite being unused.

openapi-generator version

Latest

OpenAPI declaration file content or url
definitions:
  ExtraFields:
    type: object
    properties:
      extra_field:
        type: string

  ResponseOnePlus:
    type: object
    allOf:
      - $ref: '#/definitions/ExtraFields'
      - type: object
        properties:
          own_field:
            type: string
Command line used for generation
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
    -i /local/spec.yaml \
    -g typescript-angular \
    -o /local/generated
Steps to reproduce
  • Run a command above, providing a spec file with allOf
  • Check model/responseOnePlus.ts.It will looks like this:
import { ExtraFields } from './extraFields';
import { ResponseOnePlusAllOf } from './responseOnePlusAllOf';

export interface ResponseOnePlus { 
    extraField?: string;
    ownField?: string;
}

Both imports here are not used.

Related issues/PRs

Similar issues:

  • typescript-axios: https://github.com/OpenAPITools/openapi-generator/issues/4804
  • typescript-rxjs: https://github.com/OpenAPITools/openapi-generator/issues/4629
Suggest a fix

The fixes for linked axios and rxjs generators above change the approach for generating a target interface: instead of copying all properties from the source interfaces into the target one, the target type is simply defined as type intersection.

Perhaps we should consider doing the same for typescript-angular (and probably other typescript generators that emit each model in a separate file with imports).

Note that the above mentioned fixes apply the same approach both with or without discriminator, thus erasing the semantic difference between them (hierarchy vs composition)

Assignee
Assign to
Time tracking