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

test(OpenAPINormalizer): nullability normalization for 3.1 specs #19714

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

joscha
Copy link
Contributor

@joscha joscha commented Sep 29, 2024

Follow-up to #19687

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

@wing328 wing328 merged commit d68a186 into OpenAPITools:master Sep 30, 2024
15 checks passed
@wing328 wing328 mentioned this pull request Sep 30, 2024
5 tasks
assertTrue(((Schema) schema.getProperties().get("stringDataOrNull")).getNullable());
assertTrue(((Schema) schema.getProperties().get("oneofOrNull")).getNullable());
}

Copy link
Member

Choose a reason for hiding this comment

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

thanks for adding the unit test

do we still need the samples generated by bin/configs/typescript-consolidated-nullable.yaml ?

(we want to avoid too many samples as the project now contains many files that it will take quite a while to clone)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Given there is not a single example with an optional array that started showing this issue in any way I'd suggest to keep the sample, however, we could combine a few samples together to reduce the footprint, as a lot of samples only show a specific issue in a property. It does make it slightly harder to work with and debug though, when trying to find an issue.

Copy link
Member

Choose a reason for hiding this comment

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

we could combine a few samples together to reduce the footprint, as a lot of samples only show a specific issue in a property.

good idea

you may consider adding the Echo API client tests for typescript client generator and starting add these test cases to a customized version of echo api spec. used by typescript generator only.

https://github.com/OpenAPITools/openapi-generator/wiki/Integration-Tests#echo-server

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies, I am trying to understand how these would help the issue - looking at the sample from #14442 we'd still check in the generated code?

Copy link
Member

Choose a reason for hiding this comment

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

instead of creating a separate spec to test nullable array, one can copy the echo api client spec and add the test case for nullable array instead for typescript echo api client.

in other words, you can consolidate all these different test cases into echo api spec instead.

@wing328 wing328 added Enhancement: CI/Test OpenAPI Normalizer Normalize the spec for easier processing labels Sep 30, 2024
@wing328 wing328 added this to the 7.9.0 milestone Sep 30, 2024
@joscha joscha deleted the joscha/test-31-nullability branch September 30, 2024 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement: CI/Test OpenAPI Normalizer Normalize the spec for easier processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants