swagger-api/swagger-codegen

~~~ block does not work in HTML codegen

Open

#2,807 opened on May 9, 2016

View on GitHub
 (2 comments) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

Description

My description contains a ~~~ block that renders fine in the swagger editor. When I use the code gen command with HTML as the target language no code block is being created but the ~~~ are displayed in the text. Furthermore all the line breaks are shown as \n. I'm using http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.1.6/swagger-codegen-cli-2.1.6.jar

Contributor guide

Tech stack
javahtml
Domain
backendapitooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaMustache template engineHTML escaping
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the HTML template files in swagger codegen, specifically the Mustache templates under modules/swagger codegen/src/main/resources/htmldocs/. Look for how the description field is rendered and whether markdown code fences (~~~) are being processed or escaped. Also examine the line break handling to prevent \n from appearing literally. Check if there are existing unit tests for HTML output and consider adding a test case for this bug.