Skip to content
New issue

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

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

Already on GitHub? # to your account

[openapi-normalizer] enable some rules by default #15501

Merged
merged 6 commits into from
May 16, 2023

Conversation

wing328
Copy link
Member

@wing328 wing328 commented May 13, 2023

  • enable some rules by default to reduce issue reports: SIMPLIFY_ONEOF_ANYOF, SIMPLIFY_BOOLEAN_ENUM
  • add a new rule "DISABLE_ALL" to disable all the rules
  • rename "ALL" to "ENABLE_ALL" to enable all rules (true or false)
  • add tests

FYI @OpenAPITools/generator-core-team

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/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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 wing328 added this to the 7.0.0 milestone May 14, 2023
@@ -221,7 +221,7 @@ export type PetsFilteredPatchRequestPetTypeEnum = typeof PetsFilteredPatchReques
* @type PetsPatchRequest
* @export
*/
export type PetsPatchRequest = Cat | Dog | any;
export type PetsPatchRequest = Cat | Dog;
Copy link
Member Author

Choose a reason for hiding this comment

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

FYI. This PR results in changes in typescript-axios output, which can be reverted by setting the openapi-normalizer rule accordingly.

@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)

@wing328 wing328 marked this pull request as ready for review May 14, 2023 08:56
@wing328 wing328 merged commit c5a1dbe into master May 16, 2023
@wing328 wing328 deleted the openapi-normalizer-default-on branch May 16, 2023 06:04
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant