Merge pull request #5277 from github/openapi-update-9a7c6c300b875098c8db26b40f3ac9fef3b1d6548ff9b76a9b335139e2d1b08a

Update OpenAPI 3.1 Descriptions

Author: dinonuggies1

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

@@ -15259,7 +15259,7 @@
     "/orgs/{org}/copilot/metrics": {
       "get": {
         "summary": "Get Copilot metrics for an organization",
-        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
+        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
         "tags": [
           "copilot"
         ],
@@ -15274,7 +15274,7 @@
           },
           {
             "name": "since",
-            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.",
+            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.",
             "in": "query",
             "required": false,
             "schema": {
@@ -15295,11 +15295,11 @@
           },
           {
             "name": "per_page",
-            "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+            "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
             "in": "query",
             "schema": {
               "type": "integer",
-              "default": 28
+              "default": 100
             }
           }
         ],
@@ -23470,7 +23470,7 @@
     "/orgs/{org}/secret-scanning/pattern-configurations": {
       "get": {
         "summary": "List organization pattern configurations",
-        "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.",
+        "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.",
         "tags": [
           "secret-scanning"
         ],
@@ -24385,7 +24385,7 @@
     "/orgs/{org}/team/{team_slug}/copilot/metrics": {
       "get": {
         "summary": "Get Copilot metrics for a team",
-        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
+        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
         "tags": [
           "copilot"
         ],
@@ -24403,7 +24403,7 @@
           },
           {
             "name": "since",
-            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.",
+            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.",
             "in": "query",
             "required": false,
             "schema": {
@@ -24424,11 +24424,11 @@
           },
           {
             "name": "per_page",
-            "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+            "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
             "in": "query",
             "schema": {
               "type": "integer",
-              "default": 28
+              "default": 100
             }
           }
         ],

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

@@ -11160,7 +11160,7 @@ paths:
         > [!NOTE]
         > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.
 
-        The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
+        The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,
         and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
         they must have telemetry enabled in their IDE.
 
@@ -11179,7 +11179,7 @@ paths:
       - name: since
         description: Show usage metrics since this date. This is a timestamp in [ISO
           8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`).
-          Maximum value is 28 days ago.
+          Maximum value is 100 days ago.
         in: query
         required: false
         schema:
@@ -11194,12 +11194,12 @@ paths:
           type: string
       - "$ref": "#/components/parameters/page"
       - name: per_page
-        description: The number of days of metrics to display per page (max 28). For
-          more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+        description: The number of days of metrics to display per page (max 100).
+          For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
         in: query
         schema:
           type: integer
-          default: 28
+          default: 100
       responses:
         '200':
           description: Response
@@ -17032,7 +17032,7 @@ paths:
       description: |-
         Lists the secret scanning pattern configurations for an organization.
 
-        Personal access tokens (classic) need the `write:org` scope to use this endpoint.
+        Personal access tokens (classic) need the `read:org` scope to use this endpoint.
       tags:
       - secret-scanning
       operationId: secret-scanning/list-org-pattern-configs
@@ -17688,7 +17688,7 @@ paths:
         > [!NOTE]
         > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.
 
-        The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
+        The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,
         and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
         they must have telemetry enabled in their IDE.
 
@@ -17708,7 +17708,7 @@ paths:
       - name: since
         description: Show usage metrics since this date. This is a timestamp in [ISO
           8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`).
-          Maximum value is 28 days ago.
+          Maximum value is 100 days ago.
         in: query
         required: false
         schema:
@@ -17723,12 +17723,12 @@ paths:
           type: string
       - "$ref": "#/components/parameters/page"
       - name: per_page
-        description: The number of days of metrics to display per page (max 28). For
-          more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+        description: The number of days of metrics to display per page (max 100).
+          For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
         in: query
         schema:
           type: integer
-          default: 28
+          default: 100
       responses:
         '200':
           description: Response

descriptions-next/api.github.com/api.github.com.json

@@ -15259,7 +15259,7 @@
     "/orgs/{org}/copilot/metrics": {
       "get": {
         "summary": "Get Copilot metrics for an organization",
-        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
+        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
         "tags": [
           "copilot"
         ],
@@ -15274,7 +15274,7 @@
           },
           {
             "name": "since",
-            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.",
+            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.",
             "in": "query",
             "required": false,
             "schema": {
@@ -15295,11 +15295,11 @@
           },
           {
             "name": "per_page",
-            "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+            "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
             "in": "query",
             "schema": {
               "type": "integer",
-              "default": 28
+              "default": 100
             }
           }
         ],
@@ -23470,7 +23470,7 @@
     "/orgs/{org}/secret-scanning/pattern-configurations": {
       "get": {
         "summary": "List organization pattern configurations",
-        "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.",
+        "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.",
         "tags": [
           "secret-scanning"
         ],
@@ -24385,7 +24385,7 @@
     "/orgs/{org}/team/{team_slug}/copilot/metrics": {
       "get": {
         "summary": "Get Copilot metrics for a team",
-        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
+        "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
         "tags": [
           "copilot"
         ],
@@ -24403,7 +24403,7 @@
           },
           {
             "name": "since",
-            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.",
+            "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.",
             "in": "query",
             "required": false,
             "schema": {
@@ -24424,11 +24424,11 @@
           },
           {
             "name": "per_page",
-            "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+            "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
             "in": "query",
             "schema": {
               "type": "integer",
-              "default": 28
+              "default": 100
             }
           }
         ],