Mustache template with unescaped HTML #1177
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @gcatanese, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request resolves an issue where HTML special characters within generated C# documentation comments were being incorrectly HTML escaped. By switching to unescaped variable rendering in the Mustache templates, the generated documentation will now correctly display rich text and embedded XML documentation tags, significantly improving the accuracy and readability of the API documentation.
Highlights
- Template Rendering Fix: I've updated several Mustache templates used for C# code generation to correctly render HTML content within documentation comments. Specifically, I've changed instances of
{{variable}}to{{{variable}}}fordescriptionandvaluefields. This ensures that special characters and embedded HTML tags (like<summary>and<value>) are not HTML escaped and are displayed as intended in the generated C# documentation.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates Mustache templates to use unescaped HTML rendering for descriptions. While this addresses the issue of special characters being escaped, it introduces a potential XML injection vulnerability if the input comes from an untrusted source. Consider sanitizing the input before rendering it in the template.
| @@ -2,12 +2,12 @@ | |||
| /// {{{summary}}} | |||
| /// </summary> | |||
| {{#pathParams}} | |||
| /// <param name="{{paramName}}"><see cref="{{dataType}}"/> - {{description}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param> | |||
| /// <param name="{{paramName}}"><see cref="{{dataType}}"/> - {{{description}}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param> | |||
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| {{/pathParams}} | ||
| {{#bodyParams}} | ||
| /// <param name="{{paramName}}"><see cref="{{dataType}}"/> - {{description}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param> | ||
| /// <param name="{{paramName}}"><see cref="{{dataType}}"/> - {{{description}}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param> |
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| {{/bodyParams}} | ||
| {{#queryParams}} | ||
| /// <param name="{{paramName}}"><see cref="{{dataType}}"/> - {{description}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param> | ||
| /// <param name="{{paramName}}"><see cref="{{dataType}}"/> - {{{description}}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param> |
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| @@ -1,5 +1,5 @@ | |||
| /// <summary> | |||
| /// {{description}}{{^description}}{{classname}}{{/description}} | |||
| /// {{{description}}}{{^description}}{{classname}}{{/description}} | |||
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| @@ -32,10 +32,10 @@ | |||
| {{#isEnum}} | |||
|
|
|||
| /// <summary> | |||
| /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} | |||
| /// {{{description}}}{{^description}}Gets or Sets {{{name}}}{{/description}} | |||
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| /// </summary> | ||
| {{#description}} | ||
| /// <value>{{.}}</value> | ||
| /// <value>{{{.}}}</value> |
There was a problem hiding this comment.
By changing {{.}} to {{{.}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the content comes from an untrusted source. A malicious value could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| @@ -123,7 +123,7 @@ | |||
| /// Initializes a new instance of the <see cref="{{classname}}" /> class. | |||
| /// </summary> | |||
| {{#readWriteVars}} | |||
| /// <param name="{{#lambda.camelcase_param}}{{name}}{{/lambda.camelcase_param}}">{{description}}{{^description}}{{#lambda.camelcase_param}}{{name}}{{/lambda.camelcase_param}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{.}}){{/defaultValue}}.</param> | |||
| /// <param name="{{#lambda.camelcase_param}}{{name}}{{/lambda.camelcase_param}}">{{{description}}}{{^description}}{{#lambda.camelcase_param}}{{name}}{{/lambda.camelcase_param}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{.}}){{/defaultValue}}.</param> | |||
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| @@ -194,9 +194,9 @@ | |||
| {{^isInherited}} | |||
| {{^isEnum}} | |||
| /// <summary> | |||
| /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} | |||
| /// {{{description}}}{{^description}}Gets or Sets {{{name}}}{{/description}} | |||
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| /// </summary>{{#description}} | ||
| /// <value>{{.}}</value>{{/description}} | ||
| /// <value>{{{.}}}</value>{{/description}} |
There was a problem hiding this comment.
By changing {{.}} to {{{.}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the content comes from an untrusted source. A malicious value could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
| @@ -1,6 +1,6 @@ | |||
| {{#model}} | |||
| /// <summary> | |||
| /// {{description}}{{^description}}{{classname}}{{/description}} | |||
| /// {{{description}}}{{^description}}{{classname}}{{/description}} | |||
There was a problem hiding this comment.
By changing {{description}} to {{{description}}}, you're rendering the content without escaping. While this fixes the HTML escaping issue, it introduces a potential XML injection vulnerability if the description comes from an untrusted source. A malicious description could inject arbitrary XML, potentially leading to build failures or corrupted documentation. Consider sanitizing the input before rendering it in the template.
|
To be considered as part of the OpenAPI Generator upgrade |
<summary>and<value>are not correctly displayed, special characters are HTML escaped.This PR updates the templates to render the content of the description without escaping, using
{{{description}}}