use html-escaped description for C# (client, server), Java server (#6061

)
swagger-api · Jul 14, 2017 · c1825b4 · c1825b4
1 parent 9c56bb6
commit c1825b4
Show file tree

Hide file tree

Showing 26 changed files with 94 additions and 55 deletions.
diff --git a/bin/java-petstore-all.sh b/bin/java-petstore-all.sh
@@ -14,4 +14,5 @@
 ./bin/java-petstore-retrofit2-play24.sh
 ./bin/java-petstore-jersey2-java6.sh
 ./bin/java-petstore-resttemplate.sh
+./bin/java-petstore-resttemplate-withxml.sh
 ./bin/java-petstore-resteasy.sh
diff --git a/bin/java-petstore-resttemplate-withxml.sh b/bin/java-petstore-resttemplate-withxml.sh
@@ -26,7 +26,7 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="$@ generate -i modules/swagger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -l java -c bin/java-petstore-resttemplate.json -o samples/client/petstore/java/resttemplate-withXml -DhideGenerationTimestamp=true,withXml=true"
+ags="$@ generate -i modules/swagger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml --artifact-id swagger-pestore-resttemplate-withxml -l java -c bin/java-petstore-resttemplate.json -o samples/client/petstore/java/resttemplate-withXml -DhideGenerationTimestamp=true,withXml=true"
 
 echo "Removing files and folders under samples/client/petstore/java/resttemplate/src/main"
 rm -rf samples/client/petstore/java/resttemplate-withXml/src/main

diff --git a/modules/swagger-codegen/src/main/resources/Java/modelInnerEnum.mustache b/modules/swagger-codegen/src/main/resources/Java/modelInnerEnum.mustache
@@ -1,5 +1,5 @@
  /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
 {{#gson}}
  @JsonAdapter({{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.Adapter.class)

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf-cdi/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf-cdi/pojo.mustache
@@ -14,10 +14,16 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
  private {{{datatypeWithEnum}}} {{name}} = {{{defaultValue}}};{{/vars}}
 
  {{#vars}}
- /**{{#description}}
- * {{{description}}}{{/description}}{{#minimum}}
- * minimum: {{minimum}}{{/minimum}}{{#maximum}}
- * maximum: {{maximum}}{{/maximum}}
+ /**
+ {{#description}}
+ * {{description}}
+ {{/description}}
+ {{#minimum}}
+ * minimum: {{minimum}}
+ {{/minimum}}
+ {{#maximum}}
+ * maximum: {{maximum}}
+ {{/maximum}}
  **/
  public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
  this.{{name}} = {{name}};

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/enumOuterClass.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/enumOuterClass.mustache
@@ -4,7 +4,7 @@ import com.fasterxml.jackson.annotation.JsonValue;
 {{/jackson}}
 
 /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
 public enum {{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
  {{#gson}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pojo.mustache
@@ -33,7 +33,7 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {
  {{#vars}}
  /**
  {{#description}}
- * {{{description}}}
+ * {{description}}
  {{/description}}
  {{^description}}
  * Get {{name}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/enumClass.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/enumClass.mustache
@@ -1,5 +1,5 @@
  /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
  public enum {{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} {
  {{#gson}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/enumOuterClass.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/enumOuterClass.mustache
@@ -3,7 +3,7 @@ import com.fasterxml.jackson.annotation.JsonCreator;
 {{/jackson}}
 
 /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
 public enum {{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
  {{#gson}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/modelEnum.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/modelEnum.mustache
@@ -3,7 +3,7 @@ import com.fasterxml.jackson.annotation.JsonCreator;
 {{/jackson}}
 
 /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
 public enum {{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
  {{#gson}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/pojo.mustache
@@ -63,9 +63,9 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
  {{/isMapContainer}}
 
  {{/isReadOnly}}
-  /**
+ /**
  {{#description}}
- * {{{description}}}
+ * {{description}}
  {{/description}}
  {{^description}}
  * Get {{name}}
@@ -77,7 +77,7 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
  * maximum: {{maximum}}
  {{/maximum}}
  * @return {{name}}
- **/
+  **/
  {{#vendorExtensions.extraAnnotation}}
  {{{vendorExtensions.extraAnnotation}}}
  {{/vendorExtensions.extraAnnotation}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/eap/enumClass.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/eap/enumClass.mustache
@@ -1,5 +1,5 @@
  /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
  public enum {{#datatypeWithEnum}}{{.}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} {
  {{#allowableValues}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/eap/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/eap/pojo.mustache
@@ -11,10 +11,16 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
  private {{{datatypeWithEnum}}} {{name}} = {{{defaultValue}}};{{/vars}}
 
  {{#vars}}
- /**{{#description}}
- * {{{description}}}{{/description}}{{#minimum}}
- * minimum: {{minimum}}{{/minimum}}{{#maximum}}
- * maximum: {{maximum}}{{/maximum}}
+ /**
+ {{#description}}
+ * {{description}}
+ {{/description}}
+ {{#minimum}}
+ * minimum: {{minimum}}
+ {{/minimum}}
+ {{#maximum}}
+ * maximum: {{maximum}}
+ {{/maximum}}
  **/
  {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}
  @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}")

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/enumClass.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/enumClass.mustache
@@ -1,5 +1,5 @@
  /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
  public enum {{#datatypeWithEnum}}{{.}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} {
  {{#allowableValues}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/resteasy/pojo.mustache
@@ -11,10 +11,16 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
  private {{{datatypeWithEnum}}} {{name}} = {{{defaultValue}}};{{/vars}}
 
  {{#vars}}
- /**{{#description}}
- * {{{description}}}{{/description}}{{#minimum}}
- * minimum: {{minimum}}{{/minimum}}{{#maximum}}
- * maximum: {{maximum}}{{/maximum}}
+ /**
+ {{#description}}
+ * {{description}}
+ {{/description}}
+ {{#minimum}}
+ * minimum: {{minimum}}
+ {{/minimum}}
+ {{#maximum}}
+ * maximum: {{maximum}}
+ {{/maximum}}
  **/
  {{#vendorExtensions.extraAnnotation}}{{{vendorExtensions.extraAnnotation}}}{{/vendorExtensions.extraAnnotation}}
  @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}")

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/spec/enumOuterClass.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/spec/enumOuterClass.mustache
@@ -4,7 +4,7 @@ import com.fasterxml.jackson.annotation.JsonValue;
 {{/jackson}}
 
 /**
- * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
+ * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
  */
 public enum {{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
  {{#gson}}

diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/spec/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/spec/pojo.mustache
@@ -11,10 +11,16 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} {{#seriali
  private {{{datatypeWithEnum}}} {{name}} = {{{defaultValue}}};{{/vars}}
 
  {{#vars}}
- /**{{#description}}
- * {{{description}}}{{/description}}{{#minimum}}
- * minimum: {{minimum}}{{/minimum}}{{#maximum}}
- * maximum: {{maximum}}{{/maximum}}
+ /**
+ {{#description}}
+ * {{description}}
+ {{/description}}
+ {{#minimum}}
+ * minimum: {{minimum}}
+ {{/minimum}}
+ {{#maximum}}
+ * maximum: {{maximum}}
+ {{/maximum}}
  **/
  public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
  this.{{name}} = {{name}};

diff --git a/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache b/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache
@@ -33,9 +33,11 @@ namespace {{packageName}}.Models
  {{#vars}}
  {{#isEnum}}
  /// <summary>
- /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{{description}}}</value>{{/description}}
+ /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  [DataMember(Name="{{baseName}}")]
  public {{{datatypeWithEnum}}}{{#isEnum}}{{^isContainer}}?{{/isContainer}}{{/isEnum}} {{name}} { get; set; }
  {{/isEnum}}
@@ -74,8 +76,10 @@ namespace {{packageName}}.Models
  {{^isEnum}}
  /// <summary>
  /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{description}}</value>{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  [DataMember(Name="{{baseName}}")]
  public {{{datatype}}} {{name}} { get; {{#isReadOnly}}private {{/isReadOnly}}set; }
  {{/isEnum}}

diff --git a/modules/swagger-codegen/src/main/resources/csharp/enumClass.mustache b/modules/swagger-codegen/src/main/resources/csharp/enumClass.mustache
@@ -1,7 +1,9 @@
  /// <summary>
- /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{{description}}}</value>{{/description}}
+ /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  [JsonConverter(typeof(StringEnumConverter))]
  {{>visibility}} enum {{#datatypeWithEnum}}{{.}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}
  {

diff --git a/modules/swagger-codegen/src/main/resources/csharp/modelEnum.mustache b/modules/swagger-codegen/src/main/resources/csharp/modelEnum.mustache
@@ -1,7 +1,9 @@
  /// <summary>
- /// {{^description}}Defines {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{{description}}}</value>{{/description}}
+ /// {{^description}}Defines {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  [JsonConverter(typeof(StringEnumConverter))]
  {{>visibility}} enum {{#datatypeWithEnum}}{{.}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}
  {

diff --git a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache
@@ -20,9 +20,11 @@
  {{#vars}}
  {{#isEnum}}
  /// <summary>
- /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{{description}}}</value>{{/description}}
+ /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  [DataMember(Name="{{baseName}}", EmitDefaultValue={{emitDefaultValue}})]
  public {{{datatypeWithEnum}}}{{#isEnum}}{{^isContainer}}?{{/isContainer}}{{/isEnum}} {{name}} { get; set; }
  {{/isEnum}}

diff --git a/modules/swagger-codegen/src/main/resources/csharp/modelInnerEnum.mustache b/modules/swagger-codegen/src/main/resources/csharp/modelInnerEnum.mustache
@@ -1,8 +1,10 @@
  {{^isContainer}}
  /// <summary>
- /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{{description}}}</value>{{/description}}
+ /// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  [JsonConverter(typeof(StringEnumConverter))]
  {{>visibility}} enum {{#datatypeWithEnum}}{{&.}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}
  {

diff --git a/modules/swagger-codegen/src/main/resources/nancyfx/modelEnum.mustache b/modules/swagger-codegen/src/main/resources/nancyfx/modelEnum.mustache
@@ -1,7 +1,9 @@
  /// <summary>
- /// {{^description}}Defines {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
- /// </summary>{{#description}}
- /// <value>{{{description}}}</value>{{/description}}
+ /// {{^description}}Defines {{{name}}}{{/description}}{{#description}}{{description}}{{/description}}
+ /// </summary>
+ {{#description}}
+ /// <value>{{description}}</value>
+ {{/description}}
  public enum {{#datatypeWithEnum}}{{.}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}
  {
  {{#allowableValues}}{{#enumVars}}

diff --git a/samples/client/petstore/java/resttemplate-withXml/build.gradle b/samples/client/petstore/java/resttemplate-withXml/build.gradle
@@ -83,7 +83,7 @@ if(hasProperty('target') && target == 'android') {
 
  install {
  repositories.mavenInstaller {
- pom.artifactId = 'swagger-petstore-resttemplate'
+ pom.artifactId = 'swagger-pestore-resttemplate-withxml'
  }
  }
 

diff --git a/samples/client/petstore/java/resttemplate-withXml/pom.xml b/samples/client/petstore/java/resttemplate-withXml/pom.xml
@@ -2,9 +2,9 @@
  xsi:schemaLocation="http:https://maven.apache.org/POM/4.0.0 http:https://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>io.swagger</groupId>
- <artifactId>swagger-petstore-resttemplate</artifactId>
+ <artifactId>swagger-pestore-resttemplate-withxml</artifactId>
  <packaging>jar</packaging>
- <name>swagger-petstore-resttemplate</name>
+ <name>swagger-pestore-resttemplate-withxml</name>
  <version>1.0.0</version>
  <url>https://github.com/swagger-api/swagger-codegen</url>
  <description>Swagger Java</description>

diff --git a/samples/client/petstore/java/resttemplate-withXml/settings.gradle b/samples/client/petstore/java/resttemplate-withXml/settings.gradle
@@ -1 +1 @@
-rootProject.name = "swagger-petstore-resttemplate"
+rootProject.name = "swagger-pestore-resttemplate-withxml"
diff --git a/samples/client/petstore/java/resttemplate/pom.xml b/samples/client/petstore/java/resttemplate/pom.xml
@@ -2,9 +2,9 @@
  xsi:schemaLocation="http:https://maven.apache.org/POM/4.0.0 http:https://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>io.swagger</groupId>
- <artifactId>swagger-petstore-resttemplate-withxml</artifactId>
+ <artifactId>swagger-petstore-resttemplate</artifactId>
  <packaging>jar</packaging>
- <name>swagger-petstore-resttemplate-withxml</name>
+ <name>swagger-petstore-resttemplate</name>
  <version>1.0.0</version>
  <url>https://github.com/swagger-api/swagger-codegen</url>
  <description>Swagger Java</description>