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

[BUG] [typescript-axios] Fixed to allow setting to any type when additionalProperties is a free-form object #17628

Conversation

komase
Copy link

@komase komase commented Jan 17, 2024

Fixes: #16494

Similar to the case when additionalProperties is set to true(additionalProperties: true), I think that when additionalPropertiesis Free-Form Object (additionalProperties: {}), it would be better to set it to Any type.

This file too (samples/client/petstore/typescript-axios/builds/test-petstore/api.ts) has [key: string]: object; in it, which is causing a type error, but this issue will be resolved with the modifications in this PR.

I'm sorry, but when I was preparing to create a PR, I realized that there is already an existing PR with a proposed fix. It seems our approaches to the solution differ, so if it turns out that my modifications are not needed, I will close my PR.

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.

For TypeScript, @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka

… Object

When additionalProperties type is a Free-Form Object, such as Object, {}, or true,it is more appropriate to use any type instead of object.

This modification only affects the TypeScript Axios Clients generators.
@komase komase changed the title Modified to set to any type when additionalProperties is an Free-Form Object [BUG] [typescript-axios] Fixed to allow setting to any type when additionalProperties is a free-form object Jan 19, 2024
@macjohnny
Copy link
Member

closing in favor of #17625

@macjohnny macjohnny closed this Feb 2, 2024
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.

[BUG] v7.0.0 typescript-axios generator generates export interface ProtobufAny different from v6.6.0
2 participants