Skip to content

Commit 06d5fb1

Browse files
committed
add extended descriptions for default return values
1 parent a9244e0 commit 06d5fb1

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

github/billing.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,20 @@ type AdvancedSecurityCommittersBreakdown struct {
6565

6666
// UsageReportOptions specifies optional parameters for the enhanced billing platform usage report.
6767
type UsageReportOptions struct {
68-
// If specified, only return results for a single year. The value of year is an integer with four digits representing a year.
68+
//If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2025. Default value is the current year.
69+
6970
Year *int `url:"year,omitempty"`
7071

71-
// If specified, only return results for a single month. The value of month is an integer between 1 and 12.
72+
// If specified, only return results for a single month. The value of month is an integer between 1 and 12. If no year is specified the default year is used.
73+
7274
Month *int `url:"month,omitempty"`
7375

74-
// If specified, only return results for a single day. The value of day is an integer between 1 and 31.
76+
// If specified, only return results for a single day. The value of day is an integer between 1 and 31. If no year or month is specified, the default year and month are used.
77+
7578
Day *int `url:"day,omitempty"`
7679

77-
// If specified, only return results for a single hour. The value of hour is an integer between 0 and 23.
80+
// If specified, only return results for a single hour. The value of hour is an integer between 0 and 23. If no year, month, or day is specified, the default year, month, and day are used.
81+
7882
Hour *int `url:"hour,omitempty"`
7983
}
8084

0 commit comments

Comments
 (0)