swagger-api / swagger-api/swagger-codegen
Get the request example mustache variable for Confluence Wiki template
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
I wanted the documentation for my API spec to be in different format then what's generated by Cwiki client by swagger. For it i created a mustache template of my own which works like a charm.
The only issue i am facing now is, i want to render the Request example in my mustache template but i can't find the corresponding mustache variable.
For eg. - For POST request, the body looks like below json which is generated by spec file.
{
"key":"value"
}
Is there a way to get this example in the mustache template that i created.?
Thanks & Regards
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 examining the custom Mustache template and the Swagger/OpenAPI specification that generates the Confluence Wiki documentation. Trace which request data is exposed to the template context, then confirm that a variable can render the POST request example JSON and validate it with a generated document.
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
- 28/100