Merge pull request #4795 from github/openapi-update-79668c74668ddcec7597e70322af06818b47e04c409146b729de0fc684f50287

Update OpenAPI 3.1 Descriptions

Author: becco

descriptions-next/api.github.com/api.github.com.2022-11-28.json

@@ -71069,6 +71069,60 @@
         }
       }
     },
+    "/users/{username}/settings/billing/usage": {
+      "get": {
+        "summary": "Get billing usage report for a user",
+        "description": "Gets a report of the total usage for a user.\n\n**Note:** This endpoint is only available to users with access to the enhanced billing platform.",
+        "tags": [
+          "billing"
+        ],
+        "operationId": "billing/get-github-billing-usage-report-user",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/username"
+          },
+          {
+            "$ref": "#/components/parameters/billing-usage-report-year"
+          },
+          {
+            "$ref": "#/components/parameters/billing-usage-report-month"
+          },
+          {
+            "$ref": "#/components/parameters/billing-usage-report-day"
+          },
+          {
+            "$ref": "#/components/parameters/billing-usage-report-hour"
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/billing_usage_report_user"
+          },
+          "400": {
+            "$ref": "#/components/responses/bad_request"
+          },
+          "403": {
+            "$ref": "#/components/responses/forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/internal_error"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "billing",
+          "subcategory": "enhanced-billing"
+        }
+      }
+    },
     "/users/{username}/social_accounts": {
       "get": {
         "summary": "List social accounts for a user",
@@ -128367,7 +128421,7 @@
         }
       },
       "secret-scanning-alert-resolution-comment": {
-        "description": "An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.",
+        "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.",
         "type": [
           "string",
           "null"
@@ -132408,6 +132462,70 @@
           "id"
         ]
       },
+      "billing-usage-report-user": {
+        "type": "object",
+        "properties": {
+          "usageItems": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "date": {
+                  "type": "string",
+                  "description": "Date of the usage line item."
+                },
+                "product": {
+                  "type": "string",
+                  "description": "Product name."
+                },
+                "sku": {
+                  "type": "string",
+                  "description": "SKU name."
+                },
+                "quantity": {
+                  "type": "integer",
+                  "description": "Quantity of the usage line item."
+                },
+                "unitType": {
+                  "type": "string",
+                  "description": "Unit type of the usage line item."
+                },
+                "pricePerUnit": {
+                  "type": "number",
+                  "description": "Price per unit of the usage line item."
+                },
+                "grossAmount": {
+                  "type": "number",
+                  "description": "Gross amount of the usage line item."
+                },
+                "discountAmount": {
+                  "type": "number",
+                  "description": "Discount amount of the usage line item."
+                },
+                "netAmount": {
+                  "type": "number",
+                  "description": "Net amount of the usage line item."
+                },
+                "repositoryName": {
+                  "type": "string",
+                  "description": "Name of the repository."
+                }
+              },
+              "required": [
+                "date",
+                "product",
+                "sku",
+                "quantity",
+                "unitType",
+                "pricePerUnit",
+                "grossAmount",
+                "discountAmount",
+                "netAmount"
+              ]
+            }
+          }
+        }
+      },
       "enterprise-webhooks": {
         "title": "Enterprise",
         "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"",
@@ -306592,6 +306710,24 @@
           }
         ]
       },
+      "billing-usage-report-user": {
+        "value": {
+          "usageItems": [
+            {
+              "date": "2023-08-01",
+              "product": "Actions",
+              "sku": "Actions Linux",
+              "quantity": 100,
+              "unitType": "minutes",
+              "pricePerUnit": 0.008,
+              "grossAmount": 0.8,
+              "discountAmount": 0,
+              "netAmount": 0.8,
+              "repositoryName": "user/example"
+            }
+          ]
+        }
+      },
       "check-run-completed": {
         "value": {
           "action": "completed",
@@ -310389,6 +310525,21 @@
             }
           }
         }
+      },
+      "billing_usage_report_user": {
+        "description": "Response when getting a billing usage report",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/billing-usage-report-user"
+            },
+            "examples": {
+              "default": {
+                "$ref": "#/components/examples/billing-usage-report-user"
+              }
+            }
+          }
+        }
       }
     },
     "headers": {