Skip to content

Commit 8e02cc1

Browse files
vmasekvmasek
committed
fix(api-client): method parameters description and required flag
Signed-off-by: Vojtech Mašek <[email protected]>
1 parent 2f5b665 commit 8e02cc1

File tree

6 files changed

+423
-422
lines changed

6 files changed

+423
-422
lines changed

‎src/parser.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -366,11 +366,11 @@ function transformParameters(
366366
...param,
367367
...determineParamType('in' in paramRef ? paramRef.in : (param as Parameter).in),
368368

369-
description: replaceNewLines(param.description, ' '),
369+
description: replaceNewLines((param as Parameter).description || paramRef.description, ' '),
370370
camelCaseName: toCamelCase(name),
371371
importType: prefixImportedModels(typescriptType),
372372
isArray,
373-
isRequired: param.required,
373+
isRequired: (param as Parameter).isRequired || (param as Parameter).required || paramRef.required,
374374
name,
375375
typescriptType,
376376
};

‎src/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ export interface Property {
4646
readonly type?: string;
4747
readonly typescriptType?: TypescriptBasicTypes | string;
4848
readonly importType?: string;
49+
readonly required?: boolean;
4950
}
5051

5152
export interface Parameter extends Property {

‎tests/esquare/api/api-client.interface.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ export interface APIClientInterface {
7474
*/
7575
getReportsList(
7676
args: {
77-
status?: models.Status,
77+
status?: models.Status, // (optional) - 1 Pending - 2 InProgress - 3 Complete
7878
pageSize: number,
7979
page: number, // page number
8080
orderBy: string, // id | title | subtitle | criticality | status | issues | deadline
81-
order?: models.Order,
81+
order?: models.Order, // (optional) - asc - desc
8282
},
8383
requestHttpOptions?: HttpOptions
8484
): Observable<any>;
@@ -104,7 +104,7 @@ export interface APIClientInterface {
104104
pageSize: number,
105105
page: number, // page number
106106
orderBy?: number, // (optional) column id
107-
order?: models.Order,
107+
order?: models.Order, // (optional) - asc - desc
108108
},
109109
requestHttpOptions?: HttpOptions
110110
): Observable<any>;
@@ -252,7 +252,7 @@ export interface APIClientInterface {
252252
*/
253253
geImportStats(
254254
args: {
255-
period?: models.Period,
255+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
256256
},
257257
requestHttpOptions?: HttpOptions
258258
): Observable<models.TotalImportStats>;
@@ -263,12 +263,12 @@ export interface APIClientInterface {
263263
*/
264264
getIssuesList(
265265
args: {
266-
period?: models.Period,
267-
status?: models.IssueStatus,
266+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
267+
status?: models.IssueStatus, // (optional) - 1 Pending - 2 Resolved
268268
pageSize: number,
269269
page: number, // page number
270270
orderBy: string, // name | school | dueDate | alert
271-
order?: models.Order,
271+
order?: models.Order, // (optional) - asc - desc
272272
},
273273
requestHttpOptions?: HttpOptions
274274
): Observable<any>;
@@ -279,24 +279,24 @@ export interface APIClientInterface {
279279
*/
280280
getStatusesList(
281281
args: {
282-
period?: models.Period,
283-
status?: models.ImportStatus,
282+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
283+
status?: models.ImportStatus, // (optional) - 1 Live - 2 PastDeadline
284284
pageSize: number,
285285
page: number, // page number
286286
orderBy: string, // name | issues | dueDate | progress
287-
order?: models.Order,
287+
order?: models.Order, // (optional) - asc - desc
288288
},
289289
requestHttpOptions?: HttpOptions
290290
): Observable<any>;
291291

292292
getUsersList(
293293
args: {
294-
period?: models.Period,
295-
status?: models.ImportStatus,
294+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
295+
status?: models.ImportStatus, // (optional) - 1 Live - 2 PastDeadline
296296
pageSize: number,
297297
page: number, // page number
298298
orderBy: string, // name | issues | dueDate | progress
299-
order?: models.Order,
299+
order?: models.Order, // (optional) - asc - desc
300300
assignedToRole?: number, // (optional) role id | [Screenshot from design](http://prntscr.com/ib9yal)
301301
unassignedFromRole?: number, // (optional) role id | [Screenshot from design](http://prntscr.com/ib9z16)
302302
},
@@ -405,7 +405,7 @@ export interface APIClientInterface {
405405
pageSize: number,
406406
page: number, // page number
407407
orderBy: string, // name | description | priority | date
408-
order?: models.Order,
408+
order?: models.Order, // (optional) - asc - desc
409409
},
410410
requestHttpOptions?: HttpOptions
411411
): Observable<any>;
@@ -437,7 +437,7 @@ export interface APIClientInterface {
437437
pageSize: number,
438438
page: number, // page number
439439
orderBy: string, // name | description | priority | date
440-
order?: models.Order,
440+
order?: models.Order, // (optional) - asc - desc
441441
},
442442
requestHttpOptions?: HttpOptions
443443
): Observable<any>;

‎tests/esquare/api/api-client.service.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,11 @@ export class APIClient implements APIClientInterface {
159159
*/
160160
getReportsList(
161161
args: {
162-
status?: models.Status,
162+
status?: models.Status, // (optional) - 1 Pending - 2 InProgress - 3 Complete
163163
pageSize: number,
164164
page: number, // page number
165165
orderBy: string, // id | title | subtitle | criticality | status | issues | deadline
166-
order?: models.Order,
166+
order?: models.Order, // (optional) - asc - desc
167167
},
168168
requestHttpOptions?: HttpOptions
169169
): Observable<any> {
@@ -214,7 +214,7 @@ export class APIClient implements APIClientInterface {
214214
pageSize: number,
215215
page: number, // page number
216216
orderBy?: number, // (optional) column id
217-
order?: models.Order,
217+
order?: models.Order, // (optional) - asc - desc
218218
},
219219
requestHttpOptions?: HttpOptions
220220
): Observable<any> {
@@ -442,7 +442,7 @@ export class APIClient implements APIClientInterface {
442442
*/
443443
geImportStats(
444444
args: {
445-
period?: models.Period,
445+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
446446
},
447447
requestHttpOptions?: HttpOptions
448448
): Observable<models.TotalImportStats> {
@@ -461,12 +461,12 @@ export class APIClient implements APIClientInterface {
461461
*/
462462
getIssuesList(
463463
args: {
464-
period?: models.Period,
465-
status?: models.IssueStatus,
464+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
465+
status?: models.IssueStatus, // (optional) - 1 Pending - 2 Resolved
466466
pageSize: number,
467467
page: number, // page number
468468
orderBy: string, // name | school | dueDate | alert
469-
order?: models.Order,
469+
order?: models.Order, // (optional) - asc - desc
470470
},
471471
requestHttpOptions?: HttpOptions
472472
): Observable<any> {
@@ -500,12 +500,12 @@ export class APIClient implements APIClientInterface {
500500
*/
501501
getStatusesList(
502502
args: {
503-
period?: models.Period,
504-
status?: models.ImportStatus,
503+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
504+
status?: models.ImportStatus, // (optional) - 1 Live - 2 PastDeadline
505505
pageSize: number,
506506
page: number, // page number
507507
orderBy: string, // name | issues | dueDate | progress
508-
order?: models.Order,
508+
order?: models.Order, // (optional) - asc - desc
509509
},
510510
requestHttpOptions?: HttpOptions
511511
): Observable<any> {
@@ -535,12 +535,12 @@ export class APIClient implements APIClientInterface {
535535

536536
getUsersList(
537537
args: {
538-
period?: models.Period,
539-
status?: models.ImportStatus,
538+
period?: models.Period, // (optional) - 1 Year - 2 Month - 3 Week
539+
status?: models.ImportStatus, // (optional) - 1 Live - 2 PastDeadline
540540
pageSize: number,
541541
page: number, // page number
542542
orderBy: string, // name | issues | dueDate | progress
543-
order?: models.Order,
543+
order?: models.Order, // (optional) - asc - desc
544544
assignedToRole?: number, // (optional) role id | [Screenshot from design](http://prntscr.com/ib9yal)
545545
unassignedFromRole?: number, // (optional) role id | [Screenshot from design](http://prntscr.com/ib9z16)
546546
},
@@ -743,7 +743,7 @@ export class APIClient implements APIClientInterface {
743743
pageSize: number,
744744
page: number, // page number
745745
orderBy: string, // name | description | priority | date
746-
order?: models.Order,
746+
order?: models.Order, // (optional) - asc - desc
747747
},
748748
requestHttpOptions?: HttpOptions
749749
): Observable<any> {
@@ -802,7 +802,7 @@ export class APIClient implements APIClientInterface {
802802
pageSize: number,
803803
page: number, // page number
804804
orderBy: string, // name | description | priority | date
805-
order?: models.Order,
805+
order?: models.Order, // (optional) - asc - desc
806806
},
807807
requestHttpOptions?: HttpOptions
808808
): Observable<any> {

0 commit comments

Comments
 (0)