Validate your YAML files online using yamlvalidator.com. Type in or paste your YAML in the editor below and view the errors and JSON representation instantly. YAML Validator also works offline on latest versions of Chrome, Firefox. Online YAML tools is a collection of useful YAML utilities for working with Yet Another Markup Language configs and files. All YAML tools are simple, free and easy to use.
Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upHave a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
commented Jul 21, 2016
From @Rasika3091 on July 21, 2016 14:46
Hello, I am converting my yaml file to HMTL through the swagger editor online. But the formatting applied in the descriptions are not getting applied. Its not looking proper as seen in the editor. I have provided on example. Please open it in Online swagger editor and covert it to HTML and take a look at all the description parts. There is no formatting in the HTML file for description. How can I make this work ? I am attaching the html document . Please take a look. Its urgent. I have to convert my documentation to HTML. Copied from original issue: swagger-api/swagger-editor#1016 |
referenced this issue Jul 21, 2016
ClosedFormatting not getting reflected when converting yaml file to HTML in swagger online editor #1016
commented Jul 22, 2016
Hello, Thanks for shifting the issue. But can you tell me whats the status of the issue ? |
commented Jul 22, 2016
I think the issue you're referring to is to convert markdown in the description to HTML properly Currently, the HTML documentation generator does not support that. You can customize the generator to convert entries (in markdown syntax) in the YAML spec to HTML properly. |
added this to the v2.2.1 milestone Jul 22, 2016
added the Enhancement: Feature label Jul 22, 2016
commented Jul 22, 2016
Ok.. Then right now you cannot make changes for it ? |
commented Jul 22, 2016
Well everyone can contribute an enhancement for that. If you've cycle, I can show you a good starting point. |
modified the milestones: v2.2.1, v2.2.2Aug 8, 2016
referenced this issue Aug 27, 2016
Open~~~ block does not work in HTML codegen #2807
commented Aug 27, 2016
Duplicate of #479. |
commented Sep 26, 2016
one option: https://github.com/atlassian/commonmark-java |
referenced this issue Jan 23, 2017
Closedhtml output adds backslashes to double quotes #4611
pushed a commit to DavidBiesack/swagger-codegen that referenced this issue Jan 23, 2017
Use {{unescapedDescription}} in html, html2
added a commit that referenced this issue Feb 3, 2017
commented Feb 3, 2017
I'm working on a PR for this.... I'm doing the transformations in the various postProcess* and preprocessSwagger methods which gets the job done but is not robust (many subclasses may not call super()).However, Mustache was still escaping the text. When I add to get operation:the text is converted from markdown to YAML as but then when the template with {{summary}} and {{unescapedDescription}} is applied, the result has HTML escaping: I found that Mustache then takes the values and runs them through and Mustache appears to use the default escaper Escapers.simple() whichreplace < with < etc.Thus, I think the config needs to have an escaper that can override this. I'm considering adding to CodegenConfig and add tot DefaultCodegen . Then the html codegen can override this and return Escapers.NONE . DefaultCodegen then passes the escaper to the Template compiler(in two places). Please comment on this approach. |
modified the milestones: v2.2.2, FutureFeb 15, 2017
pushed a commit to DavidBiesack/swagger-codegen that referenced this issue Mar 10, 2017
referenced this issue Mar 10, 2017
ClosedAllow control of HTML escaping in templates (#3436) #5018
pushed a commit to DavidBiesack/swagger-codegen that referenced this issue Mar 10, 2017
referenced this issue Mar 10, 2017
ClosedAllow control of HTML escaping in templates (#3436) #5020
referenced this issue Mar 21, 2017
MergedAdd support for Markdown in -l html #5144
commented Mar 23, 2017
Note that a pull request (#5144) was merged which will fix this issue in swagger-codegen generate -l html output - it may take some time before that is deployed on editor.swagger.io. Also, I was able to resolve the Mustache HTML escaping without having to employ the proposed changes listed above. We can probably close this issue as fixed (but I'll let the maintainers do that.) |
commented Mar 23, 2017
@DavidBiesack thanks for the fix |
![Yaml editor online Yaml editor online](/uploads/1/2/5/0/125000551/905878412.png)
![Photo editor online Photo editor online](/uploads/1/2/5/0/125000551/801563234.png)
pushed a commit to davidgri/swagger-codegen that referenced this issue May 11, 2017
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment