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

[swift5] Make it possible to opt out of JSONEncodable conformance #12664

Merged
merged 2 commits into from
Jun 22, 2022
Merged

[swift5] Make it possible to opt out of JSONEncodable conformance #12664

merged 2 commits into from
Jun 22, 2022

Conversation

stjernegard
Copy link
Contributor

Fixes #12130

JSONEncodable is not a native type and does not exist if only models are generated. We use OpenAPI to generate only the models and none of the utils or other parts, so we need the generated models to be valid and able to compile as a stand-alone package.

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.
  • File the PR against the correct branch: master (6.0.1) (patch release), 6.1.x (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.
    (@jgavris @ehyche @Edubits @jaz-ah @4brunu)

JSONEncodable is not a native type and does not exist if only models are generated.
@4brunu
Copy link
Contributor

4brunu commented Jun 22, 2022

@stjernegard Hey, thanks for creating this PR.
Looks good to me.
Let's wait for CI to finish.
Thanks

@stjernegard
Copy link
Contributor Author

Thanks :)
I noticed that my editor had chosen the wrong indentation level, so I’ve fixed that to match the rest of the file.

Copy link
Contributor

@4brunu 4brunu left a comment

Choose a reason for hiding this comment

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

LGTM

@4brunu 4brunu merged commit b1ea0f3 into OpenAPITools:master Jun 22, 2022
@stjernegard stjernegard deleted the disable-jsoncodable branch June 22, 2022 16:26
@wing328 wing328 added this to the 6.0.1 milestone Jul 2, 2022
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][Swift] Generating standalone Swift models should not conform them to JSONEncodable
3 participants