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

Don't include read-only properties in Python examples. #9252

Merged

Conversation

therve
Copy link
Contributor

@therve therve commented Apr 13, 2021

When using a schema with read-only fields as API inputs, Python
generates examples for those: this excludes them.

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, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

therve added 2 commits April 13, 2021 13:59
When using a schema with read-only fields as API inputs, Python
generates examples for those: this excludes them.
@therve
Copy link
Contributor Author

therve commented Apr 13, 2021

@spacether spacether added this to the 5.1.1 milestone Apr 14, 2021
@spacether
Copy link
Contributor

spacether commented Apr 14, 2021

@therve these examples should only be omitted when sending data to the server, right?
One could get back a readonly property or instance, right?
Our tooling does not currently autogen mock responses but if we did in the future one would need to be aware of this.

@therve
Copy link
Contributor Author

therve commented Apr 14, 2021

@therve these examples should only be omitted when sending data to the server, right?
One could get back a readonly property or instance, right?
Our tooling does not currently autogen mock responses but if we did in the future one would need to be aware of this.

Right if we ever generate response code this would need to be changed.

Copy link
Contributor

@spacether spacether left a comment

Choose a reason for hiding this comment

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

Looks good; thank you for your PR!

@spacether spacether merged commit 60dcf86 into OpenAPITools:master Apr 14, 2021
tray2100 pushed a commit to tray2100/openapi-generator that referenced this pull request May 23, 2021
…9252)

* Don't include read-only properties in Python examples.

When using a schema with read-only fields as API inputs, Python
generates examples for those: this excludes them.

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

Successfully merging this pull request may close these issues.

2 participants