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

Fix: in typescript fixes additionalProperties handling when extending models #18164

Conversation

mvarchdev
Copy link
Contributor

Previously the extending of models when instantionTypte('map') was not set for language looked like this: class ProductData extends null<String, ProductDataBase>, this is not correct, it should look like this? class ProductData extends ProductDataBase. This PR fixes that.

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.1.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.

@sebastianhaas @mkusaka

@wing328
Copy link
Member

wing328 commented Mar 21, 2024

cc
@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution

@macjohnny macjohnny merged commit 9c26ad4 into OpenAPITools:master Mar 21, 2024
14 checks passed
zapodot pushed a commit to zapodot/openapi-generator that referenced this pull request Mar 21, 2024
@wing328 wing328 added this to the 7.5.0 milestone Apr 17, 2024
@andreseloysv
Copy link

andreseloysv commented Apr 22, 2024

For an object like this:

Foo:
  type: object
  required:
    - id
  properties:
    id:
      type: string
  additionalProperties: {}

The current solution with typescript-node generates the following class:

export class Foo extends any {

This results in a compilation error because you cannot extend from any. In my opinion, this issue should be addressed before closing the pull request.

@mvarchdev
Copy link
Contributor Author

@andreseloysv Will you look at that? Basicaly it should not happen that there will be additionalProperties empty, but of course it should be handled as it is edge case.

@s-xu-wafios
Copy link

s-xu-wafios commented Apr 24, 2024

Just to provide more information, in the previous version (7.4.0), for such an object

type: object
  properties:
    notificationSettings:
      push:
        type: boolean
      email:
        type: boolean
additionalProperties: true

In 7.4.0 it would generate (also not sure if it's correct)
export class Foo extends null<String, any> {

and in 7.5.0 it generates (with compilation error)
export class Foo extends any {

@mvarchdev
Copy link
Contributor Author

mvarchdev commented Apr 24, 2024

extends null<String, any> is not correct and will result in compilation error and linting errors. That is the reason why I implemented this. You simply cannot extend null and null does not have any type parameters. We can put check (i do not know currently what check) so instead of extending any we can put Record<string, unknown> which is correct.

@mvarchdev
Copy link
Contributor Author

I will create new PR for that!

@mvarchdev
Copy link
Contributor Author

Guys, followup created #18491, CC @andreseloysv @s-xu-wafios

@mvarchdev
Copy link
Contributor Author

mvarchdev commented Apr 24, 2024

CC @macjohnny @wing328 followup PR created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants