diff --git a/content/codespaces/reference/using-github-copilot-in-github-codespaces.md b/content/codespaces/reference/using-github-copilot-in-github-codespaces.md index e2117e0a4488..170369f94fdc 100644 --- a/content/codespaces/reference/using-github-copilot-in-github-codespaces.md +++ b/content/codespaces/reference/using-github-copilot-in-github-codespaces.md @@ -24,4 +24,4 @@ To include {% data variables.product.prodname_copilot %}, or other extensions, i ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot?tool=vscode) +* [AUTOTITLE](/copilot/quickstart) diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index b387cf163b99..601dd4ce6eda 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -140,7 +140,7 @@ If a button encourages people to navigate away from the {% data variables.produc ## Call to action (CTA) buttons -CTA buttons emphasize a link that we expect or encourage people to navigate to after reading an article or as part of completing the task that an article describes. CTAs should only take people to {% data variables.product.company_short %}-owned domains. For example, the "Try {% data variables.product.prodname_copilot %}" CTA in [AUTOTITLE](/free-pro-team@latest/copilot/using-github-copilot/getting-started-with-github-copilot) links to the [GitHub Copilot settings menu](https://github.com/settings/copilot) on {% data variables.product.prodname_dotcom_the_website %}. +CTA buttons emphasize a link that we expect or encourage people to navigate to after reading an article or as part of completing the task that an article describes. CTAs should only take people to {% data variables.product.company_short %}-owned domains. For example, the CTA button on [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) links to [an enterprise sales page](https://github.com/account/enterprises/new?ref_cta=GHEC+trial&ref_loc=setting+up+a+trial+of+github+enterprise+cloud&ref_page=docs) on {% data variables.product.prodname_dotcom_the_website %}. Only include a CTA button if navigating to the link supports user needs. Do not use CTA buttons solely for marketing GitHub features or products. In the above example, someone who wants to try {% data variables.product.prodname_copilot %} must navigate to the {% data variables.product.prodname_copilot_short %} settings menu and would likely want to after reading the article. In contrast, even though someone might use {% data variables.product.prodname_copilot_short %} as part of writing code that they then create a pull request for, we would not add a "Try {% data variables.product.prodname_copilot %}" CTA to [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) since {% data variables.product.prodname_copilot_short %} is not connected to the user needs of "Creating a pull request." Most people will create pull requests without using {% data variables.product.prodname_copilot_short %}. But people visiting articles about getting started with {% data variables.product.prodname_copilot_short %} are probably interested in trying {% data variables.product.prodname_copilot_short %} if they are not already using it. So we add the CTA button to help people get where they are trying to go. diff --git a/content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md b/content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md index 69b7ea3db638..8160e6fdcee8 100644 --- a/content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md +++ b/content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md @@ -17,6 +17,7 @@ redirect_from: - /copilot/github-copilot-enterprise/managing-copilot-knowledge-bases - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-copilot-knowledge-bases + - /copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management --- {% ifversion fpt %} diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md b/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md index d7b716d95fc0..08b34f8bafe9 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md +++ b/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md @@ -22,7 +22,7 @@ If you use a JetBrains IDE, {% data variables.product.prodname_copilot %} can he ## Prerequisites -To configure {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot?tool=jetbrains). +To configure {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=jetbrains). ## Using or rebinding keyboard shortcuts for {% data variables.product.prodname_copilot %} @@ -200,7 +200,7 @@ If you use {% data variables.product.prodname_vs %}, {% data variables.product.p ## Prerequisites -To configure {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot?tool=visualstudio). +To configure {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=visualstudio). ## Using or rebinding keyboard shortcuts for {% data variables.product.prodname_copilot %} diff --git a/content/copilot/quickstart.md b/content/copilot/quickstart.md index ad4ab0170f26..7726ba2243dc 100644 --- a/content/copilot/quickstart.md +++ b/content/copilot/quickstart.md @@ -4,6 +4,17 @@ intro: 'Quickly learn how to use {% data variables.product.prodname_copilot %}.' allowTitleToDifferFromFilename: true versions: feature: copilot +redirect_from: + - /copilot/getting-started-with-github-copilot + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio + - /copilot/using-github-copilot/getting-started-with-github-copilot shortTitle: Quickstart topics: - Copilot diff --git a/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github.md b/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github.md index ab29ef71903b..9f9301e25c44 100644 --- a/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github.md +++ b/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github.md @@ -8,10 +8,6 @@ topics: - Copilot type: rai redirect_from: - - /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat - - /copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management - - /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat-in-githubcom - - /copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom - /copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-githubcom --- diff --git a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md b/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md index a7a7e8cb8f16..7e1fafd685c6 100644 --- a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md +++ b/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md @@ -8,7 +8,9 @@ topics: - Copilot redirect_from: - /copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom + - /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat-in-githubcom - /copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom + - /copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom - /copilot/github-copilot-chat/copilot-chat-in-github - /copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom - /copilot/using-github-copilot/asking-github-copilot-questions-in-github diff --git a/content/copilot/using-github-copilot/copilot-chat/index.md b/content/copilot/using-github-copilot/copilot-chat/index.md index 209aa5231593..427fa326504f 100644 --- a/content/copilot/using-github-copilot/copilot-chat/index.md +++ b/content/copilot/using-github-copilot/copilot-chat/index.md @@ -5,6 +5,8 @@ versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat children: - /asking-github-copilot-questions-in-your-ide - /asking-github-copilot-questions-in-github diff --git a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md b/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md index ef19c96e8a77..44e5983623b2 100644 --- a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md +++ b/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md @@ -1,7 +1,7 @@ --- title: Finding public code that matches GitHub Copilot suggestions shortTitle: Find matching code -intro: 'If you allow {% data variables.product.prodname_copilot %} to make suggestions that match publicly available code, {% data variables.product.prodname_copilot_short %} will display references to any matching code that is found.' +intro: 'If you allow {% data variables.product.prodname_copilot %} to make suggestions that match publicly available code, {% data variables.product.prodname_copilot_short %} will display references to any similar code that is found.' defaultTool: vscode redirect_from: - /early-access/copilot/code-referencing-in-github-copilot @@ -30,9 +30,15 @@ This version of this article is for {% data variables.product.prodname_copilot_s {% endwebui %} +{% visualstudio %} + +This version of this article is for {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vs %}. For {% data variables.product.prodname_copilot_short %} on other platforms, click the appropriate tab above. + +{% endvisualstudio %} + ## Limitations -References to matching code are currently only available in JetBrains IDEs, {% data variables.product.prodname_vscode %}, and on the {% data variables.product.github %} website. +References to matching code are currently available in JetBrains IDEs, {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, and on the {% data variables.product.github %} website. ## Prerequisites @@ -58,14 +64,18 @@ If you've allowed suggestions that match public code, then whenever a response f {% endwebui %} +{% visualstudio %} + +{% data reusables.copilot.about-code-referencing %} + +{% endvisualstudio %} + This feature is called code referencing. {% jetbrains %} ### Code referencing for {% data variables.product.prodname_copilot_short %} code completion -When you accept a code completion suggestion that matches code in a public {% data variables.product.prodname_dotcom %} repository, an entry is added to the JetBrains log. The log entry includes the URLs of files containing matching code, and the name of the license that applies to that code, if any was found. This allows you to review these references and decide how to proceed. For example, you can decide what attribution to use, or whether you want to remove this code from your project. - {% data reusables.copilot.code-referencing-note %} ### Code referencing for {% data variables.product.prodname_copilot_chat_short %} @@ -85,10 +95,6 @@ When you accept a code completion suggestion that matches code in a public {% da ### Code referencing for {% data variables.product.prodname_copilot_short %} code completion -When you accept a code completion suggestion that matches code in a public {% data variables.product.prodname_dotcom %} repository, an entry is added to a {% data variables.product.prodname_copilot %} log. The log entry includes a link to a page on {% data variables.product.prodname_dotcom_the_website %} where you can view references to similar code in public {% data variables.product.prodname_dotcom %} repositories. - -The linked web page includes details of any license identified for the repository where the matching code was found. Having reviewed the references, you can decide how to proceed. For example, you can decide what attribution to use, or whether you want to remove this code from your project. - {% data reusables.copilot.code-referencing-note %} ### Code referencing for {% data variables.product.prodname_copilot_chat_short %} @@ -97,6 +103,18 @@ The linked web page includes details of any license identified for the repositor {% endvscode %} +{% visualstudio %} + +### Code referencing for {% data variables.product.prodname_copilot_short %} code completion + +{% data reusables.copilot.code-referencing-note %} + +### Code referencing for {% data variables.product.prodname_copilot_chat_short %} + +When {% data variables.product.prodname_copilot_chat_short %} provides a response that includes code that matches code in a public {% data variables.product.github %} repository, this is indicated below the suggested code, with a link to display details of the matched code in the output log. + +{% endvisualstudio %} + ### How code referencing finds matching code {% data variables.product.prodname_copilot_short %} code referencing searches for matches by taking the code suggestion, plus some of the code that will surround the suggestion if it is accepted, and comparing it against an index of all public repositories on {% data variables.product.prodname_dotcom_the_website %}. Code in private {% data variables.product.prodname_dotcom %} repositories, or code outside of {% data variables.product.prodname_dotcom %}, is not included in the search process. The search index is refreshed every few months. As a result, newly committed code, and code from public repositories deleted before the index was created, may not be included in the search. For the same reason, the search may return matches to code that has been deleted or moved since the index was created. @@ -125,7 +143,7 @@ You can view code references in the log file for your JetBrains IDE. The log entry includes the following details: * The date and time you accepted the suggestion. -* A "Public Code References" message telling you that matching code was found. +* A "Public Code References" message telling you that similar code was found. * The path to the file in which the suggestion was added. * The line and column number where the suggestion was added. * A list of matches, including: @@ -134,22 +152,7 @@ The log entry includes the following details: ### Verifying the code referencing functionality -You can verify that code referencing is working by prompting {% data variables.product.prodname_copilot_short %} to add some commonly used code and checking the output in the log file for your IDE. - -1. Display the log file for your JetBrains IDE, as described in the previous section. -1. Create a file called `fizz-buzz.js` and open it in the JetBrains editor. -1. In the editor, type: - - ```javascript - function fizzBuzz() - ``` - - With a space after the closing parenthesis. - - {% data variables.product.prodname_copilot %} should suggest code to complete the function. Typically the suggestion will be a common implementation of the fizz buzz algorithm that will match publicly available code on the {% data variables.product.github %} website. - -1. Accept the suggestion by pressing Tab. -1. Check whether a "[Public Code References]" entry has been added to the log file. +{% data reusables.copilot.code-referencing-verifying %} {% endjetbrains %} @@ -157,14 +160,11 @@ You can verify that code referencing is working by prompting {% data variables.p ## View code references for code completion -You can access code references from one of the {% data variables.product.prodname_copilot %} logs in {% data variables.product.prodname_vscode %}. +You can find code references in one of the {% data variables.product.prodname_copilot %} logs in {% data variables.product.prodname_vscode %}. 1. In {% data variables.product.prodname_vscode %}, open the **Output** window by selecting **View** > **Output** from the menu bar. -1. In the dropdown menu at the right of the **Output** window, select **{% data variables.product.prodname_copilot %} Log**. - - ![Screenshot of the Output window with "{% data variables.product.prodname_copilot %} Log" selected from the dropdown menu.](/assets/images/help/copilot/copilot-log-selected.png) - -1. Leave the **{% data variables.product.prodname_copilot %} Log** view displayed while you use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}. +1. In the dropdown menu at the right of the **Output** window, select **{% data variables.product.prodname_copilot %} Log (Code References)**. +1. Leave the **{% data variables.product.prodname_copilot %} Log (Code References)** view displayed while you use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}. When you accept a code completion suggestion that matches code in a public {% data variables.product.prodname_dotcom %} repository, an entry is added to the log. @@ -172,49 +172,56 @@ You can access code references from one of the {% data variables.product.prodnam * The date and time you accepted the suggestion. * The name of the file in which the suggestion was added. - * A message telling you that similar code was found, with the number and type of licenses. - * A link to a page on {% data variables.product.prodname_dotcom_the_website %}. - * The location in the file where the suggestion was added. - * A snippet of part of the code that was suggested and added. + * "Similar code at" followed by the location in the file where the suggestion was added. + * An extract of the code that was added by code completion. + * The license type for the matching code, if found, otherwise `unknown`. + * The URL of the file on {% data variables.product.prodname_dotcom_the_website %} where the similar code was found. - ![Screenshot of the Output window showing a code referencing log entry.](/assets/images/help/copilot/copilot-code-referencing-log.png) +### Example log entry - > [!NOTE] The {% data variables.product.prodname_copilot %} log is flushed when you close the editor. +```text +2025-03-27 12:17:54.759 [info] file:///Users/monalisa/fizzbuzz.js Similar code at [Ln 2, Col 8] let i = 1; i <= 100; i++) { let output = ''; if (i % 3 === 0) { output += 'Fizz';... +2025-03-27 12:17:54.759 [info] License: unknown, URL: https://github.com/octo-org/octo-repo/blob/8563f3b1d4f33952b22212b86e745539d1567ed1/examples/fizzBuzz.js +2025-03-27 12:17:54.759 [info] License: MIT, URL: https://github.com/octo-org/monalisa/blob/7e974691f4c8e6bc55f9b50688f05d746d1bc52b/exercises/2/fizz-buzz.js +``` -1. In the log entry, Ctrl+click (Windows/Linux) or Command+click (Mac) the link to view the code references on {% data variables.product.prodname_dotcom_the_website %}. +### Verifying the code referencing functionality - The page lists the matches that were found, showing an excerpt from the relevant file. You can click on the file name to view the whole file. +{% data reusables.copilot.code-referencing-verifying %} - ![Screenshot of code references listed on {% data variables.product.prodname_dotcom_the_website %}.](/assets/images/help/copilot/code-references-webpage.png) +{% endvscode %} - Matches may be found in multiple repositories with different, sometimes conflicting, licenses. You can use the checkboxes on the left of the page to show only the matches associated with a particular license. +{% visualstudio %} - You should review all license information within a repository to verify that it applies to the matching code, as repositories may contain multiple licenses and these licenses are subject to human and non-human error. +## View code references for code completion - > [!NOTE] The web page displaying the full set of details will remain available for three months. +You can find code references in the {% data variables.product.prodname_copilot %} log in {% data variables.product.prodname_vs %}. -### Verifying the code referencing functionality +1. In the menu bar, click **View**. +1. In the dropdown menu, click **Output**. +1. In Output view, click the box to the right of "Show output from" and select **{% data variables.product.prodname_copilot %}**. +1. Leave the log displayed while you use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}. -You can verify that code referencing is working by prompting {% data variables.product.prodname_copilot_short %} to add some commonly used code and checking the output in the {% data variables.product.prodname_copilot_short %} log. + When you accept a code completion suggestion that matches code in a public {% data variables.product.prodname_dotcom %} repository, an entry is added to the log. -1. In {% data variables.product.prodname_vscode %}, create a file called `fizz-buzz.js`. -1. Open the **Output** window by selecting **View** > **Output** from the menu bar. -1. In the dropdown menu at the right of the **Output** window, select **{% data variables.product.prodname_copilot %} Log**. -1. In the editor, type: + The log entry includes the following details: - ```javascript - function fizzBuzz() - ``` + * The time you accepted the suggestion. Click the "Show Timestamp" clock icon if the time is not displayed. + * The description `[Completions Public Code Match Information]`. + * The license type for the matching code, if found, otherwise `NOASSERTION`. + * The URL of the file on {% data variables.product.prodname_dotcom_the_website %} where the similar code was found. - With a space after the closing parenthesis. +### Example log entry - {% data variables.product.prodname_copilot %} should suggest code to complete the function. Typically the suggestion will be a common implementation of the fizz buzz algorithm that will match publicly available code on the {% data variables.product.github %} website. +```text +09:39:16:203 [Completions Public Code Match Information] Similar code with license type [MIT] https://github.com/octo-org/octo-repo/blob/34deb75eb6a2e22483ed465a6aec38c02eb2536e/routines/quicksort.js +``` -1. Accept the suggestion by pressing Tab. +### Verifying the code referencing functionality - If code referencing finds a match to public code, a log entry is added to the **{% data variables.product.prodname_copilot %} Log** view. +{% data reusables.copilot.code-referencing-verifying %} -{% endvscode %} +{% endvisualstudio %} ## View code references for {% data variables.product.prodname_copilot_chat_short %} @@ -230,6 +237,52 @@ You can verify that code referencing is working by prompting {% data variables.p {% endvscode %} +{% visualstudio %} + +If a response in {% data variables.product.prodname_copilot_chat_short %} includes matching code, this is below the suggested code by the following text: + +> Found similar code in public repos. **View matches** + +Click **View matches** to open the {% data variables.product.prodname_copilot %} log, if it is not already open, and add details of the matched code. + +The details include: + +* The time you added the details to the log. Click the "Show Timestamp" clock icon if the time is not displayed. +* The description `[Code Match]` as the first log entry before the list of matching code. +* The license type—if found—for each instance of similar code. +* The URL of the file on {% data variables.product.prodname_dotcom_the_website %} where the matching code was found. +* A code snippet showing the matching code. + +### Logging example + +```text +09:24:10:525 [Code Match] Similar code with 2 license type(s) [MIT, NOASSERTION] +09:24:10:525 ## License: MIT +09:24:10:525 https://github.com/octo-org/octo-repo/tree/127aac4ab27a42706af01be80f7aae3b83f44fbc/buzzfizz.py +09:24:10:525 ``` +09:24:10:525 for i in range(1, n + 1): +09:24:10:525 if i % 3 == 0 and i % 5 == 0: +09:24:10:525 print('FizzBuzz') +09:24:10:525 elif i % 3 == 0: +09:24:10:525 print('Fizz') +09:24:10:525 elif i % 5 == 0: +09:24:10:525 ``` +09:24:10:525 ## License: NOASSERTION +09:24:10:525 https://github.com/octo-org/monalisa/tree/011308746e53b26b128fa53c044a2527c39231f0/fizz-buzz.py +09:24:10:525 ``` +09:24:10:525 i % 3 == 0 and i % 5 == 0: +09:24:10:525 print('FizzBuzz') +09:24:10:525 elif i % 3 == 0: +09:24:10:525 print('Fizz') +09:24:10:525 elif i % 5 == 0: +09:24:10:525 print('Buzz') +09:24:10:525 else: +09:24:10:525 print(i) +09:24:10:525 ``` +``` + +{% endvisualstudio %} + {% webui %} When {% data variables.product.prodname_copilot_chat_short %} provides a response that includes code that matches code in a public {% data variables.product.prodname_dotcom %} repository, this is indicated beneath the code suggestion: diff --git a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md b/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md index 6866ddc99d18..c7b555fc038b 100644 --- a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md +++ b/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md @@ -3,16 +3,6 @@ title: Getting code suggestions in your IDE with GitHub Copilot shortTitle: Get code suggestions intro: 'Use {% data variables.product.prodname_copilot %} to get code suggestions in your editor.' redirect_from: - - /copilot/getting-started-with-github-copilot - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio - - /copilot/using-github-copilot/getting-started-with-github-copilot - /copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor versions: feature: copilot diff --git a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md b/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md index 2ecbc668be29..d44049060cde 100644 --- a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md +++ b/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md @@ -18,7 +18,7 @@ redirect_from: {% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} -> [!NOTE] {% data variables.product.prodname_copilot_extensions %} are not the same as _the {% data variables.product.prodname_copilot %} extension_, which you install in your IDE to use default {% data variables.product.prodname_copilot_short %} functionality like code completions and {% data variables.product.prodname_copilot_chat %}. For more information on _the {% data variables.product.prodname_copilot %} extension_, see [AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot). +> [!NOTE] {% data variables.product.prodname_copilot_extensions %} are not the same as _the {% data variables.product.prodname_copilot %} extension_, which you install in your IDE to use default {% data variables.product.prodname_copilot_short %} functionality like code completions and {% data variables.product.prodname_copilot_chat %}. For more information on _the {% data variables.product.prodname_copilot %} extension_, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment). You can get started with {% data variables.product.prodname_copilot_extensions_short %} in one of two ways: * Build your own {% data variables.product.prodname_copilot_extension_short %}. See [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions). diff --git a/content/rest/copilot/copilot-metrics.md b/content/rest/copilot/copilot-metrics.md index d660a7f9a0a0..db797fa86298 100644 --- a/content/rest/copilot/copilot-metrics.md +++ b/content/rest/copilot/copilot-metrics.md @@ -9,6 +9,8 @@ topics: - API autogenerated: rest allowTitleToDifferFromFilename: true +redirect_from: + - /rest/copilot/copilot-usage --- You can use these endpoints to get a breakdown of aggregated metrics for various {% data variables.product.prodname_copilot %} features. The API includes: @@ -18,8 +20,6 @@ You can use these endpoints to get a breakdown of aggregated metrics for various * Breakdowns by language and IDE * The option to view metrics for an enterprise, organization, or team -If you currently use the [AUTOTITLE](/rest/copilot/copilot-usage), we recommend migrating to these endpoints as soon as possible. - For help getting started, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/analyzing-usage-over-time-with-the-copilot-metrics-api). {% data reusables.copilot.metrics-api-ghecom %} diff --git a/content/rest/copilot/copilot-usage.md b/content/rest/copilot/copilot-usage.md deleted file mode 100644 index f997ac6a4391..000000000000 --- a/content/rest/copilot/copilot-usage.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: REST API endpoints for GitHub Copilot usage metrics -shortTitle: Copilot usage -intro: 'Use the REST API to access {% data variables.product.prodname_copilot_short %} usage metrics for an enterprise, an organization, or a team.' -redirect_from: - - /early-access/copilot/copilot-usage-api -versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 - fpt: '*' - ghec: '*' -topics: - - API -autogenerated: rest -allowTitleToDifferFromFilename: true ---- - ->[!WARNING] These endpoints are retired. Use the [AUTOTITLE](/rest/copilot/copilot-metrics) endpoints instead. - diff --git a/content/rest/copilot/index.md b/content/rest/copilot/index.md index a704cb30b88f..7f393aec9a74 100644 --- a/content/rest/copilot/index.md +++ b/content/rest/copilot/index.md @@ -11,7 +11,6 @@ autogenerated: rest allowTitleToDifferFromFilename: true children: - /copilot-metrics - - /copilot-usage - /copilot-user-management versions: fpt: '*' diff --git a/data/reusables/copilot/code-referencing-note.md b/data/reusables/copilot/code-referencing-note.md index 42a9164f705d..227ddefed210 100644 --- a/data/reusables/copilot/code-referencing-note.md +++ b/data/reusables/copilot/code-referencing-note.md @@ -1,3 +1,5 @@ +When you accept a code completion suggestion that matches code in a public {% data variables.product.prodname_dotcom %} repository, information about the matching code is logged. The log entry includes the URLs of files containing matching code, and the name of the license that applies to that code, if any was found. This allows you to review these references and decide how to proceed. For example, you can decide what attribution to use, or whether you want to remove this code from your project. + > [!NOTE] > * Code referencing for code completion only occurs for matches of accepted {% data variables.product.prodname_copilot_short %} suggestions. Code you have written, and {% data variables.product.prodname_copilot_short %} suggestions you have altered, are not checked for matches to public code. > * Typically, matches to public code occur in less than one percent of {% data variables.product.prodname_copilot_short %} suggestions, so you should not expect to see code references for many suggestions. diff --git a/data/reusables/copilot/code-referencing-verifying.md b/data/reusables/copilot/code-referencing-verifying.md new file mode 100644 index 000000000000..b66b28aff224 --- /dev/null +++ b/data/reusables/copilot/code-referencing-verifying.md @@ -0,0 +1,16 @@ +You can verify that code referencing is working by prompting {% data variables.product.prodname_copilot_short %} to add some commonly used code and checking the output in the log. + +1. Create a file called `fizz-buzz.js` and open it in the editor. +1. Display the log as described in the previous section. +1. In the editor, type: + + ```javascript + function fizzBuzz() + ``` + + With a space after the closing parenthesis. + + {% data variables.product.prodname_copilot %} should suggest code to complete the function. Typically the suggestion will be a common implementation of the fizz buzz algorithm that will match publicly available code on the {% data variables.product.github %} website. + +1. To accept the suggestion, press Tab. +1. Check whether any entries for similar code have been added to the log. diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index b97cec120135..a309641fcc2c 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -486,15 +486,6 @@ "additional-permissions": true, "access": "read" }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "additional-permissions": true, - "access": "read" - }, { "category": "orgs", "slug": "list-app-installations-for-an-organization", @@ -684,15 +675,6 @@ "additional-permissions": true, "access": "read" }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "additional-permissions": true, - "access": "read" - }, { "category": "orgs", "slug": "enable-or-disable-a-security-feature-for-an-organization", @@ -921,15 +903,6 @@ "additional-permissions": true, "access": "read" }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "additional-permissions": true, - "access": "read" - }, { "category": "copilot", "slug": "get-copilot-seat-assignment-details-for-a-user", @@ -947,15 +920,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics", "additional-permissions": true, "access": "read" - }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "additional-permissions": true, - "access": "read" } ] }, @@ -2805,15 +2769,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -4065,15 +4020,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -5397,8 +5343,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index bb504258099f..31ff76d49ddc 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -2126,12 +2126,6 @@ "verb": "get", "requestPath": "/orgs/{org}/copilot/metrics" }, - { - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage" - }, { "slug": "get-copilot-seat-assignment-details-for-a-user", "subcategory": "copilot-user-management", @@ -2143,12 +2137,6 @@ "subcategory": "copilot-metrics", "verb": "get", "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" - }, - { - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage" } ], "dependabot": [ diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index f17d78e2c2ea..6d98177ec492 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -592,17 +592,6 @@ "server-to-server": true, "additional-permissions": true }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "orgs", "slug": "list-app-installations-for-an-organization", @@ -834,17 +823,6 @@ "server-to-server": true, "additional-permissions": true }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "orgs", "slug": "enable-or-disable-a-security-feature-for-an-organization", @@ -1117,17 +1095,6 @@ "server-to-server": true, "additional-permissions": true }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "copilot", "slug": "get-copilot-seat-assignment-details-for-a-user", @@ -1149,17 +1116,6 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true - }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true } ] }, @@ -3397,17 +3353,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -4933,17 +4878,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -6556,10 +6490,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 4a4d6dc3e0a8..36db2e6fe49e 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -1860,12 +1860,6 @@ "verb": "get", "requestPath": "/orgs/{org}/copilot/metrics" }, - { - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage" - }, { "slug": "get-copilot-seat-assignment-details-for-a-user", "subcategory": "copilot-user-management", @@ -1877,12 +1871,6 @@ "subcategory": "copilot-metrics", "verb": "get", "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" - }, - { - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage" } ], "dependabot": [ diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index bb504258099f..31ff76d49ddc 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -2126,12 +2126,6 @@ "verb": "get", "requestPath": "/orgs/{org}/copilot/metrics" }, - { - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage" - }, { "slug": "get-copilot-seat-assignment-details-for-a-user", "subcategory": "copilot-user-management", @@ -2143,12 +2137,6 @@ "subcategory": "copilot-metrics", "verb": "get", "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" - }, - { - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage" } ], "dependabot": [ diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 93fcfcd15514..dd002cd1beb6 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -582,15 +582,6 @@ "additional-permissions": true, "access": "read" }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "additional-permissions": true, - "access": "read" - }, { "category": "orgs", "slug": "list-saml-sso-authorizations-for-an-organization", @@ -852,15 +843,6 @@ "additional-permissions": true, "access": "read" }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "additional-permissions": true, - "access": "read" - }, { "category": "orgs", "slug": "enable-or-disable-a-security-feature-for-an-organization", @@ -1239,15 +1221,6 @@ "additional-permissions": true, "access": "read" }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "additional-permissions": true, - "access": "read" - }, { "category": "copilot", "slug": "get-copilot-seat-assignment-details-for-a-user", @@ -1265,15 +1238,6 @@ "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics", "additional-permissions": true, "access": "read" - }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "additional-permissions": true, - "access": "read" } ] }, @@ -3264,15 +3228,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -4524,15 +4479,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -5874,8 +5820,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index acc326470558..1d096c14ce36 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -2164,12 +2164,6 @@ "verb": "get", "requestPath": "/orgs/{org}/copilot/metrics" }, - { - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage" - }, { "slug": "get-copilot-seat-assignment-details-for-a-user", "subcategory": "copilot-user-management", @@ -2181,12 +2175,6 @@ "subcategory": "copilot-metrics", "verb": "get", "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" - }, - { - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage" } ], "dependabot": [ diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 23f2a2e267d9..e67ae20ab966 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -708,17 +708,6 @@ "server-to-server": true, "additional-permissions": true }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "orgs", "slug": "list-saml-sso-authorizations-for-an-organization", @@ -1038,17 +1027,6 @@ "server-to-server": true, "additional-permissions": true }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "orgs", "slug": "enable-or-disable-a-security-feature-for-an-organization", @@ -1503,17 +1481,6 @@ "server-to-server": true, "additional-permissions": true }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "copilot", "slug": "get-copilot-seat-assignment-details-for-a-user", @@ -1535,17 +1502,6 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true - }, - { - "category": "copilot", - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true } ] }, @@ -3954,17 +3910,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -5490,17 +5435,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -7135,10 +7069,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index b906e3c4ffc3..486345d64a79 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -1898,12 +1898,6 @@ "verb": "get", "requestPath": "/orgs/{org}/copilot/metrics" }, - { - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage" - }, { "slug": "get-copilot-seat-assignment-details-for-a-user", "subcategory": "copilot-user-management", @@ -1915,12 +1909,6 @@ "subcategory": "copilot-metrics", "verb": "get", "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" - }, - { - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage" } ], "dependabot": [ diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index acc326470558..1d096c14ce36 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -2164,12 +2164,6 @@ "verb": "get", "requestPath": "/orgs/{org}/copilot/metrics" }, - { - "slug": "get-a-summary-of-copilot-usage-for-organization-members", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage" - }, { "slug": "get-copilot-seat-assignment-details-for-a-user", "subcategory": "copilot-user-management", @@ -2181,12 +2175,6 @@ "subcategory": "copilot-metrics", "verb": "get", "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics" - }, - { - "slug": "get-a-summary-of-copilot-usage-for-a-team", - "subcategory": "copilot-usage", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage" } ], "dependabot": [ diff --git a/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat-permissions.json index 29265c602a36..39fdda9b49db 100644 --- a/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.12-2022-11-28/fine-grained-pat-permissions.json @@ -1911,15 +1911,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3003,15 +2994,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -3882,8 +3864,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-permissions.json index efa3a8c1d694..cfe667c03122 100644 --- a/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.12-2022-11-28/server-to-server-permissions.json @@ -2315,17 +2315,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3647,17 +3636,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -4723,10 +4701,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json index d7f30c729bd2..cbd2dfced2c1 100644 --- a/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json @@ -1980,15 +1980,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3072,15 +3063,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -3966,8 +3948,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json index cb9bc3f7e6dc..5b720d89c9e6 100644 --- a/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json @@ -2398,17 +2398,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3730,17 +3719,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -4823,10 +4801,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json index 118a52ac9dc0..0e9444f8f8c5 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json @@ -2112,15 +2112,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3204,15 +3195,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -4098,8 +4080,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json index 1663005937ed..26ef396a13cf 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json @@ -2558,17 +2558,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3890,17 +3879,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -4983,10 +4961,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json index 861748438de8..30f795917a6b 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json @@ -2202,15 +2202,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3303,15 +3294,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -4206,8 +4188,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json index 1b8419c191b8..f4886f41d3c9 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json @@ -2668,17 +2668,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -4011,17 +4000,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -5115,10 +5093,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json index 90113fe858b1..35c84880c07a 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json @@ -2262,15 +2262,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -3363,15 +3354,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" - }, { "category": "checks", "slug": "create-a-check-run", @@ -4266,8 +4248,8 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "additional-permissions": true, - "access": "read" + "additional-permissions": false, + "access": "write" }, { "category": "deployments", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json index 9ff2e94c7ffa..7541fe89a89e 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json @@ -2740,17 +2740,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "actions", "slug": "re-run-a-workflow", @@ -4083,17 +4072,6 @@ "title": "Checks", "displayTitle": "Repository permissions for \"Checks\"", "permissions": [ - { - "category": "actions", - "slug": "review-pending-deployments-for-a-workflow-run", - "subcategory": "workflow-runs", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "checks", "slug": "create-a-check-run", @@ -5187,10 +5165,10 @@ "subcategory": "workflow-runs", "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "access": "read", + "access": "write", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { "category": "deployments", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index c22464a8cc34..090a94f11f24 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "30dd46c371d8e335d32c414f972a800d811966b4" + "sha": "1827b0fbaf32b97302aa43ab28d04497d9990970" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index dc4e021cb41b..96d9acf4844b 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -35666,9 +35666,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -228922,7 +228920,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -237926,590 +237924,6 @@ ] } ], - "copilot-usage": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "title": "Get a summary of Copilot usage for organization members", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Show usage metrics since this date. This is a timestamp in 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 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "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.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "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 - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage 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

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "title": "Get a summary of Copilot usage for a team", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Show usage metrics since this date. This is a timestamp in 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 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "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.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "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 - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage 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

Note

\n

\nThis 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.

\n
\n

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.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ] - } - ], "copilot-user-management": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 95dccf72bfa9..b397590c4a64 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -44218,9 +44218,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -240257,7 +240255,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -250433,1158 +250431,6 @@ ] } ], - "copilot-usage": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/copilot/usage", - "title": "Get a summary of Copilot usage for enterprise members", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Show usage metrics since this date. This is a timestamp in 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 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "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.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "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 - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage 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

The time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.

\n

Only owners and billing managers can view Copilot usage metrics for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/usage", - "title": "Get a summary of Copilot usage for an enterprise team", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "enterprise", - "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Show usage metrics since this date. This is a timestamp in 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 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "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.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "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 - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage 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

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.

\n
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "title": "Get a summary of Copilot usage for organization members", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Show usage metrics since this date. This is a timestamp in 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 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "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.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "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 - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage 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

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage", - "title": "Get a summary of Copilot usage for a team", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "

The slug of the team name.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "

Show usage metrics since this date. This is a timestamp in 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 format (YYYY-MM-DDTHH:MM:SSZ) and should not preceed the since date if it is passed.

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "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.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "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", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "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 - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 28 days prior. Usage 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

Note

\n

\nThis 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.

\n
\n

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.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "500", - "description": "

Internal Error

" - } - ] - } - ], "copilot-user-management": [ { "serverUrl": "https://api.github.com", @@ -590689,12 +589535,20 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "userName": "octocat", - "name": "Monalisa Octocat", + "userName": "mona.octocat@okta.example.com", + "externalId": "a7d0f98382", + "name": { + "givenName": "Monalisa", + "familyName": "Octocat", + "formatted": "Monalisa Octocat" + }, "emails": [ { - "value": "mona.octocat@github.com", + "value": "mona.octocat@okta.example.com", "primary": true + }, + { + "value": "monalisa@octocat.github.com" } ] }, @@ -591502,11 +590356,16 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "userName": "octocat", - "name": "Monalisa Octocat", + "userName": "mona.octocat@okta.example.com", + "externalId": "a7d0f98382", + "name": { + "givenName": "Monalisa", + "familyName": "Octocat", + "formatted": "Monalisa Octocat" + }, "emails": [ { - "value": "mona.octocat@github.com", + "value": "mona.octocat@okta.example.com", "primary": true } ] diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index f4a0b7ba6912..510fc792ad64 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -39245,9 +39245,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -171396,7 +171394,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 2b1a024a559c..c9d1866705b5 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -39245,9 +39245,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -171540,7 +171538,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index e18f18b516f7..2b0b57b587b7 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -39245,9 +39245,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -171540,7 +171538,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 7a0357eabbc3..f7510449fa9e 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -39353,9 +39353,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -175703,7 +175701,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index b09c5e5ca4ab..73e92806c696 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -39353,9 +39353,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Actions\" repository permissions": "read", - "\"Checks\" repository permissions": "read", - "\"Deployments\" repository permissions": "read" + "\"Deployments\" repository permissions": "write" } ] }, @@ -179353,7 +179351,7 @@ } ], "previews": [], - "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", + "descriptionHTML": "

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.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 0a99b938a9a0..999392c95cbc 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "30dd46c371d8e335d32c414f972a800d811966b4" + "sha": "1827b0fbaf32b97302aa43ab28d04497d9990970" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 16b68b49dcdf..6af2f5c609b7 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -75111,147 +75111,3115 @@ "action": "transferred", "category": "issues" }, - "unassigned": { - "descriptionHtml": "

A user was unassigned from an issue.

", + "typed": { + "descriptionHtml": "

An issue type was added to an issue.

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", - "description": "

The action that was performed.

", + "description": "", "isRequired": true, "enum": [ - "unassigned" + "typed" ], "childParamsGroups": [] }, { - "type": "object or null", - "name": "assignee", + "type": "object", + "name": "enterprise", "in": "body", - "description": "", + "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.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "

The issue itself.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] }, { - "type": "string", - "name": "following_url", - "description": "" + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "string or null", + "name": "body", + "description": "

Contents of the issue

", + "isRequired": true }, { - "type": "string", - "name": "html_url", - "description": "" + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "id", + "name": "comments", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" + "name": "created_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "organizations_url", + "type": "boolean", + "name": "draft", "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { - "type": "string", + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of the issue; either 'open' or 'closed'

", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "

Title of the issue

", + "isRequired": true + }, + { + "type": "object or null", + "name": "type", + "description": "

The type of issue.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the issue

", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "

The type of issue.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "typed", + "category": "issues" + }, + "unassigned": { + "descriptionHtml": "

A user was unassigned from an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "

The action that was performed.

", + "isRequired": true, + "enum": [ + "unassigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", - "name": "type", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "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.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "

The issue itself.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "

Contents of the issue

", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of the issue; either 'open' or 'closed'

", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "

Title of the issue

", + "isRequired": true + }, + { + "type": "object or null", + "name": "type", + "description": "

The type of issue.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, + { + "type": "string", + "name": "updated_at", "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "" + "description": "

URL for the issue

", + "isRequired": true }, { - "type": "string", - "name": "user_view_type", - "description": "" + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unassigned", + "category": "issues" + }, + "unlabeled": { + "descriptionHtml": "

A label was removed from an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "enterprise", @@ -76657,6 +79625,56 @@ } ] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -76686,11 +79704,11 @@ "organization", "app" ], - "action": "unassigned", + "action": "unlabeled", "category": "issues" }, - "unlabeled": { - "descriptionHtml": "

A label was removed from an issue.

", + "unlocked": { + "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { @@ -76700,7 +79718,7 @@ "description": "", "isRequired": true, "enum": [ - "unlabeled" + "unlocked" ], "childParamsGroups": [] }, @@ -76847,8 +79865,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -76939,53 +79956,9 @@ "isRequired": true }, { - "type": "array of objects", + "type": "array of object,nulls", "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] + "description": "" }, { "type": "string", @@ -76996,7 +79969,11 @@ { "type": "boolean", "name": "locked", - "description": "" + "description": "", + "isRequired": true, + "enum": [ + false + ] }, { "type": "object or null", @@ -77132,8 +80109,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -77258,7 +80234,7 @@ { "type": "array of strings", "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" }, { "type": "string or null", @@ -77579,8 +80555,7 @@ "description": "", "enum": [ "read", - "write", - "admin" + "write" ] }, { @@ -78091,8 +81066,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -78109,56 +81083,6 @@ } ] }, - { - "type": "object", - "name": "label", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, { "type": "object", "name": "organization", @@ -78188,11 +81112,11 @@ "organization", "app" ], - "action": "unlabeled", + "action": "unlocked", "category": "issues" }, - "unlocked": { - "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", + "unpinned": { + "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { @@ -78202,7 +81126,7 @@ "description": "", "isRequired": true, "enum": [ - "unlocked" + "unpinned" ], "childParamsGroups": [] }, @@ -78440,9 +81364,53 @@ "isRequired": true }, { - "type": "array of object,nulls", + "type": "array of objects", "name": "labels", - "description": "" + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] }, { "type": "string", @@ -78453,11 +81421,7 @@ { "type": "boolean", "name": "locked", - "description": "", - "isRequired": true, - "enum": [ - false - ] + "description": "" }, { "type": "object or null", @@ -79596,11 +82560,11 @@ "organization", "app" ], - "action": "unlocked", + "action": "unpinned", "category": "issues" }, - "unpinned": { - "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", + "untyped": { + "descriptionHtml": "

An issue type was removed from an issue.

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { @@ -79610,7 +82574,7 @@ "description": "", "isRequired": true, "enum": [ - "unpinned" + "untyped" ], "childParamsGroups": [] }, @@ -79757,7 +82721,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -80041,7 +83006,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -80166,7 +83132,7 @@ { "type": "array of strings", "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" }, { "type": "string or null", @@ -80487,7 +83453,8 @@ "description": "", "enum": [ "read", - "write" + "write", + "admin" ] }, { @@ -80998,7 +83965,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -81015,6 +83983,70 @@ } ] }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "

The type of issue.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, { "type": "object", "name": "organization", @@ -81044,7 +84076,7 @@ "organization", "app" ], - "action": "unpinned", + "action": "untyped", "category": "issues" } }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index b3e6029fcac1..e807782de4a3 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -78772,147 +78772,3115 @@ "action": "transferred", "category": "issues" }, - "unassigned": { - "descriptionHtml": "

A user was unassigned from an issue.

", + "typed": { + "descriptionHtml": "

An issue type was added to an issue.

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", "name": "action", "in": "body", - "description": "

The action that was performed.

", + "description": "", "isRequired": true, "enum": [ - "unassigned" + "typed" ], "childParamsGroups": [] }, { - "type": "object or null", - "name": "assignee", + "type": "object", + "name": "enterprise", "in": "body", - "description": "", + "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.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "

The issue itself.

", + "isRequired": true, "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, { "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] }, { - "type": "string", - "name": "followers_url", - "description": "" + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] }, { - "type": "string", - "name": "following_url", - "description": "" + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true }, { "type": "string", - "name": "gists_url", - "description": "" + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, { - "type": "string", - "name": "gravatar_id", - "description": "" + "type": "string or null", + "name": "body", + "description": "

Contents of the issue

", + "isRequired": true }, { - "type": "string", - "name": "html_url", - "description": "" + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "id", + "name": "comments", "description": "", "isRequired": true }, { "type": "string", - "name": "login", + "name": "comments_url", "description": "", "isRequired": true }, { "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" + "name": "created_at", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "organizations_url", + "type": "boolean", + "name": "draft", "description": "" }, { "type": "string", - "name": "received_events_url", - "description": "" + "name": "events_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "integer", + "name": "id", + "description": "", + "isRequired": true }, { - "type": "string", + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of the issue; either 'open' or 'closed'

", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "

Title of the issue

", + "isRequired": true + }, + { + "type": "object or null", + "name": "type", + "description": "

The type of issue.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the issue

", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "

The type of issue.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "typed", + "category": "issues" + }, + "unassigned": { + "descriptionHtml": "

A user was unassigned from an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "

The action that was performed.

", + "isRequired": true, + "enum": [ + "unassigned" + ], + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "assignee", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", "name": "subscriptions_url", "description": "" }, { "type": "string", - "name": "type", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "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.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "issue", + "in": "body", + "description": "

The issue itself.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + { + "type": "object or null", + "name": "assignee", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "array of object,nulls", + "name": "assignees", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "

How the author is associated with the repository.

", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string or null", + "name": "body", + "description": "

Contents of the issue

", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "draft", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "" + }, + { + "type": "object or null", + "name": "milestone", + "description": "

A collection of related issues and pull requests.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "creator", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "

The number of the milestone.

", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "

The state of the milestone.

", + "isRequired": true, + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string", + "name": "title", + "description": "

The title of the milestone.

", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "performed_via_github_app", + "description": "

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "events", + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" + }, + { + "type": "string or null", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer or null", + "name": "id", + "description": "

Unique identifier of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the GitHub app

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions", + "description": "

The set of permissions for the GitHub app

", + "childParamsGroups": [ + { + "type": "string", + "name": "actions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "checks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "content_references", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "contents", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "deployments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "emails", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "environments", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "issues", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "keys", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "members", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_administration", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_plan", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_projects", + "description": "", + "enum": [ + "read", + "write", + "admin" + ] + }, + { + "type": "string", + "name": "organization_secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_self_hosted_runners", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_user_blocking", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "packages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pages", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "pull_requests", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_hooks", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "repository_projects", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secret_scanning_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "secrets", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_events", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "security_scanning_alert", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "single_file", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "statuses", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "team_discussions", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "vulnerability_alerts", + "description": "", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "workflows", + "description": "", + "enum": [ + "read", + "write" + ] + } + ] + }, + { + "type": "string", + "name": "slug", + "description": "

The slug name of the GitHub app

" + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "pull_request", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "diff_url", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "string or null", + "name": "merged_at", + "description": "" + }, + { + "type": "string", + "name": "patch_url", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "object", + "name": "reactions", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "sub_issues_summary", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "total", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "completed", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "percent_completed", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "state", + "description": "

State of the issue; either 'open' or 'closed'

", + "enum": [ + "open", + "closed" + ] + }, + { + "type": "string or null", + "name": "state_reason", + "description": "" + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "

Title of the issue

", + "isRequired": true + }, + { + "type": "object or null", + "name": "type", + "description": "

The type of issue.

", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, + { + "type": "string", + "name": "updated_at", "description": "", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] + "isRequired": true }, { "type": "string", "name": "url", - "description": "" + "description": "

URL for the issue

", + "isRequired": true }, { - "type": "string", - "name": "user_view_type", - "description": "" + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] } ] }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

A GitHub user.

", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "unassigned", + "category": "issues" + }, + "unlabeled": { + "descriptionHtml": "

A label was removed from an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "unlabeled" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "enterprise", @@ -80318,6 +83286,56 @@ } ] }, + { + "type": "object", + "name": "label", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] + }, { "type": "object", "name": "organization", @@ -80347,11 +83365,11 @@ "organization", "app" ], - "action": "unassigned", + "action": "unlabeled", "category": "issues" }, - "unlabeled": { - "descriptionHtml": "

A label was removed from an issue.

", + "unlocked": { + "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { @@ -80361,7 +83379,7 @@ "description": "", "isRequired": true, "enum": [ - "unlabeled" + "unlocked" ], "childParamsGroups": [] }, @@ -80508,8 +83526,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -80600,53 +83617,9 @@ "isRequired": true }, { - "type": "array of objects", + "type": "array of object,nulls", "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] + "description": "" }, { "type": "string", @@ -80657,7 +83630,11 @@ { "type": "boolean", "name": "locked", - "description": "" + "description": "", + "isRequired": true, + "enum": [ + false + ] }, { "type": "object or null", @@ -80793,8 +83770,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -80919,7 +83895,7 @@ { "type": "array of strings", "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" }, { "type": "string or null", @@ -81240,8 +84216,7 @@ "description": "", "enum": [ "read", - "write", - "admin" + "write" ] }, { @@ -81752,8 +84727,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, { @@ -81770,56 +84744,6 @@ } ] }, - { - "type": "object", - "name": "label", - "in": "body", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "color", - "description": "

6-character hex code, without the leading #, identifying the color

", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "

The name of the label.

", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "

URL for the label

", - "isRequired": true - } - ] - }, { "type": "object", "name": "organization", @@ -81849,11 +84773,11 @@ "organization", "app" ], - "action": "unlabeled", + "action": "unlocked", "category": "issues" }, - "unlocked": { - "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", + "unpinned": { + "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { @@ -81863,7 +84787,7 @@ "description": "", "isRequired": true, "enum": [ - "unlocked" + "unpinned" ], "childParamsGroups": [] }, @@ -82101,9 +85025,53 @@ "isRequired": true }, { - "type": "array of object,nulls", + "type": "array of objects", "name": "labels", - "description": "" + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "color", + "description": "

6-character hex code, without the leading #, identifying the color

", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the label.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

URL for the label

", + "isRequired": true + } + ] }, { "type": "string", @@ -82114,11 +85082,7 @@ { "type": "boolean", "name": "locked", - "description": "", - "isRequired": true, - "enum": [ - false - ] + "description": "" }, { "type": "object or null", @@ -83257,11 +86221,11 @@ "organization", "app" ], - "action": "unlocked", + "action": "unpinned", "category": "issues" }, - "unpinned": { - "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", + "untyped": { + "descriptionHtml": "

An issue type was removed from an issue.

", "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { @@ -83271,7 +86235,7 @@ "description": "", "isRequired": true, "enum": [ - "unpinned" + "untyped" ], "childParamsGroups": [] }, @@ -83418,7 +86382,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -83702,7 +86667,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -83827,7 +86793,7 @@ { "type": "array of strings", "name": "events", - "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run

" + "description": "

The list of events for the GitHub app\nSupported values are: branch_protection_rule, check_run, check_suite, code_scanning_alert, commit_comment, content_reference, create, delete, deployment, deployment_review, deployment_status, deploy_key, discussion, discussion_comment, fork, gollum, issues, issue_comment, label, member, membership, milestone, organization, org_block, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, push, registry_package, release, repository, repository_dispatch, secret_scanning_alert, star, status, team, team_add, watch, workflow_dispatch, workflow_run, reminder, pull_request_review_thread

" }, { "type": "string or null", @@ -84148,7 +87114,8 @@ "description": "", "enum": [ "read", - "write" + "write", + "admin" ] }, { @@ -84659,7 +87626,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, { @@ -84676,6 +87644,70 @@ } ] }, + { + "type": "object or null", + "name": "type", + "in": "body", + "description": "

The type of issue.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The unique identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "

The node identifier of the issue type.

", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "

The name of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "

The description of the issue type.

", + "isRequired": true + }, + { + "type": "string or null", + "name": "color", + "description": "

The color of the issue type.

", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + { + "type": "string", + "name": "created_at", + "description": "

The time the issue type created.

" + }, + { + "type": "string", + "name": "updated_at", + "description": "

The time the issue type last updated.

" + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "

The enabled state of the issue type.

" + } + ] + }, { "type": "object", "name": "organization", @@ -84705,7 +87737,7 @@ "organization", "app" ], - "action": "unpinned", + "action": "untyped", "category": "issues" } }, diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 06f6a5b3ecd9..bba2187b4010 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "30dd46c371d8e335d32c414f972a800d811966b4" + "sha": "1827b0fbaf32b97302aa43ab28d04497d9990970" } \ No newline at end of file