OpenAPITools / OpenAPITools/openapi-generator
[REQ] Property requirements/restrictions not included in generated AsciiDoc files
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.
Property restrictions (maxLength, minLength, etc) should be used included in the generated AsciiDoc file(s).
Describe the solution you'd like
Property requirements/restrictions to generated files.
For relevant requirements/restrictions see: https://swagger.io/specification/#schema-object
Describe alternatives you've considered
We could theoretically add these manually but it's not practical as we want this fully automated.
Additional context
It is unclear whether:
- the properties aren't read from openapi.json and available for the template engine (mustaché)
- the AsciiDoc template simply has to be updated
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 checking whether property restrictions from openapi.json are available to the mustaché template engine, then inspect the AsciiDoc template for missing fields. Done means generated AsciiDoc files include relevant schema property requirements and restrictions such as maxLength and minLength, based on the OpenAPI Schema Object.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100