diff --git a/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts b/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts index 5bf3b67772c..55fcc48d044 100644 --- a/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts +++ b/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts @@ -80,6 +80,8 @@ export class AnalyticsReportListComponent implements OnInit { /** * Reload the component + * + * @param reportId report id */ reload(reportId?: number) { this.reset(); @@ -88,8 +90,11 @@ export class AnalyticsReportListComponent implements OnInit { /** * Get the report list + * + * @param appId application id + * @param reportId report id */ - getReportList(appId: number, reportId?: number) { + getReportList(appId: number, reportId?: number): void { this.analyticsService.getReportList(appId).subscribe( (res: ReportParametersModel[]) => { if (res && res.length === 0) { @@ -133,6 +138,8 @@ export class AnalyticsReportListComponent implements OnInit { /** * Check if the report list is empty + * + * @returns `true` if report list is empty, otherwise `false` */ isReportsEmpty(): boolean { return this.reports === undefined || (this.reports && this.reports.length === 0); @@ -141,7 +148,7 @@ export class AnalyticsReportListComponent implements OnInit { /** * Select the current report * - * @param report + * @param report report model */ selectReport(report: any) { this.currentReport = report; diff --git a/lib/insights/src/lib/analytics-process/services/analytics.service.ts b/lib/insights/src/lib/analytics-process/services/analytics.service.ts index 81c87a2e78e..22e444f9d60 100644 --- a/lib/insights/src/lib/analytics-process/services/analytics.service.ts +++ b/lib/insights/src/lib/analytics-process/services/analytics.service.ts @@ -51,6 +51,9 @@ export class AnalyticsService { /** * Retrieve all the Deployed app + * + * @param appId application id + * @returns list or report parameter models */ getReportList(appId: number): Observable { return from(this.reportApi.getReportList()) @@ -72,7 +75,8 @@ export class AnalyticsService { /** * Retrieve Report by name * - * @param reportName - string - The name of report + * @param reportName - The name of report + * @returns report model */ getReportByName(reportName: string): Observable { return from(this.reportApi.getReportList())