OpenAPITools / OpenAPITools/openapi-generator
[BUG] Examples are not available under the mustache template
Open
Nobody has claimed this yet.
Issue: Bug
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
I have defined some responses examples in my openapi specification:
content: application/json
Examples:
Ex1:
Id: anid
And I wanted to edit the markdown generation template, however it seems that under the”operation” section “examples” are always null.
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 reproducing the OpenAPI response example from the issue and inspect the markdown generation template's operation section. Trace why the examples value is null, then verify that the defined response example is available to the template and appears in the generated markdown.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100