Skip to content

Commit 78d2ea1

Browse files
committed
Add API doc description for chart endpoints
1 parent 14f559c commit 78d2ea1

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

app/Http/Controllers/Api/V1/ChartController.php

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
class ChartController extends Controller
1515
{
1616
/**
17+
* Get chart data for the weekly project overview.
18+
*
1719
* @throws AuthorizationException
1820
*
1921
* @operationId weeklyProjectOverview
@@ -31,6 +33,8 @@ public function weeklyProjectOverview(Organization $organization, DashboardServi
3133
}
3234

3335
/**
36+
* Get chart data for the latest tasks.
37+
*
3438
* @throws AuthorizationException
3539
*
3640
* @operationId latestTasks
@@ -48,6 +52,8 @@ public function latestTasks(Organization $organization, DashboardService $dashbo
4852
}
4953

5054
/**
55+
* Get chart data for the last seven days.
56+
*
5157
* @throws AuthorizationException
5258
*
5359
* @operationId lastSevenDays
@@ -65,6 +71,8 @@ public function lastSevenDays(Organization $organization, DashboardService $dash
6571
}
6672

6773
/**
74+
* Get chart data for the latest team activity.
75+
*
6876
* @throws AuthorizationException
6977
*
7078
* @operationId latestTeamActivity
@@ -81,6 +89,8 @@ public function latestTeamActivity(Organization $organization, DashboardService
8189
}
8290

8391
/**
92+
* Get chart data for daily tracked hours.
93+
*
8494
* @throws AuthorizationException
8595
*
8696
* @operationId dailyTrackedHours
@@ -98,6 +108,8 @@ public function dailyTrackedHours(Organization $organization, DashboardService $
98108
}
99109

100110
/**
111+
* Get chart data for total weekly time.
112+
*
101113
* @throws AuthorizationException
102114
*
103115
* @operationId totalWeeklyTime
@@ -115,6 +127,8 @@ public function totalWeeklyTime(Organization $organization, DashboardService $da
115127
}
116128

117129
/**
130+
* Get chart data for total weekly billable time.
131+
*
118132
* @throws AuthorizationException
119133
*
120134
* @operationId totalWeeklyBillableTime
@@ -132,6 +146,8 @@ public function totalWeeklyBillableTime(Organization $organization, DashboardSer
132146
}
133147

134148
/**
149+
* Get chart data for total weekly billable amount.
150+
*
135151
* @throws AuthorizationException
136152
*
137153
* @operationId totalWeeklyBillableAmount
@@ -154,6 +170,8 @@ public function totalWeeklyBillableAmount(Organization $organization, DashboardS
154170
}
155171

156172
/**
173+
* Get chart data for weekly history.
174+
*
157175
* @throws AuthorizationException
158176
*
159177
* @operationId weeklyHistory

0 commit comments

Comments
 (0)