OpenAPITools / OpenAPITools/openapi-generator
[REQ] Post process VERSION, and openapi.yaml from python-flask
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
While using the code generator for python-flask, I am unable to control how the .openapi-generator/VERSION, and <src>/openapi/openapi.yaml are formatted
Describe the solution you'd like
A documented behaviour to use the <LANG>_POST_FROCESSING_FILE environment variable to control the formatting.
Describe alternatives you've considered
- Running the formatting on all files afterwards, regardless of which files where changed
Additional context
The reason for this, is that I'd like the generated code to be generated automatically when the specification changes, in a pre-commit hook.
Additionally, the generated code must comply with the style guide of the project.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the python-flask generator and its existing post-processing configuration, then trace how it handles .openapi-generator/VERSION and /openapi/openapi.yaml. Document and implement the requested _POST_FROCESSING_FILE behavior for these files, and verify that generated output can be formatted selectively for pre-commit use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask, openapi, python
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100