[typescript-fetch] Allow multiline documentation (OpenAPITools#6088)

Add a lambda that formats the documentation correctly even if it contains newlines. The generated docs with typedoc looks a lot better and also renders Markdown correctly. Also remove the "no description" fallback for APIs because we don't have it anywhere else, other generators don't generate a default fallback and I'd rather have no documentation than a "no description" string.
MikailBag · May 31, 2020 · 9489ee7 · 9489ee7
1 parent 6ee55a3
commit 9489ee7
Show file tree

Hide file tree

Showing 26 changed files with 43 additions and 29 deletions.
diff --git a/...erator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java b/...erator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java
@@ -17,11 +17,14 @@
 
 package org.openapitools.codegen.languages;
 
+import com.google.common.collect.ImmutableMap;
+import com.samskivert.mustache.Mustache;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.parser.util.SchemaTypeUtil;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.meta.features.DocumentationFeature;
+import org.openapitools.codegen.templating.mustache.IndentedLambda;
 import org.openapitools.codegen.utils.ModelUtils;
 
 import java.io.File;
@@ -134,6 +137,14 @@ public void processOpts() {
         }
     }
 
+    @Override
+    protected ImmutableMap.Builder<String, Mustache.Lambda> addMustacheLambdas() {
+        ImmutableMap.Builder<String, Mustache.Lambda> lambdas = super.addMustacheLambdas();
+        lambdas.put("indented_star_1", new IndentedLambda(1, " ", "* "));
+        lambdas.put("indented_star_4", new IndentedLambda(5, " ", "* "));
+        return lambdas;
+    }
+
     @Override
     public String getTypeDeclaration(Schema p) {
         if (ModelUtils.isFileSchema(p)) {

diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache
@@ -28,8 +28,8 @@ export interface {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterIn
 {{#withInterfaces}}
 {{#operations}}
 /**
- * {{classname}} - interface{{#description}}
- * {{&description}}{{/description}}
+ * {{classname}} - interface
+ * {{#lambda.indented_1}}{{{unescapedDescription}}}{{/lambda.indented_1}}
  * @export
  * @interface {{classname}}Interface
  */
@@ -71,7 +71,7 @@ export interface {{classname}}Interface {
 {{/withInterfaces}}
 {{#operations}}
 /**
- * {{#description}}{{{description}}}{{/description}}{{^description}}no description{{/description}}
+ * {{#lambda.indented_star_1}}{{{unescapedDescription}}}{{/lambda.indented_star_1}}
  */
 {{#withInterfaces}}
 export class {{classname}} extends runtime.BaseAPI implements {{classname}}Interface {

diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/modelEnum.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/modelEnum.mustache
@@ -1,5 +1,5 @@
 /**
- * {{{description}}}
+ * {{#lambda.indented_star_1}}{{{unescapedDescription}}}{{/lambda.indented_star_1}}
  * @export
  * @enum {string}
  */

diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache
@@ -19,7 +19,7 @@ import {
 
 {{/discriminator}}
 /**
- * {{{description}}}
+ * {{#lambda.indented_star_1}}{{{unescapedDescription}}}{{/lambda.indented_star_1}}
  * @export
  * @interface {{classname}}
  */
@@ -29,7 +29,7 @@ export interface {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{
 {{/additionalPropertiesType}}
 {{#vars}}
     /**
-     * {{{description}}}
+     * {{#lambda.indented_star_4}}{{{unescapedDescription}}}{{/lambda.indented_star_4}}
      * @type {{=<% %>=}}{<%&datatype%>}<%={{ }}=%>
      * @memberof {{classname}}
      */

diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/modelOneOf.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/modelOneOf.mustache
@@ -11,8 +11,8 @@ import {
 
 {{/hasImports}}
 /**
- * @type {{classname}}{{#description}}
- * {{{description}}}{{/description}}
+ * @type {{classname}}
+ * {{#lambda.indented_star_1}}{{{unescapedDescription}}}{{/lambda.indented_star_1}}
  * @export
  */
 export type {{classname}} = {{#discriminator}}{{#mappedModels}}{ {{discriminator.propertyName}}: '{{mappingName}}' } & {{modelName}}{{^-last}} | {{/-last}}{{/mappedModels}}{{/discriminator}}{{^discriminator}}{{#oneOf}}{{{.}}}{{^-last}} | {{/-last}}{{/oneOf}}{{/discriminator}};

diff --git a/samples/client/petstore/typescript-fetch/builds/default/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/default/apis/PetApi.ts
@@ -61,7 +61,7 @@ export interface UploadFileRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/default/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/default/apis/StoreApi.ts
@@ -33,7 +33,7 @@ export interface PlaceOrderRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/default/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/default/apis/UserApi.ts
@@ -51,7 +51,7 @@ export interface UpdateUserRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/es6-target/src/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/es6-target/src/apis/PetApi.ts
@@ -61,7 +61,7 @@ export interface UploadFileRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/es6-target/src/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/es6-target/src/apis/StoreApi.ts
@@ -33,7 +33,7 @@ export interface PlaceOrderRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/es6-target/src/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/es6-target/src/apis/UserApi.ts
@@ -51,7 +51,7 @@ export interface UpdateUserRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/PetApi.ts
@@ -61,7 +61,7 @@ export interface UploadFileRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/StoreApi.ts
@@ -33,7 +33,7 @@ export interface PlaceOrderRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/multiple-parameters/apis/UserApi.ts
@@ -51,7 +51,7 @@ export interface UpdateUserRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI {
 

diff --git a/...es/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/apis/PetApi.ts b/...es/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/apis/PetApi.ts
@@ -61,7 +61,7 @@ export interface PetApiUploadFileRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI {
 

diff --git a/.../client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/apis/StoreApi.ts b/.../client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/apis/StoreApi.ts
@@ -33,7 +33,7 @@ export interface StoreApiPlaceOrderRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI {
 

diff --git a/...s/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/apis/UserApi.ts b/...s/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/src/apis/UserApi.ts
@@ -51,7 +51,7 @@ export interface UserApiUpdateUserRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/apis/PetApi.ts
@@ -61,7 +61,7 @@ export interface UploadFileRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/apis/StoreApi.ts
@@ -33,7 +33,7 @@ export interface PlaceOrderRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/typescript-three-plus/src/apis/UserApi.ts
@@ -51,7 +51,7 @@ export interface UpdateUserRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/with-interfaces/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/with-interfaces/apis/PetApi.ts
@@ -62,6 +62,7 @@ export interface UploadFileRequest {
 
 /**
  * PetApi - interface
+ * 
  * @export
  * @interface PetApiInterface
  */
@@ -197,7 +198,7 @@ export interface PetApiInterface {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI implements PetApiInterface {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/with-interfaces/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/with-interfaces/apis/StoreApi.ts
@@ -34,6 +34,7 @@ export interface PlaceOrderRequest {
 
 /**
  * StoreApi - interface
+ * 
  * @export
  * @interface StoreApiInterface
  */
@@ -103,7 +104,7 @@ export interface StoreApiInterface {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI implements StoreApiInterface {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/with-interfaces/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/with-interfaces/apis/UserApi.ts
@@ -52,6 +52,7 @@ export interface UpdateUserRequest {
 
 /**
  * UserApi - interface
+ * 
  * @export
  * @interface UserApiInterface
  */
@@ -183,7 +184,7 @@ export interface UserApiInterface {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI implements UserApiInterface {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/with-npm-version/src/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/with-npm-version/src/apis/PetApi.ts
@@ -61,7 +61,7 @@ export interface UploadFileRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class PetApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/with-npm-version/src/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/with-npm-version/src/apis/StoreApi.ts
@@ -33,7 +33,7 @@ export interface PlaceOrderRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class StoreApi extends runtime.BaseAPI {
 

diff --git a/samples/client/petstore/typescript-fetch/builds/with-npm-version/src/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/with-npm-version/src/apis/UserApi.ts
@@ -51,7 +51,7 @@ export interface UpdateUserRequest {
 }
 
 /**
- * no description
+ * 
  */
 export class UserApi extends runtime.BaseAPI {