OpenAPITools / OpenAPITools/openapi-generator
[REQ] Schema preprocessor wanted
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.
My problem is that I am using a schema file (occasionally updated) and there is a double that should be a decimal. I would like to preprocess the schema file to ensure this fix is always present.
Describe the solution you'd like
There are several ways to offer such a preprocessor. One way could be to allow the use of the Overlay Specification, but I don't know if it is finished yet: https://github.com/OAI/Overlay-Specification
I would like for the preprocessor step not create a new file, but make an on-the-fly transformation of the schema file, with optional debug output.
Describe alternatives you've considered
Adding a README file specifying that the schema file must be manually fixed.
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 reviewing the requested schema-file transformation and the linked Overlay Specification to determine the intended preprocessing model. Compare the proposed on-the-fly transformation and optional debug output with the manual README workaround. Done means an agreed implementation approach that consistently changes the double to a decimal without creating a replacement schema file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100