OpenAPITools / OpenAPITools/openapi-generator
[REQ][MARKDOWN] Return type label does not specify content of the list.
Open
Nobody has claimed this yet.
Doc: Markdown
Enhancement: Feature
- 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.
All methods that return some kind of list have a label that says just "List" without specifying the content that can be very different. This is confusing for the user.
### Return type
[**List**](../\Models/string.md)
Describe the solution you'd like
Specify the contained data type, e.g. List<User>
Describe alternatives you've considered
Additional context
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
No files or tests are identified in the issue. Start by locating the generator entry point or template that produces Markdown return-type labels, then trace how list element types are represented. Done means generated documentation labels list returns with their contained type, such as List, and existing output remains valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100