Update OpenAPI 3.0 Descriptions

github · Jan 30, 2025 · 352a99e · 352a99e
1 parent e444488
commit 352a99e
Show file tree

Hide file tree

Showing 16 changed files with 96 additions and 72 deletions.
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json
@@ -297635,7 +297635,7 @@
       },
       "billing-usage-report-year": {
         "name": "year",
-        "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {
@@ -297644,7 +297644,7 @@
       },
       "billing-usage-report-month": {
         "name": "month",
-        "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {
@@ -297653,7 +297653,7 @@
       },
       "billing-usage-report-day": {
         "name": "day",
-        "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {
@@ -297662,7 +297662,7 @@
       },
       "billing-usage-report-hour": {
         "name": "hour",
-        "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {

diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -226078,31 +226078,34 @@ components:
       name: year
       description: If specified, only return results for a single year. The value
         of `year` is an integer with four digits representing a year. For example,
-        `2024`. Default value is the current year.
+        `2025`. Default value is the current year.
       in: query
       required: false
       schema:
         type: integer
     billing-usage-report-month:
       name: month
       description: If specified, only return results for a single month. The value
-        of `month` is an integer between `1` and `12`.
+        of `month` is an integer between `1` and `12`. If no year is specified the
+        default `year` is used.
       in: query
       required: false
       schema:
         type: integer
     billing-usage-report-day:
       name: day
       description: If specified, only return results for a single day. The value of
-        `day` is an integer between `1` and `31`.
+        `day` is an integer between `1` and `31`. If no `year` or `month` is specified,
+        the default `year` and `month` are used.
       in: query
       required: false
       schema:
         type: integer
     billing-usage-report-hour:
       name: hour
       description: If specified, only return results for a single hour. The value
-        of `hour` is an integer between `0` and `23`.
+        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.
       in: query
       required: false
       schema:

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -297635,7 +297635,7 @@
       },
       "billing-usage-report-year": {
         "name": "year",
-        "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {
@@ -297644,7 +297644,7 @@
       },
       "billing-usage-report-month": {
         "name": "month",
-        "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {
@@ -297653,7 +297653,7 @@
       },
       "billing-usage-report-day": {
         "name": "day",
-        "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {
@@ -297662,7 +297662,7 @@
       },
       "billing-usage-report-hour": {
         "name": "hour",
-        "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`.",
+        "description": "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.",
         "in": "query",
         "required": false,
         "schema": {