Openapi generator minor improvements#3511
Open
Silvanoc wants to merge 10 commits into
Open
Conversation
No use of the LifecycleMixin hooks, removing that unneeded inheritance. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Using a context manager to ensure that the OpenAPI generator closes the template file once read. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Add docstring describing what the OpenApiGenerator class does. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
The template is required, ensuring its presence at both CLI and class level. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Do some basic sanity checks on the template. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Make replacement of `components/schemas` in the template consistent and more readable. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3511 +/- ##
==========================================
+ Coverage 80.96% 84.35% +3.39%
==========================================
Files 157 157
Lines 18658 18667 +9
Branches 3931 3935 +4
==========================================
+ Hits 15106 15747 +641
+ Misses 2696 2014 -682
- Partials 856 906 +50
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
9846b61 to
02903eb
Compare
Class title and description where being removed. But only title should be removed because that is exactly the dictionary entry value in the resulting JSON-Schema. But description should be kept. This patch fixes it. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
Add additional tests to reduce issues in future changes. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
02903eb to
c2d3cde
Compare
Contributor
Author
|
This PR addresses comments raised by @amc-corey-cox on PR #3300 and not addressed before merging and adds some additional minor improvements. |
Dump to a "better looking" version. Previous version (v0.0.1) was too alphaish. This patch bumps the version to a more stable looking one (v0.1.0). Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
How was this tested?
New added tests.
Areas of uncertainty
Minor changes.
Checklist
AI Assistance
If you used AI tools while preparing this PR, you are still the author and responsible for understanding, verifying, and defending your submission. Please engage with reviewers personally rather than through your agent during feedback and revisions. See our AI Covenant for details.