Update OpenAPI 3.0 Descriptions

1 files changed, 189 insertions, 302 deletions

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
index 0bfd4bb04..2bd322dd4 100644
--- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml
+++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -9791,81 +9791,6 @@ paths:
         enabledForGitHubApps: true
         category: copilot
         subcategory: copilot-metrics
-  "/orgs/{org}/copilot/usage":
-    get:
-      summary: Get a summary of Copilot usage for organization members
-      description: |-
-        > [!NOTE]
-        > This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
-
-        You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
-        across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
-        See the response schema tab for detailed metrics definitions.
-
-        The response contains metrics for up to 28 days prior. Usage 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.
-
-        Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.
-
-        OAuth 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
-      operationId: copilot/usage-metrics-for-org
-      externalDocs:
-        description: API method documentation
-        url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members
-      parameters:
-      - "$ref": "#/components/parameters/org"
-      - 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.
-        in: query
-        required: false
-        schema:
-          type: string
-      - name: until
-        description: Show usage metrics until this date. This is a timestamp in [ISO
-          8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`)
-          and should not preceed the `since` date if it is passed.
-        in: query
-        required: false
-        schema:
-          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)."
-        in: query
-        schema:
-          type: integer
-          default: 28
-      responses:
-        '200':
-          description: Response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  "$ref": "#/components/schemas/copilot-usage-metrics"
-              examples:
-                default:
-                  "$ref": "#/components/examples/copilot-usage-metrics-org"
-        '500':
-          "$ref": "#/components/responses/internal_error"
-        '401':
-          "$ref": "#/components/responses/requires_authentication"
-        '403':
-          "$ref": "#/components/responses/forbidden"
-        '404':
-          "$ref": "#/components/responses/not_found"
-      x-github:
-        githubCloudOnly: false
-        enabledForGitHubApps: true
-        category: copilot
-        subcategory: copilot-usage
   "/orgs/{org}/dependabot/alerts":
     get:
       summary: List Dependabot alerts for an organization
@@ -16205,85 +16130,6 @@ paths:
         enabledForGitHubApps: true
         category: copilot
         subcategory: copilot-metrics
-  "/orgs/{org}/team/{team_slug}/copilot/usage":
-    get:
-      summary: Get a summary of Copilot usage for a team
-      description: |-
-        > [!NOTE]
-        > This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
-
-        You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
-        for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
-        See the response schema tab for detailed metrics definitions.
-
-        The response contains metrics for up to 28 days prior. Usage 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.
-
-        > [!NOTE]
-        > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.
-
-        Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.
-
-        OAuth 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
-      operationId: copilot/usage-metrics-for-team
-      externalDocs:
-        description: API method documentation
-        url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team
-      parameters:
-      - "$ref": "#/components/parameters/org"
-      - "$ref": "#/components/parameters/team-slug"
-      - 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.
-        in: query
-        required: false
-        schema:
-          type: string
-      - name: until
-        description: Show usage metrics until this date. This is a timestamp in [ISO
-          8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`)
-          and should not preceed the `since` date if it is passed.
-        in: query
-        required: false
-        schema:
-          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)."
-        in: query
-        schema:
-          type: integer
-          default: 28
-      responses:
-        '200':
-          description: Response
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  "$ref": "#/components/schemas/copilot-usage-metrics"
-              examples:
-                default:
-                  "$ref": "#/components/examples/copilot-usage-metrics-org"
-        '500':
-          "$ref": "#/components/responses/internal_error"
-        '401':
-          "$ref": "#/components/responses/requires_authentication"
-        '403':
-          "$ref": "#/components/responses/forbidden"
-        '404':
-          "$ref": "#/components/responses/not_found"
-      x-github:
-        githubCloudOnly: false
-        enabledForGitHubApps: true
-        category: copilot
-        subcategory: copilot-usage
   "/orgs/{org}/teams":
     get:
       summary: List teams
@@ -28698,7 +28544,7 @@ paths:
     get:
       summary: List pull requests associated with a commit
       description: |-
-        Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
+        Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.
 
         To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.
       tags:
@@ -56978,6 +56824,72 @@ x-webhooks:
         - repository
         - organization
         - app
+  issues-typed:
+    post:
+      summary: |-
+        This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation.
+
+        For activity relating to a comment on an issue, use the `issue_comment` event.
+
+        To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
+      description: An issue type was added to an issue.
+      operationId: issues/typed
+      externalDocs:
+        url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
+      parameters:
+      - name: User-Agent
+        in: header
+        example: GitHub-Hookshot/123abc
+        schema:
+          type: string
+      - name: X-Github-Hook-Id
+        in: header
+        example: 12312312
+        schema:
+          type: string
+      - name: X-Github-Event
+        in: header
+        example: issues
+        schema:
+          type: string
+      - name: X-Github-Hook-Installation-Target-Id
+        in: header
+        example: 123123
+        schema:
+          type: string
+      - name: X-Github-Hook-Installation-Target-Type
+        in: header
+        example: repository
+        schema:
+          type: string
+      - name: X-GitHub-Delivery
+        in: header
+        example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
+        schema:
+          type: string
+      - name: X-Hub-Signature-256
+        in: header
+        example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
+        schema:
+          type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/webhook-issues-typed"
+      responses:
+        '200':
+          description: Return a 200 status to indicate that the data was received
+            successfully
+      x-github:
+        githubCloudOnly: false
+        category: webhooks
+        subcategory: issues
+        supported-webhook-types:
+        - repository
+        - organization
+        - app
   issues-unassigned:
     post:
       summary: |-
@@ -57244,6 +57156,72 @@ x-webhooks:
         - repository
         - organization
         - app
+  issues-untyped:
+    post:
+      summary: |-
+        This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation.
+
+        For activity relating to a comment on an issue, use the `issue_comment` event.
+
+        To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.
+      description: An issue type was removed from an issue.
+      operationId: issues/untyped
+      externalDocs:
+        url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
+      parameters:
+      - name: User-Agent
+        in: header
+        example: GitHub-Hookshot/123abc
+        schema:
+          type: string
+      - name: X-Github-Hook-Id
+        in: header
+        example: 12312312
+        schema:
+          type: string
+      - name: X-Github-Event
+        in: header
+        example: issues
+        schema:
+          type: string
+      - name: X-Github-Hook-Installation-Target-Id
+        in: header
+        example: 123123
+        schema:
+          type: string
+      - name: X-Github-Hook-Installation-Target-Type
+        in: header
+        example: repository
+        schema:
+          type: string
+      - name: X-GitHub-Delivery
+        in: header
+        example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
+        schema:
+          type: string
+      - name: X-Hub-Signature-256
+        in: header
+        example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
+        schema:
+          type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/webhook-issues-untyped"
+      responses:
+        '200':
+          description: Return a 200 status to indicate that the data was received
+            successfully
+      x-github:
+        githubCloudOnly: false
+        category: webhooks
+        subcategory: issues
+        supported-webhook-types:
+        - repository
+        - organization
+        - app
   label-created:
     post:
       summary: |-
@@ -76331,89 +76309,6 @@ components:
       required:
       - date
       additionalProperties: true
-    copilot-usage-metrics:
-      title: Copilot Usage Metrics
-      description: Summary of Copilot usage.
-      type: object
-      properties:
-        day:
-          type: string
-          format: date
-          description: The date for which the usage metrics are reported, in `YYYY-MM-DD`
-            format.
-        total_suggestions_count:
-          type: integer
-          description: The total number of Copilot code completion suggestions shown
-            to users.
-        total_acceptances_count:
-          type: integer
-          description: The total number of Copilot code completion suggestions accepted
-            by users.
-        total_lines_suggested:
-          type: integer
-          description: The total number of lines of code completions suggested by
-            Copilot.
-        total_lines_accepted:
-          type: integer
-          description: The total number of lines of code completions accepted by users.
-        total_active_users:
-          type: integer
-          description: The total number of users who were shown Copilot code completion
-            suggestions during the day specified.
-        total_chat_acceptances:
-          type: integer
-          description: The total instances of users who accepted code suggested by
-            Copilot Chat in the IDE (panel and inline).
-        total_chat_turns:
-          type: integer
-          description: The total number of chat turns (prompt and response pairs)
-            sent between users and Copilot Chat in the IDE.
-        total_active_chat_users:
-          type: integer
-          description: The total number of users who interacted with Copilot Chat
-            in the IDE during the day specified.
-        breakdown:
-          type: array
-          description: Breakdown of Copilot code completions usage by language and
-            editor
-          nullable: true
-          items:
-            type: object
-            description: Breakdown of Copilot usage by editor for this language
-            additionalProperties: true
-            properties:
-              language:
-                type: string
-                description: The language in which Copilot suggestions were shown
-                  to users in the specified editor.
-              editor:
-                type: string
-                description: The editor in which Copilot suggestions were shown to
-                  users for the specified language.
-              suggestions_count:
-                type: integer
-                description: The number of Copilot suggestions shown to users in the
-                  editor specified during the day specified.
-              acceptances_count:
-                type: integer
-                description: The number of Copilot suggestions accepted by users in
-                  the editor specified during the day specified.
-              lines_suggested:
-                type: integer
-                description: The number of lines of code suggested by Copilot in the
-                  editor specified during the day specified.
-              lines_accepted:
-                type: integer
-                description: The number of lines of code accepted by users in the
-                  editor specified during the day specified.
-              active_users:
-                type: integer
-                description: The number of users who were shown Copilot completion
-                  suggestions in the editor specified during the day specified.
-      required:
-      - day
-      - breakdown
-      additionalProperties: false
     organization-dependabot-secret:
       title: Dependabot Secret for an Organization
       description: Secrets for GitHub Dependabot for an organization.
@@ -130690,6 +130585,34 @@ components:
       - issue
       - repository
       - sender
+    webhook-issues-typed:
+      title: issues typed event
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - typed
+        enterprise:
+          "$ref": "#/components/schemas/enterprise-webhooks"
+        installation:
+          "$ref": "#/components/schemas/simple-installation"
+        issue:
+          "$ref": "#/components/schemas/webhooks_issue"
+        type:
+          "$ref": "#/components/schemas/issue-type"
+        organization:
+          "$ref": "#/components/schemas/organization-simple-webhooks"
+        repository:
+          "$ref": "#/components/schemas/repository-webhooks"
+        sender:
+          "$ref": "#/components/schemas/simple-user"
+      required:
+      - action
+      - issue
+      - type
+      - repository
+      - sender
     webhook-issues-unassigned:
       title: issues unassigned event
       type: object
@@ -131709,6 +131632,34 @@ components:
       - issue
       - repository
       - sender
+    webhook-issues-untyped:
+      title: issues untyped event
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - untyped
+        enterprise:
+          "$ref": "#/components/schemas/enterprise-webhooks"
+        installation:
+          "$ref": "#/components/schemas/simple-installation"
+        issue:
+          "$ref": "#/components/schemas/webhooks_issue"
+        type:
+          "$ref": "#/components/schemas/issue-type"
+        organization:
+          "$ref": "#/components/schemas/organization-simple-webhooks"
+        repository:
+          "$ref": "#/components/schemas/repository-webhooks"
+        sender:
+          "$ref": "#/components/schemas/simple-user"
+      required:
+      - action
+      - issue
+      - type
+      - repository
+      - sender
     webhook-label-created:
       title: label created event
       type: object
@@ -206270,70 +206221,6 @@ components:
               custom_model_training_date: '2024-02-01'
               total_pr_summaries_created: 10
               total_engaged_users: 4
-    copilot-usage-metrics-org:
-      value:
-      - day: '2023-10-15'
-        total_suggestions_count: 1000
-        total_acceptances_count: 800
-        total_lines_suggested: 1800
-        total_lines_accepted: 1200
-        total_active_users: 10
-        total_chat_acceptances: 32
-        total_chat_turns: 200
-        total_active_chat_users: 4
-        breakdown:
-        - language: python
-          editor: vscode
-          suggestions_count: 300
-          acceptances_count: 250
-          lines_suggested: 900
-          lines_accepted: 700
-          active_users: 5
-        - language: python
-          editor: jetbrains
-          suggestions_count: 300
-          acceptances_count: 200
-          lines_suggested: 400
-          lines_accepted: 300
-          active_users: 2
-        - language: ruby
-          editor: vscode
-          suggestions_count: 400
-          acceptances_count: 350
-          lines_suggested: 500
-          lines_accepted: 200
-          active_users: 3
-      - day: '2023-10-16'
-        total_suggestions_count: 800
-        total_acceptances_count: 600
-        total_lines_suggested: 1100
-        total_lines_accepted: 700
-        total_active_users: 12
-        total_chat_acceptances: 57
-        total_chat_turns: 426
-        total_active_chat_users: 8
-        breakdown:
-        - language: python
-          editor: vscode
-          suggestions_count: 300
-          acceptances_count: 200
-          lines_suggested: 600
-          lines_accepted: 300
-          active_users: 2
-        - language: python
-          editor: jetbrains
-          suggestions_count: 300
-          acceptances_count: 150
-          lines_suggested: 300
-          lines_accepted: 250
-          active_users: 6
-        - language: ruby
-          editor: vscode
-          suggestions_count: 200
-          acceptances_count: 150
-          lines_suggested: 200
-          lines_accepted: 150
-          active_users: 3
     organization-dependabot-secret-paginated:
       value:
         total_count: 3