From 3f490ea7ee60eb13b9ee8b44494c290d8c39c3d5 Mon Sep 17 00:00:00 2001
From: Alexander Rashed <alexrashed@users.noreply.github.com>
Date: Fri, 14 Feb 2020 09:34:45 +0100
Subject: [PATCH] typescript-angular: single request parameter documentation
 (#5308)

* Feature: Add JSDoc to request parameter interface members

* Add petstore after generation changes
---
 .../typescript-angular/api.service.mustache          |  3 ++-
 .../single-request-parameter/api/pet.service.ts      | 12 ++++++++++++
 .../single-request-parameter/api/store.service.ts    |  3 +++
 .../single-request-parameter/api/user.service.ts     |  9 +++++++++
 4 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache b/modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache
index f42d1beef9c..a5053d4f2c8 100644
--- a/modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache
+++ b/modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache
@@ -44,7 +44,8 @@ import {
 {{#allParams.0}}
 export interface {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}RequestParams {
 {{#allParams}}
-    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{#isNullable}} | null{{/isNullable}};
+    {{#description}}/** {{description}} */
+    {{/description}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{#isNullable}} | null{{/isNullable}};
 {{/allParams}}
 }
 
diff --git a/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/pet.service.ts b/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/pet.service.ts
index ee9aa6a7313..e0052e27267 100644
--- a/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/pet.service.ts
+++ b/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/pet.service.ts
@@ -25,39 +25,51 @@ import { Configuration }                                     from '../configurat
 
 
 export interface AddPetRequestParams {
+    /** Pet object that needs to be added to the store */
     body: Pet;
 }
 
 export interface DeletePetRequestParams {
+    /** Pet id to delete */
     petId: number;
     apiKey?: string;
 }
 
 export interface FindPetsByStatusRequestParams {
+    /** Status values that need to be considered for filter */
     status: Array<'available' | 'pending' | 'sold'>;
 }
 
 export interface FindPetsByTagsRequestParams {
+    /** Tags to filter by */
     tags: Array<string>;
 }
 
 export interface GetPetByIdRequestParams {
+    /** ID of pet to return */
     petId: number;
 }
 
 export interface UpdatePetRequestParams {
+    /** Pet object that needs to be added to the store */
     body: Pet;
 }
 
 export interface UpdatePetWithFormRequestParams {
+    /** ID of pet that needs to be updated */
     petId: number;
+    /** Updated name of the pet */
     name?: string;
+    /** Updated status of the pet */
     status?: string;
 }
 
 export interface UploadFileRequestParams {
+    /** ID of pet to update */
     petId: number;
+    /** Additional data to pass to server */
     additionalMetadata?: string;
+    /** file to upload */
     file?: Blob;
 }
 
diff --git a/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/store.service.ts b/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/store.service.ts
index 6b2fbf75328..92a788754ab 100644
--- a/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/store.service.ts
+++ b/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/store.service.ts
@@ -24,14 +24,17 @@ import { Configuration }                                     from '../configurat
 
 
 export interface DeleteOrderRequestParams {
+    /** ID of the order that needs to be deleted */
     orderId: string;
 }
 
 export interface GetOrderByIdRequestParams {
+    /** ID of pet that needs to be fetched */
     orderId: number;
 }
 
 export interface PlaceOrderRequestParams {
+    /** order placed for purchasing the pet */
     body: Order;
 }
 
diff --git a/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/user.service.ts b/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/user.service.ts
index 57cc0634a03..69ce21a0d2d 100644
--- a/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/user.service.ts
+++ b/samples/client/petstore/typescript-angular-v8-provided-in-root/builds/single-request-parameter/api/user.service.ts
@@ -24,32 +24,41 @@ import { Configuration }                                     from '../configurat
 
 
 export interface CreateUserRequestParams {
+    /** Created user object */
     body: User;
 }
 
 export interface CreateUsersWithArrayInputRequestParams {
+    /** List of user object */
     body: Array<User>;
 }
 
 export interface CreateUsersWithListInputRequestParams {
+    /** List of user object */
     body: Array<User>;
 }
 
 export interface DeleteUserRequestParams {
+    /** The name that needs to be deleted */
     username: string;
 }
 
 export interface GetUserByNameRequestParams {
+    /** The name that needs to be fetched. Use user1 for testing. */
     username: string;
 }
 
 export interface LoginUserRequestParams {
+    /** The user name for login */
     username: string;
+    /** The password for login in clear text */
     password: string;
 }
 
 export interface UpdateUserRequestParams {
+    /** name that need to be deleted */
     username: string;
+    /** Updated user object */
     body: User;
 }